28 class DocEventCallback;
40 class AppProviderCallback;
48 #if defined(_SWIG_ANDROID_) || defined(_SWIG_JAVA_) 57 typedef enum _Rotation {
75 typedef enum _Alignment {
89 typedef enum _FillMode {
109 typedef enum _Position {
132 #if defined(__ANDROID__) || defined(_JAVA_) 141 typedef enum _Rotation {
159 typedef enum _Alignment {
173 typedef enum _FillMode {
193 typedef enum _Position {
221 typedef enum _Rotation {
239 typedef enum _Alignment {
253 typedef enum _FillMode {
273 typedef enum _Position {
296 #define CommonDefines foxit::common 392 typedef enum _State {
716 static void*
Alloc(
size_t size);
725 static void Free(
void* ptr);
738 static void*
Realloc(
void* ptr,
size_t new_size);
750 static void SetLogFile(
const char* log_file_path);
762 static void SetLogFile(
const wchar_t* log_file_path);
777 typedef enum _LineCapStyle {
801 typedef enum _LineJoinStyle {
1040 typedef enum _Filter {
1057 explicit Range(
int index);
1195 typedef enum _Styles {
1221 typedef enum _Charset {
1259 typedef enum _StandardID {
1321 Font(
const char* font_file_path,
int face_index,
Charset charset);
1332 Font(
const wchar_t* font_file_path,
int face_index,
Charset charset);
1474 typedef enum _PointType {
1687 #endif // FS_COMMON_H_ Definition: fs_annot.h:1421
Font style: non-symbolic.
Definition: fs_common.h:1205
Indicates that a line is drawn from the previous point to this point, and this point will also be con...
Definition: fs_common.h:1484
Miter line join type.
Definition: fs_common.h:806
Styles
Enumeration for font styles.
Definition: fs_common.h:1195
LineCapStyle line_cap
Line cap style.
Definition: fs_common.h:944
Standard font: Helvetica-Bold.
Definition: fs_common.h:1271
Font charset: Korean (Wansung).
Definition: fs_common.h:1231
Bevel line join type.
Definition: fs_common.h:818
FloatArray dashes
A dash array that represents the dash patterns. Value of each element in this array should not be neg...
Definition: fs_common.h:952
Position: center.
Definition: fs_common.h:283
Font charset: Japanese (Shift-JIS).
Definition: fs_common.h:1229
Definition: fs_common.h:1033
bool AppendEllipse(const RectF &rect)
Add an ellipse figure to the end of current path.
Standard font: Times-Bold.
Definition: fs_common.h:1279
static void SetRenderTextGamma(float gamma)
Set gamma value for text rendering.
Alternate fill mode, in which the system fills this area between odd-numbered and even-numbered polyg...
Definition: fs_common.h:260
static void Release()
Release all resource allocated by Foxit PDF SDK Library.
int GetRateOfProgress()
Get the rate of current progress.
Position: bottom right.
Definition: fs_common.h:291
Definition: fs_common.h:303
Position
Enumeration for watermark position in a PDF page.
Definition: fs_common.h:273
Projecting square cap. The stroke continues beyond the endpoint of the path for a distance equal to h...
Definition: fs_common.h:792
PointType GetPointType(int index)
Get the type of a point specified by index.
CFX_Object Object
Object type.
Definition: fs_basictypes.h:219
IFX_Pause PauseCallback
Definition: fs_common.h:960
Definition: fs_common.h:451
Round line join type.
Definition: fs_common.h:812
bool operator!=(const Font &other) const
Not equal operator.
Standard font: Times-BoldItalic.
Definition: fs_common.h:1281
GraphState(float line_width, LineJoinStyle line_join, float miter_limit, LineCapStyle line_cap, float dash_phase, const FloatArray &dashes)
Constructor, with parameters.
Definition: fs_common.h:835
Unknown rotation.
Definition: fs_common.h:231
bool IsBold() const
Judge whether current font is bold or not.
bool operator!=(const Path &other) const
Not equal operator.
static String Base64Encode(const void *data_buffer, size_t length)
Encode the source data buffer by Base64 algorithm.
Only odd numbers in a range will be used (discards even numbers).
Definition: fs_common.h:1046
void Set(float line_width, LineJoinStyle line_join, float miter_limit, LineCapStyle line_cap, float dash_phase, const FloatArray &dashes)
Set value.
Definition: fs_common.h:902
Range & operator=(const Range &other)
Assign operator.
PointF GetPoint(int index)
Get a point specified by index.
bool CloseFigure()
Close current figure (which is also the last figure in current path).
Round cap. A semicircular arc with a diameter equal to the line width is drawn around the endpoint an...
Definition: fs_common.h:787
Definition: fx_coordinates.h:30
static bool RegisterSignatureCallback(const char *filter, const char *sub_filter, pdf::SignatureCallback *signature_callback)
Register a third-party pdf::SignatureCallback object to Foxit PDF SDK for signing and verifying signa...
Rotate 180 degrees in clockwise direction.
Definition: fs_common.h:227
bool IsSupportEmbedded(const pdf::PDFDoc &document)
Check whether current font is supported to be embedded to the specified PDF document or not...
bool MoveTo(const PointF &point)
Add a point to the end of current path, to start a new figure.
Font style: all cap.
Definition: fs_common.h:1209
Filter
Enumeration for range filter.
Definition: fs_common.h:1040
int GetSegmentCount() const
Get the count of range segments.
bool operator==(const Range &other) const
Equal operator.
void Clear()
Clear all points.
WIDE STRING CLASS.
Definition: fx_string.h:1470
GraphState(const GraphState &state)
Constructor, with another graph state object.
Definition: fs_common.h:861
State
Enumeration for progress state.
Definition: fs_common.h:392
static void RegisterXFAAppProviderCallback(addon::xfa::AppProviderCallback *callback)
Register an addon::xfa::AppProviderCallback object to Foxit PDF SDK.
Standard font: Helvetica.
Definition: fs_common.h:1269
Position: top right.
Definition: fs_common.h:279
Definition: fs_common.h:967
Indicates that the point is the first point of a figure.
Definition: fs_common.h:1476
LineCapStyle
Enumeration for line cap style.
Definition: fs_common.h:777
Font style: script.
Definition: fs_common.h:1203
static ErrorCode Reinitialize()
Reinitialize Foxit PDF SDK Library.
static bool RegisterSecurityCallback(const char *filter, pdf::SecurityCallback *callback)
Register a pdf::SecurityCallback object to Foxit PDF SDK for decryption of the PDFs with special encr...
Definition: fs_pdfdoc.h:338
static bool SetCacheSize(uint32 size)
Set the upper limit of PDF library cache size.
bool IsEmpty() const
Check whether current object is empty or not.
static ErrorCode Initialize(const char *sn, const char *key)
Initialize Foxit PDF SDK Library, with valid license information.
Font style: italic.
Definition: fs_common.h:1207
Progressive(const Progressive &other)
Constructor, with another progressive object.
static bool SetAnnotIconProviderCallback(pdf::annots::IconProviderCallback *annot_icon_provider)
Set a customized pdf::annots::IconProviderCallback object to Foxit PDF SDK.
Progress state: progress needs to be continued.
Definition: fs_common.h:396
GraphState()
Constructor.
Definition: fs_common.h:846
Position: bottom center.
Definition: fs_common.h:289
bool IsEmbedded(const pdf::PDFDoc &document)
Judge whether current font is embedded in a specified PDF document or not.
int GetSegmentEnd(int segment_index) const
Get the end index of a specified range segment.
Definition: fs_signature.h:782
void Transform(const Matrix &matrix)
Transform all points in current path with a given matrix.
~Progressive()
Destructor.
Font style: serif.
Definition: fs_common.h:1199
Indicates that a line is drawn from the previous point to this point.
Definition: fs_common.h:1478
Header file for basic types definitions.
LineJoinStyle line_join
Line join style.
Definition: fs_common.h:926
Position center left.
Definition: fs_common.h:281
Definition: fs_actioncallback.h:142
static void SetLogFile(const char *log_file_path)
Set the log file path.
ErrorCode
Enumeration for error code.
Definition: fs_basictypes.h:236
Only even numbers in a range will be used (discards odd numbers).
Definition: fs_common.h:1044
virtual void OnDocSaved(const pdf::PDFDoc &document, ErrorCode error_code)
Triggered when a PDF document is saved.
Definition: fs_common.h:1023
Font charset: Traditional Chinese.
Definition: fs_common.h:1235
Font(const wchar_t *name, uint32 styles, Charset charset, int weight=0)
Constructor, with given attribute.
Font charset: ANSI (United States, Western Europe).
Definition: fs_common.h:1223
static String FlateDecompress(const void *compressed_data_buffer, size_t length)
Decompress the compressed data buffer by DEFLATE algorithm.
Butt cap. The stroke is squared off at the endpoint of a path. There is no projection beyond the end ...
Definition: fs_common.h:782
Position: center right.
Definition: fs_common.h:285
virtual void Release()=0
A callback function used to release current callback object itself.
int GetSegmentStart(int segment_index) const
Get the start index of a specified range segment.
Font charset: Standard symbols.
Definition: fs_common.h:1227
Font style: force bold.
Definition: fs_common.h:1213
FillMode
Enumeration for filling mode type, mainly for path graphics object.
Definition: fs_common.h:253
static void * Realloc(void *ptr, size_t new_size)
Reallocate a memory block.
Font style: symbolic.
Definition: fs_common.h:1201
bool IsEmpty() const
Check whether current object is empty or not.
Definition: fx_basic.h:3690
Definition: fs_common.h:769
int GetDescent() const
Get the descent value, in 1/1000 of em size (PDF units).
bool CubicBezierTo(const PointF &point1, const PointF &point2, const PointF &point3)
Add a cubic bezier spline to the end of current figure, by three points: two control points and one t...
Standard font: Courier-BoldOblique, Bold italic.
Definition: fs_common.h:1265
Definition: fs_common.h:1467
bool operator==(const Path &other) const
Equal operator.
Font charset: Arabic.
Definition: fs_common.h:1249
LineJoinStyle
Enumeration for line join style.
Definition: fs_common.h:801
static String FlateCompress(const void *data_buffer, size_t length)
Compress the source data buffer by DEFLATE algorithm.
Font charset: System default, for unknown or mapping purpose.
Definition: fs_common.h:1225
Definition: fs_common.h:385
float line_width
Line width.
Definition: fs_common.h:918
Winding fill mode, in which the system uses a direction in which a figure is drawn to determine wheth...
Definition: fs_common.h:265
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:198
virtual void OnDocOpened(const pdf::PDFDoc &document, ErrorCode error_code)
Triggered when a PDF document is opened.
Definition: fs_common.h:993
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:216
virtual void OnDocWillOpen()
Triggered when the document will be opened.
Definition: fs_common.h:981
static bool SetDocEventCallback(DocEventCallback *callback)
Set a DocEventCallback object to Foxit PDF SDK.
Font charset: Russian.
Definition: fs_common.h:1241
bool SetPoint(int index, const PointF &point, PointType type)
Change the value and type of a point specified by index.
static String Base64Decode(const void *encoded_data_buffer, size_t length)
Decode the encoded data buffer by Base64 algorithm.
bool LineTo(const PointF &point)
Add a point to the end of current figure, and a line is to be drawn from current point to the new poi...
Progressive & operator=(const Progressive &other)
Assign operator.
bool operator!=(const Range &other) const
Not equal operator.
static bool UnregisterSecurityCallback(const char *filter)
Unregister a pdf::SecurityCallback object from Foxit PDF SDK.
Definition: fx_coordinates.h:594
Alignment
Enumeration for alignment (horizontal).
Definition: fs_common.h:239
virtual void OnDocWillSave(const pdf::PDFDoc &document)
Triggered when a PDF document will be saved.
Definition: fs_common.h:1011
static bool SetActionCallback(ActionCallback *action_callback)
Set a foxit::ActionCallback object to Foxit PDF SDK, in aid of performing PDF actions.
static bool EnableJavaScript(bool enable_javascript)
Enable or disable javascript for PDF.
State Continue()
Continue the progressive process.
Definition: fs_basictypes.h:342
bool operator==(const Font &other) const
Equal operator.
Standard font: ZapfDingbats.
Definition: fs_common.h:1287
Standard font: Helvetica-Oblique, Italic.
Definition: fs_common.h:1275
Definition: fs_security.h:1190
void RemoveAll()
Remove all range segments.
int GetPointCount()
Get the count of points.
static String GetVersion()
Get the version of current Foxit PDF SDK library.
Indicates that this point is the ending point for a Bezier spline, and this point will also be connec...
Definition: fs_common.h:1492
Standard font: Times-Roman.
Definition: fs_common.h:1277
Font Embed(pdf::PDFDoc document)
Embed current font to the specified PDF document.
WString GetName()
Retrieve the face name.
Standard font: Symbol.
Definition: fs_common.h:1285
Rotate 270 degrees in clockwise direction.
Definition: fs_common.h:229
Position: bottom left.
Definition: fs_common.h:287
Font style: fixed pitch.
Definition: fs_common.h:1197
Font charset: Simplified Chinese.
Definition: fs_common.h:1233
Standard font: Times-Italic.
Definition: fs_common.h:1283
Definition: fs_common.h:1188
Fill mode: none.
Definition: fs_common.h:255
Center alignment.
Definition: fs_common.h:243
No rotation.
Definition: fs_common.h:223
Rotation
Enumeration for rotation.
Definition: fs_common.h:221
Foxit namespace.
Definition: fs_connectedpdf.h:26
Left alignment.
Definition: fs_common.h:241
Definition: fs_common.h:354
void AddSingle(int index)
Add an index as a new range segment.
float dash_phase
Dash phase for dash pattern.
Definition: fs_common.h:947
StandardID
Enumeration for standard font ID.
Definition: fs_common.h:1259
All the indexes within a range will be used.
Definition: fs_common.h:1042
BYTE STRING CLASS.
Definition: fx_string.h:317
Progress state: progress is finished.
Definition: fs_common.h:398
Font charset: Hebrew.
Definition: fs_common.h:1247
Charset
Enumeration for font charset.
Definition: fs_common.h:1221
static void Free(void *ptr)
Free a memory block.
Font style: small cap.
Definition: fs_common.h:1211
Font charset: Greek.
Definition: fs_common.h:1243
Rotate 90 degrees in clockwise direction.
Definition: fs_common.h:225
virtual void Release()=0
A callback function used to release current callback object itself.
float GetCharWidth(uint32 unicode) const
Get the width (in 1/1000 of em size (PDF units)) of a character specified by unicode.
Standard font: Helvetica-BoldOblique, Bold italic.
Definition: fs_common.h:1273
static void * Alloc(size_t size)
Allocate a memory block.
bool IsEmpty() const
Check whether current object is empty or not.
Font charset: Baltic.
Definition: fs_common.h:1251
Standard font: Courier.
Definition: fs_common.h:1261
GraphState & operator=(const GraphState &state)
Assign operator.
Definition: fs_common.h:877
Font charset: Turkish.
Definition: fs_common.h:1245
Progress state: any error occurs.
Definition: fs_common.h:394
#define NULL
The null-pointer value.
Definition: fx_system.h:773
virtual void OnDocWillDestroy(const pdf::PDFDoc &document)
Triggered when a PDF document will be destroyed.
Definition: fs_common.h:1002
Definition: fx_coordinates.h:1053
Font charset: Eastern European.
Definition: fs_common.h:1239
Path & operator=(const Path &other)
Assign operator.
RectI GetCharBBox(uint32 unicode) const
Get the bounding box of a character specified by unicode.
Right alignment.
Definition: fs_common.h:245
int GetAscent() const
Get the ascent value, in 1/1000 of em size (PDF units).
Indicates that this point is a control point or ending point for a Bezier spline. ...
Definition: fs_common.h:1486
bool RemovePoint(int index)
Remove a point specified by index.
Position: top left.
Definition: fs_common.h:275
Font & operator=(const Font &other)
Assign operator.
Position: top center.
Definition: fs_common.h:277
bool IsItalic() const
Judge whether current font object is italic or not.
PointType
Enumeration for point type in path.
Definition: fs_common.h:1474
Standard font: Courier-Oblique, Italic.
Definition: fs_common.h:1267
~GraphState()
Destructor.
Definition: fs_common.h:854
Standard font: Courier-Bold.
Definition: fs_common.h:1263
void AddSegment(int start_index, int end_index, Filter filter=e_All)
Add a new range segment. (Reverse ordering is legal.)
virtual void OnOutOfMemory()=0
A callback function used to notify application when Foxit PDF SDK runs out of memory.
Font charset: Thai.
Definition: fs_common.h:1237
static bool SetNotifierCallback(NotifierCallback *notifier)
Set a NotifierCallback object to Foxit PDF SDK.
bool AppendRect(const RectF &rect)
Add a rectangle figure to the end of current path.
Definition: fx_coordinates.h:763
float miter_limit
The miter limit for line join.
Definition: fs_common.h:936