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;
157  void SetScreenSize(float width, float height);
158 
178  void SetScreenMargin(int left, int top, int right, int bottom);
179 
194  void SetZoom(int zoom);
195 
206  void SetParseFlags(uint32 flags);
207 
217  void SetLineSpace(float line_space);
218 
227  void SetImageScale(float image_scale);
228 
240  void SetTopSpace(float top_space);
241 
260 
266  float GetContentWidth() const;
267 
273  float GetContentHeight() const;
274 
291  Matrix GetDisplayMatrix(float offset_x, float offset_y,int width, int height,common::Rotation rotate) const;
292 
312  String GetFocusData(const Matrix& matrix, const PointF& point) const;
313 
335  PointF GetFocusPosition(const Matrix& matrix, const char* focus_data) const;
336 
343  bool IsParsed() const;
344 
345  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
346  explicit ReflowPage(FS_HANDLE handle = NULL);
347 };
348 } // namespace pdf
349 } // namespace foxit
350 #endif // FS_REFLOWPAGE_H_
351 
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 functions ReflowPage::StartParse and ReflowPage...
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:3758
Definition: fs_common.h:373
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:412
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:443
Flags
Enumeration for parsing flags used for a reflow page.
Definition: fs_reflowpage.h:69
Rotation
Enumeration for rotation.
Definition: fs_common.h:57
Foxit namespace.
Definition: fs_taggedpdf.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:792
ReflowPage(const PDFPage &page)
Constructor, from a parsed PDF page.
Definition: fx_coordinates.h:1076