28 class DocEventCallback;
40 class AppProviderCallback;
48 #if defined(_SWIG_ANDROID_) || defined(_SWIG_JAVA_) 56 typedef enum _Rotation {
74 typedef enum _Alignment {
88 typedef enum _FillMode {
108 typedef enum _Position {
131 #if defined(__ANDROID__) || defined(_JAVA_) 139 typedef enum _Rotation {
157 typedef enum _Alignment {
171 typedef enum _FillMode {
191 typedef enum _Position {
219 typedef enum _Rotation {
237 typedef enum _Alignment {
251 typedef enum _FillMode {
271 typedef enum _Position {
294 #define CommonDefines foxit::common 389 typedef enum _State {
706 static void*
Alloc(
size_t size);
715 static void Free(
void* ptr);
728 static void*
Realloc(
void* ptr,
size_t new_size);
740 static void SetLogFile(
const char* log_file_path);
752 static void SetLogFile(
const wchar_t* log_file_path);
767 typedef enum _LineCapStyle {
791 typedef enum _LineJoinStyle {
1033 typedef enum _Filter {
1049 explicit Range(
int index);
1183 typedef enum _Styles {
1209 typedef enum _Charset {
1247 typedef enum _StandardID {
1309 Font(
const char* font_file_path,
int face_index,
Charset charset);
1320 Font(
const wchar_t* font_file_path,
int face_index,
Charset charset);
1460 typedef enum _PointType {
1673 #endif // FS_COMMON_H_ Definition: fs_annot.h:1455
Font style: non-symbolic.
Definition: fs_common.h:1193
Indicates that a line is drawn from the previous point to this point, and this point will also be con...
Definition: fs_common.h:1470
Miter line join type.
Definition: fs_common.h:797
Styles
Enumeration for font styles.
Definition: fs_common.h:1183
LineCapStyle line_cap
Line cap style.
Definition: fs_common.h:937
Standard font: Helvetica-Bold.
Definition: fs_common.h:1259
Font charset: Korean (Wansung).
Definition: fs_common.h:1219
Bevel line join type.
Definition: fs_common.h:811
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:945
Position: center.
Definition: fs_common.h:281
Font charset: Japanese (Shift-JIS).
Definition: fs_common.h:1217
Definition: fs_common.h:1026
bool AppendEllipse(const RectF &rect)
Add an ellipse figure to the end of current path.
Standard font: Times-Bold.
Definition: fs_common.h:1267
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:258
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:289
Definition: fs_common.h:301
Position
Enumeration for watermark position in a PDF page.
Definition: fs_common.h:271
Projecting square cap. The stroke continues beyond the endpoint of the path for a distance equal to h...
Definition: fs_common.h:782
PointType GetPointType(int index)
Get the type of a point specified by index.
CFX_Object Object
Object type.
Definition: fs_basictypes.h:216
IFX_Pause PauseCallback
Definition: fs_common.h:953
Definition: fs_common.h:444
Round line join type.
Definition: fs_common.h:804
bool operator!=(const Font &other) const
Not equal operator.
Standard font: Times-BoldItalic.
Definition: fs_common.h:1269
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:828
Unknown rotation.
Definition: fs_common.h:229
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:1039
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:895
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:777
static bool RegisterSignatureCallback(const char *filter, const char *sub_filter, pdf::SignatureCallback *signature_callback)
Register a third-party SignatureCallback object to Foxit PDF SDK for signing and verifying signature...
Rotate 180 degrees in clockwise direction.
Definition: fs_common.h:225
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:1197
Filter
Enumeration for range filter.
Definition: fs_common.h:1033
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:1463
GraphState(const GraphState &state)
Constructor, with another GraphState object.
Definition: fs_common.h:854
State
Enumeration for progress state.
Definition: fs_common.h:389
static void RegisterXFAAppProviderCallback(addon::xfa::AppProviderCallback *callback)
Register an xfa::AppProviderCallback object to Foxit PDF SDK.
Standard font: Helvetica.
Definition: fs_common.h:1257
Position: top right.
Definition: fs_common.h:277
Definition: fs_common.h:960
Indicates that the point is the first point of a figure.
Definition: fs_common.h:1462
LineCapStyle
Enumeration for line cap style.
Definition: fs_common.h:767
Font style: script.
Definition: fs_common.h:1191
static ErrorCode Reinitialize()
Reinitialize Foxit PDF SDK Library.
static bool RegisterSecurityCallback(const char *filter, pdf::SecurityCallback *callback)
Register a SecurityCallback object to Foxit PDF SDK for decryption of the PDFs with special encryptio...
Definition: fs_pdfdoc.h:338
static bool SetCacheSize(uint32 size)
Set the upper limit of PDF library cache size.
Progressive(const Progressive &)
Constructor, with another Progressive object.
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:1195
static bool SetAnnotIconProviderCallback(pdf::annots::IconProviderCallback *annot_icon_provider)
Set a customized annots::IconProviderCallback object to Foxit PDF SDK.
Progress state: progress needs to be continued.
Definition: fs_common.h:393
GraphState()
Constructor.
Definition: fs_common.h:839
Position: bottom center.
Definition: fs_common.h:287
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:781
void Transform(const Matrix &matrix)
Transform all points in current path with a given matrix.
~Progressive()
Destructor.
Font style: serif.
Definition: fs_common.h:1187
Indicates that a line is drawn from the previous point to this point.
Definition: fs_common.h:1464
Header file for basic types definitions.
LineJoinStyle line_join
Line join style.
Definition: fs_common.h:919
Position center left.
Definition: fs_common.h:279
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:233
Only even numbers in a range will be used (discards odd numbers).
Definition: fs_common.h:1037
virtual void OnDocSaved(const pdf::PDFDoc &document, ErrorCode error_code)
Triggered when a PDF document is saved.
Definition: fs_common.h:1016
Font charset: Traditional Chinese.
Definition: fs_common.h:1223
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:1211
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:772
Position: center right.
Definition: fs_common.h:283
virtual void Release()=0
A callback function used to release current NotifierCallback 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:1215
CFX_PointF PointF
Point information, in float.
Definition: fs_basictypes.h:353
Font style: force bold.
Definition: fs_common.h:1201
FillMode
Enumeration for filling mode type, mainly for path graphics object.
Definition: fs_common.h:251
static void * Realloc(void *ptr, size_t new_size)
Reallocate a memory block.
Font style: symbolic.
Definition: fs_common.h:1189
bool IsEmpty() const
Check whether current object is empty or not.
Definition: fx_basic.h:3566
Definition: fs_common.h:759
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:1253
Definition: fs_common.h:1453
bool operator==(const Path &other) const
Equal operator.
Font charset: Arabic.
Definition: fs_common.h:1237
LineJoinStyle
Enumeration for line join style.
Definition: fs_common.h:791
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:1213
Definition: fs_common.h:382
float line_width
Line width.
Definition: fs_common.h:911
Winding fill mode, in which the system uses a direction in which a figure is drawn to determine wheth...
Definition: fs_common.h:263
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:195
virtual void OnDocOpened(const pdf::PDFDoc &document, ErrorCode error_code)
Triggered when a PDF document is opened.
Definition: fs_common.h:986
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:213
virtual void OnDocWillOpen()
Triggered when the document will be opened.
Definition: fs_common.h:974
static bool SetDocEventCallback(DocEventCallback *callback)
Set a DocEventCallback object to Foxit PDF SDK.
Font charset: Russian.
Definition: fs_common.h:1229
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 SecurityCallback object from Foxit PDF SDK.
Definition: fx_coordinates.h:458
Alignment
Enumeration for alignment (horizontal).
Definition: fs_common.h:237
virtual void OnDocWillSave(const pdf::PDFDoc &document)
Triggered when a PDF document will be saved.
Definition: fs_common.h:1004
static bool SetActionCallback(ActionCallback *action_callback)
Set an 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:333
bool operator==(const Font &other) const
Equal operator.
Standard font: ZapfDingbats.
Definition: fs_common.h:1275
Standard font: Helvetica-Oblique, Italic.
Definition: fs_common.h:1263
Definition: fs_security.h:1184
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:1478
Standard font: Times-Roman.
Definition: fs_common.h:1265
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:1273
Rotate 270 degrees in clockwise direction.
Definition: fs_common.h:227
Position: bottom left.
Definition: fs_common.h:285
Font style: fixed pitch.
Definition: fs_common.h:1185
Font charset: Simplified Chinese.
Definition: fs_common.h:1221
Standard font: Times-Italic.
Definition: fs_common.h:1271
Definition: fs_common.h:1176
Fill mode: none.
Definition: fs_common.h:253
Center alignment.
Definition: fs_common.h:241
No rotation.
Definition: fs_common.h:221
Rotation
Enumeration for rotation.
Definition: fs_common.h:219
Foxit namespace.
Definition: fs_connectedpdf.h:26
Left alignment.
Definition: fs_common.h:239
Definition: fs_common.h:351
void AddSingle(int index)
Add an index as a new range segment.
float dash_phase
Dash phase for dash pattern.
Definition: fs_common.h:940
StandardID
Enumeration for standard font ID.
Definition: fs_common.h:1247
All the indexes within a range will be used.
Definition: fs_common.h:1035
BYTE STRING CLASS.
Definition: fx_string.h:317
Progress state: progress is finished.
Definition: fs_common.h:395
Font charset: Hebrew.
Definition: fs_common.h:1235
Charset
Enumeration for font charset.
Definition: fs_common.h:1209
static void Free(void *ptr)
Free a memory block.
Font style: small cap.
Definition: fs_common.h:1199
Font charset: Greek.
Definition: fs_common.h:1231
Rotate 90 degrees in clockwise direction.
Definition: fs_common.h:223
virtual void Release()=0
A callback function used to release current DocEventCallback 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:1261
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:1239
Standard font: Courier.
Definition: fs_common.h:1249
GraphState & operator=(const GraphState &state)
Assign operator.
Definition: fs_common.h:870
Font charset: Turkish.
Definition: fs_common.h:1233
Progress state: any error occurs.
Definition: fs_common.h:391
#define NULL
The null-pointer value.
Definition: fx_system.h:767
virtual void OnDocWillDestroy(const pdf::PDFDoc &document)
Triggered when a PDF document will be destroyed.
Definition: fs_common.h:995
Definition: fx_coordinates.h:914
Font charset: Eastern European.
Definition: fs_common.h:1227
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:243
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:1472
bool RemovePoint(int index)
Remove a point specified by index.
Position: top left.
Definition: fs_common.h:273
Font & operator=(const Font &other)
Assign operator.
Position: top center.
Definition: fs_common.h:275
bool IsItalic() const
Judge whether current font object is italic or not.
PointType
Enumeration for point type in path.
Definition: fs_common.h:1460
Standard font: Courier-Oblique, Italic.
Definition: fs_common.h:1255
~GraphState()
Destructor.
Definition: fs_common.h:847
Standard font: Courier-Bold.
Definition: fs_common.h:1251
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:1225
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:627
float miter_limit
The miter limit for line join.
Definition: fs_common.h:929