This class represents a layer context for rendering. If user wants to render layers, please construct a LayerContext first and then set it to a common::Renderer object by function common::Renderer::SetLayerContext.
- See also
- common::Renderer
◆ UsageType
Enumeration for PDF layer usage type.
Values of this enumeration should be used alone.
Enumerator |
---|
e_UsageView | Use for a viewer.
|
e_UsageDesign | Use for representing a document designer's structural organization of artwork.
|
e_UsagePrint | Use for printing.
|
e_UsageExport | Use for exporting.
|
e_UsageZoom | Use for zooming.
|
◆ LayerContext() [1/2]
foxit::pdf::LayerContext::LayerContext |
( |
const PDFDoc & |
document, |
|
|
UsageType |
usage_type |
|
) |
| |
|
explicit |
Constructor, based on a PDF document and specified layer usage type.
- Parameters
-
◆ LayerContext() [2/2]
foxit::pdf::LayerContext::LayerContext |
( |
const LayerContext & |
other | ) |
|
◆ CopyStates()
bool foxit::pdf::LayerContext::CopyStates |
( |
const LayerContext & |
source_context | ) |
|
Copy states from another layer context.
- Parameters
-
[in] | source_context | The source layer context, whose state will be copied to current layer context. |
- Returns
- true means success, while false means failure.
◆ GetDocument()
PDFDoc foxit::pdf::LayerContext::GetDocument |
( |
| ) |
|
Get the related PDF document.
- Returns
- The related PDF document object.
◆ GetUsageType()
UsageType foxit::pdf::LayerContext::GetUsageType |
( |
| ) |
|
◆ IsEmpty()
bool foxit::pdf::LayerContext::IsEmpty |
( |
| ) |
const |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
- Returns
- true means current object is empty, while false means not.
◆ IsVisible()
bool foxit::pdf::LayerContext::IsVisible |
( |
const LayerNode & |
layer | ) |
|
Check if a specified layer node is visible in current layer context.
- Parameters
-
[in] | layer | A layer node. It should belong to the same PDF document which is related to current layer context. |
- Returns
- true means the layer node is visible, while false means the layer node is invisible.
◆ MergeStates()
bool foxit::pdf::LayerContext::MergeStates |
( |
const LayerContext & |
source_context | ) |
|
Merge states from another layer context.
- Parameters
-
[in] | source_context | The source layer context, whose state will be merged to current layer context. |
- Returns
- true means success, while false means failure.
◆ operator!=()
bool foxit::pdf::LayerContext::operator!= |
( |
const LayerContext & |
other | ) |
const |
Not equal operator.
- Parameters
-
[in] | other | Another LayerContext object. This function will check if current object is not equal to this one. |
- Returns
- true means not equal, while false means equal.
◆ operator=()
Assign operator.
- Parameters
-
[in] | other | Another LayerContext object, whose value would be assigned to current object. |
- Returns
- Reference to current object itself.
◆ operator==()
bool foxit::pdf::LayerContext::operator== |
( |
const LayerContext & |
other | ) |
const |
Equal operator.
- Parameters
-
[in] | other | Another LayerContext object. This function will check if current object is equal to this one. |
- Returns
- true means equal, while false means not equal.
◆ Reset()
bool foxit::pdf::LayerContext::Reset |
( |
| ) |
|
Reset current layer context, back to the initialized state.
- Returns
- true means success, while false means failure.
◆ SetVisible()
bool foxit::pdf::LayerContext::SetVisible |
( |
const LayerNode & |
layer, |
|
|
bool |
is_visible |
|
) |
| |
Set the visibility of a specified layer node in current layer context.
- Parameters
-
[in] | layer | A layer node. It should belong to the same PDF document which is related to current layer context. |
[in] | is_visible | true means visible, and false means invisible. |
- Returns
- true means the layer node is visible, while false means the layer node is invisible.