15 #ifndef FS_PDFLAYER_H_ 16 #define FS_PDFLAYER_H_ 59 this->min_factor = min_factor;
60 this->max_factor = max_factor;
96 void Set(
float min_factor,
float max_factor) {
97 this->min_factor = min_factor;
98 this->max_factor = max_factor;
128 typedef enum _UsageState {
233 #ifndef __EMSCRIPTEN_RENDER__ 329 typedef enum _UsageType {
449 #ifndef __EMSCRIPTEN_RENDER__ 681 bool SetName(
const wchar_t* name);
832 #ifndef __EMSCRIPTEN_RENDER__ 839 #endif // FS_PDFLAYER_H_ Definition: fs_pdfgraphicsobject.h:241
LayerNode GetRootNode()
Get the root layer node.
UsageState
Enumeration for PDF layer base state.
Definition: fs_pdflayer.h:128
bool Reset()
Reset current layer context, back to the initialized state.
void Set(const String &subtype, LayerTree::UsageState print_state)
Set value.
Definition: fs_pdflayer.h:297
Use for representing a document designer's structural organization of artwork.
Definition: fs_pdflayer.h:333
String subtype
A string that specifies the kind of content controlled by a layer.
Definition: fs_pdflayer.h:303
LayerTree::UsageState GetExportUsage()
Get the state for exporting usage.
Use for zooming.
Definition: fs_pdflayer.h:339
Use for a viewer.
Definition: fs_pdflayer.h:331
bool operator==(const LayerTree &other) const
Equal operator.
CFX_Object Object
Object type.
Definition: fs_basictypes.h:217
The state is undefined.
Definition: fs_pdflayer.h:136
LayerTree(const PDFDoc &document)
Constructor, from a PDF document.
The state is unchanged.
Definition: fs_pdflayer.h:134
bool SetZoomUsage(const LayerZoomData &data)
Set data for layer zooming usage.
bool CopyStates(const LayerContext &source_context)
Copy states from another layer context.
LayerNode AddChild(int index, const wchar_t *name, bool has_Layer)
Add a new layer node as a child for current layer node.
bool SetExportUsage(LayerTree::UsageState state)
Set state for exporting usage.
LayerNode(const LayerNode &other)
Constructor, with another layer node object.
LayerPrintData(const LayerPrintData &data)
Constructor, with another layer print data object.
Definition: fs_pdflayer.h:268
graphics::GraphicsObjectArray GetGraphicsObjects(const PDFPage &page)
Get all graphics objects related to the layer which is associated with current layer node.
bool operator !=(const LayerTree &other) const
Not equal operator.
WIDE STRING CLASS.
Definition: fx_string.h:1452
objects::PDFArray * GetOCGs() const
Get the "OCGs" PDF array from current object.
Definition: fs_pdflayer.h:38
bool SetName(const wchar_t *name)
Set the name of current layer node.
Definition: fs_pdflayer.h:242
bool SetPrintUsage(const LayerPrintData &data)
Set data for layer printing usage.
Definition: fs_pdfdoc.h:389
objects::PDFDictionary * GetDict() const
Get the dictionary of current object.
~LayerContext()
Destructor.
bool SetBaseState(UsageState state)
Set the base state for all layers in the default configuration.
Definition: fs_pdflayer.h:121
LayerZoomData()
Constructor.
Definition: fs_pdflayer.h:46
Definition: fs_pdflayer.h:43
LayerContext(const PDFDoc &document, UsageType usage_type)
Constructor, based on a PDF document and specified layer usage type.
bool operator==(const LayerNode &other) const
Equal operator.
PDFDoc GetDocument()
Get the related PDF document.
bool RemoveUsage(LayerContext::UsageType usage_type)
Remove a kind of usage property.
UsageType
Enumeration for PDF layer usage type.
Definition: fs_pdflayer.h:329
LayerNode & operator=(const LayerNode &other)
Assign operator.
LayerZoomData(float min_factor, float max_factor)
Constructor, with parameters.
Definition: fs_pdflayer.h:58
int GetChildrenCount()
Get the count of children nodes.
bool AddGraphicsObject(const PDFPage &page, graphics::GraphicsObject *graphicsobject)
Add a graphics object to current layer node.
bool SetVisible(const LayerNode &layer, bool is_visible)
Set the visibility of a specified layer node in current layer context.
bool RemoveGraphicsObject(graphics::GraphicsObject *graphics_object)
Remove a graphics object from current layer node.
bool MoveTo(LayerNode parent_layer_node, int index)
Move current layer node to be one of the children of another layer node.
LayerZoomData(const LayerZoomData &data)
Constructor, with another layer zoom data object.
Definition: fs_pdflayer.h:68
float max_factor
The magnification factor below which the group should be ON. A negative number means no magnification...
Definition: fs_pdflayer.h:110
bool IsVisible(const LayerNode &layer)
Check if a specified layer node is visible in current layer context.
float min_factor
The minimum recommended magnification factor at which the group should be ON. A negative number means...
Definition: fs_pdflayer.h:105
UsageType GetUsageType()
Get the layer usage type for rendering.
LayerPrintData GetPrintUsage()
Get the data for printing usage.
LayerZoomData GetZoomUsage()
Get the data for zooming usage.
Definition: fx_basic.h:1288
LayerPrintData(const String &subtype, LayerTree::UsageState print_state)
Constructor, with parameters.
Definition: fs_pdflayer.h:253
Definition: fs_pdfpage.h:367
LayerPrintData & operator=(const LayerPrintData &data)
Assign operator.
Definition: fs_pdflayer.h:280
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
Header file for common definitions and classes.
The state is OFF.
Definition: fs_pdflayer.h:132
Definition: fs_basictypes.h:397
Definition: fs_pdflayer.h:322
bool IsLocked()
Check if current layer node is locked.
LayerContext & operator=(const LayerContext &other)
Assign operator.
LayerTree::UsageState print_state
Layer usage state, indicating that the group should be set to that state when the document is printed...
Definition: fs_pdflayer.h:312
bool operator !=(const LayerNode &other) const
Not equal operator.
Definition: fs_pdflayer.h:479
Use for exporting.
Definition: fs_pdflayer.h:337
Definition: fs_pdfobject.h:785
bool IsEmpty() const
Check whether current object is empty or not.
objects::PDFDictionary * GetDict() const
Get the PDF dictionary of current object.
LayerNode GetChild(int index)
Get a child node.
Foxit namespace.
Definition: fs_compare.h:27
bool IsEmpty() const
Check whether current object is empty or not.
bool HasLayer()
Check if current layer node is associated with a layer.
The state is ON.
Definition: fs_pdflayer.h:130
BYTE STRING CLASS.
Definition: fx_string.h:317
void Set(float min_factor, float max_factor)
Set value.
Definition: fs_pdflayer.h:96
Use for printing.
Definition: fs_pdflayer.h:335
bool IsInPage(const PDFPage &page)
Check if current layer node is in a specified PDF page.
bool SetDefaultVisible(bool is_visible)
Set default visibility.
#define NULL
The null-pointer value.
Definition: fx_system.h:767
Header file for PDF graphics object related definitions and classes.
bool operator==(const LayerContext &other) const
Equal operator.
LayerTree & operator=(const LayerTree &other)
Assign operator.
bool MergeStates(const LayerContext &source_context)
Merge states from another layer context.
Definition: fs_pdfobject.h:597
bool operator !=(const LayerContext &other) const
Not equal operator.
bool HasIntent(const char *intent)
Check if current layer node has a specified intent.
LayerPrintData()
Constructor.
Definition: fs_pdflayer.h:259
WString GetName()
Get the name of current layer node.
bool SetViewUsage(LayerTree::UsageState state)
Set state for viewing usage.
bool IsEmpty() const
Check whether current object is empty or not.
bool RemoveChild(int index)
Remove a child node by index.
LayerTree::UsageState GetViewUsage()
Get the state for viewing usage.