Public Types | |
enum | UsageState { UsageState.e_StateON = 0x0000, UsageState.e_StateOFF = 0x0001, UsageState.e_StateUnchanged = 0x0002, UsageState.e_StateUndefined = 0x0003 } |
Enumeration for PDF layer base state. More... | |
Public Member Functions | |
LayerTree (PDFDoc document) | |
Constructor, from a PDF document. More... | |
LayerTree (LayerTree other) | |
Constructor, with another LayerTree object. | |
PDFDictionary | GetDict () |
Get the dictionary of current object. More... | |
PDFArray | GetOCGs () |
Get the "OCGs" PDF array from current object. More... | |
LayerNode | GetRootNode () |
Get the root layer node. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
bool | SetBaseState (LayerTree.UsageState state) |
Set the base state for all layers in the default configuration. More... | |
PDF layer nodes are stored in a PDF layer tree. If user wants to retrieve a layer node, user must construct a PDFLayerTree object from a PDF document first and then call function LayerTree::GetRootNode to get the root layer node of the whole layer tree. Then, user can enumerate all the nodes in the layer tree from the root layer node.
|
strong |
|
inline |
Constructor, from a PDF document.
Currently, the constructed LayerTree object can only be associated with existed layer tree in PDF document. If there is no layer tree in PDF document, functoin LayerTree::IsEmpty of the constructed LayerTree will return true.
document | A valid PDF document object. |
|
inline |
Get the dictionary of current object.
|
inline |
Get the "OCGs" PDF array from current object.
|
inline |
Get the root layer node.
After getting the root layer node, user can enumerate all layer nodes in current layer tree by functions of class LayerNode.
|
inline |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
|
inline |
Set the base state for all layers in the default configuration.
state | Layer usage state. Please refer to e_StateXXX values and it should be one of these values except e_StateUndefined. |