Go to the documentation of this file.
15 #ifndef FS_ANNOTATIONSUMMARY_H_
16 #define FS_ANNOTATIONSUMMARY_H_
44 typedef enum _AnnotationSummaryStringID {
151 typedef enum _SummaryLayout {
169 typedef enum _SortType {
185 typedef enum _FontSizeType {
593 #endif // FS_ANNOTATIONSUMMARY_H_
Annotations summary string ID: specify the prefix when page information is outputed in result documen...
Definition: fs_annotationsummary.h:59
Annotations summary string ID: specify the prefix when annotation type is outputed in result document...
Definition: fs_annotationsummary.h:64
File writing interface.
Definition: fx_stream.h:453
Annotations summary string ID: specify the string used as content in result document when a page does...
Definition: fs_annotationsummary.h:75
common::Progressive StartSummarize(const char *dest_file_path, const AnnotationSummarySettings &settings, common::PauseCallback *pause=0)
Start to summarize annotation.
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
Annotations summary string ID: specify the prefix when date information is outputed in result documen...
Definition: fs_annotationsummary.h:54
Annotations summary string ID: specify the document title in result document. Default title is "Summa...
Definition: fs_annotationsummary.h:66
AnnotationSummary & operator=(const AnnotationSummary &other)
Assign operator.
AnnotationSummarySettings & operator=(const AnnotationSummarySettings &other)
Assign operator.
void SetStartPage(int page_index)
Set starting page index.
AnnotationSummary(const pdf::PDFDoc &document)
Constructor.
SummaryLayout
Enumeration for options used for annotation summary layout.
Definition: fs_annotationsummary.h:151
~AnnotationSummarySettings()
Destructor.
Definition: fs_common.h:346
void SetSummaryLayout(SummaryLayout type)
Set summary layout type.
virtual void Release()=0
A callback function used to release current callback object itself.
void SetSortType(SortType type)
Set the option to decide to sort annotation by what.
AnnotationSummarySettings()
Constructor, with parameters.
Header file for common definitions and classes.
void SetAnnotThumbnail(annots::Annot::Type type, const common::Bitmap &thumbnail)
Set the markup annotation thumbnail used in result document to indicates the type of annotation.
If set, that means to sort annotation by page in result document.
Definition: fs_annotationsummary.h:175
void SetFileTitle(const wchar_t *title)
Set the file title string when location of the document needs to be outputed in result document.
void SetFontSize(FontSizeType type)
Set the font size type used in result document of annotation summary.
If set, that means to layout document and annotations with connector lines on separate pages.
Definition: fs_annotationsummary.h:153
bool IsEmpty() const
Check whether current object is empty or not.
~AnnotationSummary()
Destructor.
If set, that means to layout document and annotations with connector lines on single pages.
Definition: fs_annotationsummary.h:155
Definition: fs_annotationsummary.h:37
If set, that means to layout document and annotations with sequence numbers on separate pages.
Definition: fs_annotationsummary.h:161
If set, that means to use large font size in result document.
Definition: fs_annotationsummary.h:191
FontSizeType
Enumeration for options used for font size type in result document.
Definition: fs_annotationsummary.h:185
If set, that means to layout document and annotations with sequence numbers on separate pages.
Definition: fs_annotationsummary.h:159
SortType
Enumeration for options used for sorting annotation in result document.
Definition: fs_annotationsummary.h:169
If set, that means to use small font size in result document.
Definition: fs_annotationsummary.h:187
Definition: fs_annotationsummary.h:454
If set, that means to sort annotation by author in result document.
Definition: fs_annotationsummary.h:171
void SetConnectorLineOpacity(float opacity)
Set connector line opacity.
Foxit namespace.
Definition: fs_taggedpdf.h:27
bool operator!=(const AnnotationSummary &other) const
Not equal operator.
If set, that means to layout annotations only.
Definition: fs_annotationsummary.h:157
void SetAnnotType(annots::Annot::Type type, bool use_all)
Set the option to decide which type of annotations will be summarized.
Definition: fx_basic.h:3761
Definition: fs_annotationsummary.h:144
Annotations summary string ID: specify the prefix when author information is outputed in result docum...
Definition: fs_annotationsummary.h:49
Header file for PDF document related definitions and classes.
virtual WString GetLocalFontName()=0
A callback function used to specify the font name used locally.
AnnotationSummaryStringID
Enumeration for string ID used to specify the string or prefix in result document when summarizing an...
Definition: fs_annotationsummary.h:44
#define NULL
The null-pointer value.
Definition: fx_system.h:780
Definition: fx_coordinates.h:771
virtual WString LoadString(AnnotationSummaryStringID id)=0
A callback function used to load a string in local language for a specified case.
If set, that means to sort annotation by annotation type in result document.
Definition: fs_annotationsummary.h:177
uint32 RGB
RGB color type, 24 bits, ((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:212
Definition: fs_pdfdoc.h:610
void SetPageRect(const RectF &rect)
Set the page rectangle in result document.
Annotations summary string ID: specify the prefix when page title is outputed in result document....
Definition: fs_annotationsummary.h:70
void SetEndPage(int page_index)
Set ending page index.
bool IsEmpty() const
Check whether current object is empty or not.
Type
Enumeration for PDF annotation type.
Definition: fs_annot.h:1003
bool operator==(const AnnotationSummarySettings &other) const
Equal operator.
bool operator!=(const AnnotationSummarySettings &other) const
Not equal operator.
void SetCallback(AnnotationSummaryCallback *callback)
Set a callback object for annotation summary.
WIDE STRING CLASS.
Definition: fx_string.h:1452
If set, that means to sort annotation by date in result document.
Definition: fs_annotationsummary.h:173
void EnableOutputNoAnnotationPage(bool enable)
Set the flag to decide whether to output information of pages which have no annotation.
Definition: fs_image.h:36
void SetConnectorLineColor(RGB color)
Set connector line color.
LocaleID
Enumeration for locale ID.
Definition: fs_common.h:211
bool operator==(const AnnotationSummary &other) const
Equal operator.
Annotations summary string ID: specify the prefix when subject information is outputed in result docu...
Definition: fs_annotationsummary.h:85
void SetPageMargin(const RectF &margin)
Set the page margin used in result document.
If set, that means to use medium font size in result document.
Definition: fs_annotationsummary.h:189
Definition: fs_basictypes.h:427
virtual common::LocaleID GetCurrentLocaleID()=0
A callback function used to specify current locale ID.
Annotations summary string ID: specify the prefix when number information is outputed in result docum...
Definition: fs_annotationsummary.h:80
@2024 Foxit Software Incorporated. All rights reserved.