fpdf_annot_w.h

Go to the documentation of this file.

#ifndef _FSPDF_ANNOT_W_H_
#define _FSPDF_ANNOT_W_H_

#ifdef __cplusplus
extern "C" {
#endif

/*******************************************************************************/
/* Add and remove annotation                                                   */
/*******************************************************************************/
FS_RESULT       FSPDF_Annot_Add(FSCRT_PAGE page, const FSCRT_RECTF* rect, const FSCRT_BSTR* annotType, const FSCRT_BSTR* filter, 
                                                        FS_INT32 index, FSCRT_ANNOT* annot);

FS_RESULT       FSPDF_Annot_Remove(FSCRT_ANNOT annot);

/*******************************************************************************/
/* Annotation common properties                                                */
/*******************************************************************************/
FS_RESULT       FSPDF_Annot_Move(FSCRT_ANNOT annot, const FSCRT_RECTF* newRect);

FS_RESULT       FSPDF_Annot_SetFlags(FSCRT_ANNOT annot, FS_DWORD flags);

FS_RESULT       FSPDF_Annot_SetName(FSCRT_ANNOT annot, const FSCRT_BSTR* name);

FS_RESULT       FSPDF_Annot_SetSubject(FSCRT_ANNOT annot, const FSCRT_BSTR* subject);

FS_RESULT       FSPDF_Annot_SetTitle(FSCRT_ANNOT annot, const FSCRT_BSTR* title);

FS_RESULT       FSPDF_Annot_SetContents(FSCRT_ANNOT annot, const FSCRT_BSTR* contents);

FS_RESULT       FSPDF_Annot_SetIconName(FSCRT_ANNOT annot, const FSCRT_BSTR* iconName);

FS_RESULT       FSPDF_Annot_SetBorder(FSCRT_ANNOT annot, const FSPDF_ANNOTBORDER* border);

FS_RESULT       FSPDF_Annot_SetColor(FSCRT_ANNOT annot, FS_BOOL isFillColor, FS_ARGB color);

FS_RESULT       FSPDF_Annot_SetApplyFillColor(FSCRT_ANNOT annot, FS_ARGB color);

FS_RESULT       FSPDF_Annot_SetOpacity(FSCRT_ANNOT annot, FS_FLOAT opacity);

FS_RESULT       FSPDF_Annot_SetAlignment(FSCRT_ANNOT annot, FS_INT32 alignment);

FS_RESULT       FSPDF_Annot_SetCreationDateTime(FSCRT_ANNOT annot, const FSCRT_DATETIMEZONE* dt);

FS_RESULT       FSPDF_Annot_SetModifiedDateTime(FSCRT_ANNOT annot, const FSCRT_DATETIMEZONE* dt);

FS_RESULT       FSPDF_Annot_SetIntent(FSCRT_ANNOT annot, const FSCRT_BSTR* intent);

FS_RESULT       FSPDF_Annot_SetPopup(FSCRT_ANNOT annot, FSCRT_ANNOT popupAnnot);

FS_RESULT       FSPDF_Annot_SetOpenStatus(FSCRT_ANNOT annot, FS_BOOL status);

FS_RESULT       FSPDF_Annot_SetHighlightingMode(FSCRT_ANNOT annot, FS_INT32 hlMode);

FS_RESULT       FSPDF_Annot_SetQuadPoints(FSCRT_ANNOT annot, FSCRT_QUADPOINTSF* quadPoints, FS_INT32 count);

FS_RESULT       FSPDF_Annot_SetCalloutLinePoints(FSCRT_ANNOT annot, FS_FLOAT x1, FS_FLOAT y1, FS_FLOAT x2, FS_FLOAT y2, FS_FLOAT x3, FS_FLOAT y3);

FS_RESULT       FSPDF_Annot_SetInnerRectMargin(FSCRT_ANNOT annot, FS_FLOAT left, FS_FLOAT top, FS_FLOAT right, FS_FLOAT bottom);

FS_RESULT       FSPDF_Annot_SetLineEndingStyles(FSCRT_ANNOT annot, const FSCRT_BSTR* startingStyle, const FSCRT_BSTR* endingStyle);

FS_RESULT       FSPDF_Annot_SetLinePosition(FSCRT_ANNOT annot, FS_FLOAT x1, FS_FLOAT y1, FS_FLOAT x2, FS_FLOAT y2);

FS_RESULT       FSPDF_Annot_SetLeaderLineLength(FSCRT_ANNOT annot, FS_FLOAT length);

FS_RESULT       FSPDF_Annot_SetLeaderLineExtension(FSCRT_ANNOT annot, FS_FLOAT extLength);

FS_RESULT       FSPDF_Annot_SetLeaderLineOffset(FSCRT_ANNOT annot, FS_FLOAT offset);

FS_RESULT       FSPDF_Annot_SetCaptionContents(FSCRT_ANNOT annot, FS_BOOL hasCap);

FS_RESULT       FSPDF_Annot_SetCaptionPosition(FSCRT_ANNOT annot, const FSCRT_BSTR* captionPos);

FS_RESULT       FSPDF_Annot_SetCaptionOffset(FSCRT_ANNOT annot, FS_FLOAT offsetx, FS_FLOAT offsety);

FS_RESULT       FSPDF_Annot_SetVertices(FSCRT_ANNOT annot, FS_FLOAT* vertices, FS_INT32 count);

FS_RESULT       FSPDF_Annot_SetSymbol(FSCRT_ANNOT annot, const FSCRT_BSTR* symbol);

FS_RESULT       FSPDF_Annot_SetInkList(FSCRT_ANNOT annot, FSCRT_PATHDATA pathData);

FS_RESULT       FSPDF_Annot_SetAttachment(FSCRT_ANNOT annot, FSPDF_ATTACHMENT attachment);

FS_RESULT       FSPDF_Annot_SetDefaultAppearance(FSCRT_ANNOT annot, const FSPDF_DEFAULTAPPEARANCE* defAppearance);

FS_RESULT       FSPDF_Annot_SetIconFit(FSCRT_ANNOT annot, const FSPDF_ANNOTICONFIT* iconFit);

FS_RESULT       FSPDF_Annot_RemoveMKEntry(FSCRT_ANNOT annot, FS_INT32 mkEntry);

FS_RESULT       FSPDF_Annot_SetMKRotation(FSCRT_ANNOT annot, FS_INT32 degree);

FS_RESULT       FSPDF_Annot_SetMKColor(FSCRT_ANNOT annot, FS_INT32 mkEntry, FS_ARGB color);

FS_RESULT       FSPDF_Annot_SetMKCaption(FSCRT_ANNOT annot, FS_INT32 mkEntry, const FSCRT_BSTR* caption);

FS_RESULT       FSPDF_Annot_SetMKIconBitmap(FSCRT_ANNOT annot, FS_INT32 mkEntry, FSCRT_BITMAP bitmap);

FS_RESULT       FSPDF_Annot_SetMKIconImage(FSCRT_ANNOT annot, FS_INT32 mkEntry, FSCRT_IMAGE image);

#ifndef _FSPDF_DEF_ICONPROVIDER_
#define _FSPDF_DEF_ICONPROVIDER_

typedef struct _FSPDF_ICONPROVIDER
{
        FS_DWORD        lStructSize;

        FS_LPVOID       clientData;

        FS_RESULT                       (*Release)(FS_LPVOID clientData);

        FS_RESULT                       (*GetProviderID)(FS_LPVOID clientData, FSCRT_BSTR* str, FS_DWORD* ver);
        
        FS_RESULT                       (*HasIcon)(FS_LPVOID clientData, const FSCRT_BSTR* iconType, const FSCRT_BSTR* iconID, FS_BOOL* hasIcon);
        
        FS_RESULT                       (*CanChangeColor)(FS_LPVOID clientData, const FSCRT_BSTR* iconType, const FSCRT_BSTR* iconID, FS_BOOL* canChange);
        
        FS_RESULT                       (*GetIcon)(FS_LPVOID clientData, const FSCRT_BSTR* iconType, const FSCRT_BSTR* iconID, FS_ARGB color, FSCRT_PAGE* page);

        FS_RESULT                       (*SetShadingColor)(FS_LPVOID clientData, const FSCRT_BSTR* iconType, const FSCRT_BSTR* iconID, FS_ARGB refColor, 
                                                                           FS_INT32 shadingIndex, FS_ARGB* c1, FS_ARGB* c2);

        FS_RESULT                       (*GetDisplaySize)(FS_LPVOID clientData, const FSCRT_BSTR* iconType, const FSCRT_BSTR* iconID, FS_FLOAT* width, FS_FLOAT* height);

}FSPDF_ICONPROVIDER;
#endif //_FSPDF_DEF_ICONPROVIDER_

FS_RESULT       FSPDF_Annot_SetIconProvider(FSPDF_ICONPROVIDER* iconProvider);

FS_RESULT FSPDF_Annot_SetStamp(FSCRT_ANNOT annot, FSCRT_IMAGE image, FS_INT32 compress);

FS_RESULT FSPDF_Annot_SetStampWithBitmap(FSCRT_ANNOT annot, FSCRT_BITMAP bitmap);

/*******************************************************************************/
/* Markup controls                                                             */
/*******************************************************************************/
FS_RESULT       FSPDF_Annot_AddState(FSCRT_ANNOT annot, FS_INT32 stateModel, FS_INT32 state, FSCRT_ANNOT* stateAnnot);

FS_RESULT       FSPDF_Annot_SetState(FSCRT_ANNOT stateAnnot, FS_INT32 stateModel, FS_INT32 state);

FS_RESULT       FSPDF_Annot_RemoveAllStates(FSCRT_ANNOT annot);

FS_RESULT       FSPDF_Annot_SetGroup(FSCRT_ANNOT* annots, FS_INT32 count, FS_INT32 headerIndex);

FS_RESULT       FSPDF_Annot_Ungroup(FSCRT_ANNOT annot);

FS_RESULT       FSPDF_Annot_InsertReply(FSCRT_ANNOT annot, FS_INT32 index, FSCRT_ANNOT* replyAnnot);

FS_RESULT       FSPDF_Annot_RemoveReply(FSCRT_ANNOT annot, FS_INT32 index);

FS_RESULT       FSPDF_Annot_RemoveAllReplies(FSCRT_ANNOT annot);

/*******************************************************************************/
/* Annotation trigger actions                                                  */
/*******************************************************************************/
FS_RESULT       FSPDF_Annot_SetAction(FSCRT_ANNOT annot, FS_INT32 trigger, FS_INT32 index, const FSPDF_ACTIONDATA* actionData);

FS_RESULT       FSPDF_Annot_InsertAction(FSCRT_ANNOT annot, FS_INT32 trigger, FS_INT32 index, const FSPDF_ACTIONDATA* actionData);

FS_RESULT       FSPDF_Annot_RemoveAction(FSCRT_ANNOT annot, FS_INT32 trigger, FS_INT32 index);

FS_RESULT       FSPDF_Annot_RemoveAllActions(FSCRT_ANNOT annot, FS_INT32 trigger);

/*******************************************************************************/
/* Reset annotation                                                          */
/*******************************************************************************/
FS_RESULT       FSPDF_Annot_ResetAppearance(FSCRT_ANNOT annot);
    
FS_RESULT       FSPDF_Archive_SerializeAnnot(FSCRT_ARCHIVE archive, FSCRT_PAGE page,  FSCRT_ANNOT annot);

FS_RESULT       FSPDF_Archive_DeserializeAnnot(FSCRT_ARCHIVE archive, FSCRT_PAGE page, FSCRT_ANNOT* annot);

/*******************************************************************************/
/* Annotation's move operation in annotation list                              */
/*******************************************************************************/
FS_RESULT       FSPDF_Annot_MoveToFirst(FSCRT_ANNOT annot);

FS_RESULT       FSPDF_Annot_MoveToLast(FSCRT_ANNOT annot);

FS_RESULT       FSPDF_Annot_MoveToPrev(FSCRT_ANNOT annot);

FS_RESULT       FSPDF_Annot_MoveToNext(FSCRT_ANNOT annot);

/*******************************************************************************/
/* Redaction                                                                   */
/*******************************************************************************/
FS_RESULT       FSPDF_Redaction_Mark(FSCRT_DOCUMENT document, FSCRT_PAGE page, FSCRT_RECTF* rects, FS_INT32 nRect, FSCRT_ANNOT* redactAnnot);

FS_RESULT       FSPDF_Redaction_Apply(FSCRT_DOCUMENT document);

#ifdef __cplusplus
};
#endif
 /* group FPDFANNOT */

#endif /* _FSPDF_ANNOT_W_H_ */