Foxit PDF SDK
fs_reflowpage.h
Go to the documentation of this file.
1 
15 #ifndef FS_REFLOWPAGE_H_
16 #define FS_REFLOWPAGE_H_
17 
18 #include "common/fs_common.h"
19 //#include "pdf/fs_pdfpage.h"
20 
26 namespace foxit {
30 namespace pdf {
31 class PDFPage;
32 
62 class ReflowPage FS_FINAL : public Base {
63  public:
69  typedef enum _Flags {
71  e_Normal = 0x0,
73  e_WithImage = 0x1,
93  } Flags;
94 
95 
101  explicit ReflowPage(const PDFPage& page);
102 
108  ReflowPage(const ReflowPage& other);
109 
117  ReflowPage& operator = (const ReflowPage& other);
125  bool operator == (const ReflowPage& other) const ;
133  bool operator != (const ReflowPage& other) const ;
135  ~ReflowPage();
136 
144  bool IsEmpty() const;
156  void SetScreenSize(float width, float height);
157 
173  void SetScreenMargin(int left, int top, int right, int bottom);
174 
189  void SetZoom(int zoom);
190 
201  void SetParseFlags(uint32 flags);
202 
211  void SetLineSpace(float line_space);
212 
221  void SetImageScale(float image_scale);
222 
234  void SetTopSpace(float top_space);
235 
253 
259  float GetContentWidth() const;
260 
266  float GetContentHeight() const;
267 
284  Matrix GetDisplayMatrix(float offset_x, float offset_y,int width, int height,common::Rotation rotate) const;
285 
305  String GetFocusData(const Matrix& matrix, const PointF& point) const;
306 
328  PointF GetFocusPosition(const Matrix& matrix, const char* focus_data) const;
329 
336  bool IsParsed() const;
337 
338  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
339  explicit ReflowPage(FS_HANDLE handle = NULL);
340 };
341 } // namespace pdf
342 } // namespace foxit
343 #endif // FS_REFLOWPAGE_H_
344 
common::Progressive StartParse(common::PauseCallback *pause=0)
Start to parse current reflow page.
Definition: fs_reflowpage.h:62
float GetContentWidth() const
Get content width after current reflow page object has been parsed.
float GetContentHeight() const
Get content height after current reflow page object has been parsed.
bool IsEmpty() const
Check whether current object is empty or not.
void SetParseFlags(uint32 flags)
Set the parsing flag. This can be called before calling function ReflowPage::StartParse.
void SetImageScale(float image_scale)
Set image scale. This can be called before calling function ReflowPage::StartParse.
bool operator==(const ReflowPage &other) const
Equal operator.
Definition: fx_coordinates.h:30
bool operator !=(const ReflowPage &other) const
Not equal operator.
String GetFocusData(const Matrix &matrix, const PointF &point) const
Get focus data corresponding to a given position in device coordinate system.
bool IsParsed() const
Check if current reflow page has been parsed or not.
void SetTopSpace(float top_space)
Set the top space. This can be called before calling function ReflowPage::StartParse.
PointF GetFocusPosition(const Matrix &matrix, const char *focus_data) const
Get the position in device coordinate system corresponding to a given focus data.
void SetZoom(int zoom)
Set zoom factor. This can be called before calling function ReflowPage::StartParse.
ReflowPage & operator=(const ReflowPage &other)
Assign operator.
void SetScreenSize(float width, float height)
Set screen size. This should be called before calling function ReflowPage::StartParse.
void SetLineSpace(float line_space)
Set line space. This can be called before calling function ReflowPage::StartParse.
Parsing flag to decide whether to allow to truncate the first/last image or line of text within the s...
Definition: fs_reflowpage.h:92
Definition: fx_basic.h:3752
Definition: fs_common.h:281
Matrix GetDisplayMatrix(float offset_x, float offset_y, int width, int height, common::Rotation rotate) const
Get the display matrix, according to the offset of top side between current reflow page and screen.
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
Definition: fs_pdfpage.h:367
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
Header file for common definitions and classes.
void SetScreenMargin(int left, int top, int right, int bottom)
Set margin. This can be called before calling function ReflowPage::StartParse.
Parsing flag for image mode.
Definition: fs_reflowpage.h:73
~ReflowPage()
Destructor.
Definition: fs_basictypes.h:397
Flags
Enumeration for parsing flags used for a reflow page.
Definition: fs_reflowpage.h:69
Rotation
Enumeration for rotation.
Definition: fs_common.h:56
Foxit namespace.
Definition: fs_compare.h:27
Parsing flag for normal mode, without image.
Definition: fs_reflowpage.h:71
BYTE STRING CLASS.
Definition: fx_string.h:317
#define NULL
The null-pointer value.
Definition: fx_system.h:767
ReflowPage(const PDFPage &page)
Constructor, from a parsed PDF page.
Definition: fx_coordinates.h:1076