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