Foxit PDF SDK

fs_tabordermgr.h
Go to the documentation of this file.
1
15 #ifndef FS_TABORDERMGR_H_
16 #define FS_TABORDERMGR_H_
17
18 #include "common/fs_common.h"
19 #include "pdf/annots/fs_annot.h"
20 #include "pdf/fs_pdfpage.h"
21
27 namespace foxit {
31 namespace pdf {
54 class TabOrderMgr FS_FINAL : public Base {
55 public:
61 typedef enum _OrderType {
63 e_None = 0x0000,
65 e_Row = 0x0001,
67 e_Column = 0x0002,
69 e_Structure = 0x0003
70 } OrderType;
71
77 explicit TabOrderMgr(const PDFPage& page);
78
84 TabOrderMgr(const TabOrderMgr& other);
92 TabOrderMgr& operator = (const TabOrderMgr& other);
93
101 bool operator == (const TabOrderMgr& other) const;
109 bool operator != (const TabOrderMgr& other) const;
110
118 bool IsEmpty() const;
120 ~TabOrderMgr();
121
137 void Reload();
138
145 OrderType GetOrderType() const;
146
161 void SetOrderType(OrderType order_type);
162
169 annots::Annot GetFirstAnnot();
170
177 annots::Annot GetLastAnnot();
178
188 annots::Annot GetNextAnnot(const annots::Annot& annot);
189
199 annots::Annot GetPrevAnnot(const annots::Annot& annot);
200
218 bool AdjustStructureOrder(const annots::AnnotArray& annot_array);
219
220 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
221 explicit TabOrderMgr(FS_HANDLE handle = NULL);
222 };
223 } // namespace pdf
224 } // namespace foxit
225 #endif // FS_TABORDERMGR_H_
226
foxit::pdf::TabOrderMgr
Definition: fs_tabordermgr.h:54
foxit::pdf::annots::AnnotArray
Definition: fs_annot.h:1666
foxit::pdf::TabOrderMgr::GetPrevAnnot
annots::Annot GetPrevAnnot(const annots::Annot &annot)
Get the previous annotation of specified annotation in current tab order.
foxit::pdf::TabOrderMgr::e_Structure
S (structure order): Annotations are visited in the order in which they appear in the structure tree.
Definition: fs_tabordermgr.h:69
foxit::pdf::TabOrderMgr::Reload
void Reload()
Reload the tab order of annotations.
foxit::pdf::TabOrderMgr::operator !=
bool operator !=(const TabOrderMgr &other) const
Not equal operator.
foxit::pdf::TabOrderMgr::GetLastAnnot
annots::Annot GetLastAnnot()
Get the last annotation in current tab order.
foxit::pdf::TabOrderMgr::e_None
None (index order): Annotations are visited in annotation's index across the page.
Definition: fs_tabordermgr.h:63
foxit::pdf::TabOrderMgr::e_Row
R (row order): Annotations are visited in rows running horizontally across the page.
Definition: fs_tabordermgr.h:65
foxit::pdf::TabOrderMgr::~TabOrderMgr
~TabOrderMgr()
Destructor.
foxit::pdf::TabOrderMgr::AdjustStructureOrder
bool AdjustStructureOrder(const annots::AnnotArray &annot_array)
Adjust the structure order with specified annotations, and tab order type will be set to TabOrderMgr:...
foxit::pdf::TabOrderMgr::operator==
bool operator==(const TabOrderMgr &other) const
Equal operator.
fs_annot.h
Header file for annotation related definitions and classes.
foxit::pdf::TabOrderMgr::operator=
TabOrderMgr & operator=(const TabOrderMgr &other)
Assign operator.
foxit::pdf::TabOrderMgr::OrderType
OrderType
Enumeration for tab order type.
Definition: fs_tabordermgr.h:61
foxit::pdf::PDFPage
Definition: fs_pdfpage.h:412
foxit::FS_HANDLE
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:213
foxit::pdf::TabOrderMgr::TabOrderMgr
TabOrderMgr(const PDFPage &page)
Constructor, from a PDF page object.
fs_common.h
Header file for common definitions and classes.
foxit::pdf::TabOrderMgr::GetFirstAnnot
annots::Annot GetFirstAnnot()
Get the first annotation in current tab order.
foxit::pdf::TabOrderMgr::IsEmpty
bool IsEmpty() const
Check whether current object is empty or not.
foxit::Base
Definition: fs_basictypes.h:451
foxit::pdf::TabOrderMgr::SetOrderType
void SetOrderType(OrderType order_type)
Set the tab order type.
fs_pdfpage.h
Header file for PDF page related definitions and classes.
foxit::pdf::annots::Annot
Definition: fs_annot.h:1006
foxit
Foxit namespace.
Definition: fs_pdf3d.h:26
foxit::pdf::TabOrderMgr::GetOrderType
OrderType GetOrderType() const
Get the tab order type.
foxit::pdf::TabOrderMgr::GetNextAnnot
annots::Annot GetNextAnnot(const annots::Annot &annot)
Get the next annotation of specified annotation in current tab order.
NULL
#define NULL
The null-pointer value.
Definition: fx_system.h:792
foxit::pdf::TabOrderMgr::e_Column
C (column order): Annotations are visited in columns running vertically up and down the page.
Definition: fs_tabordermgr.h:67