#include <customgui_layerset.h>
Layer set custom data type (CUSTOMDATATYPE_LAYERSET).
◆ LayerSet()
◆ ~LayerSet()
◆ IsPopulated()
Bool IsPopulated |
( |
| ) |
const |
Checks if the layer set has content.
- Returns
- true if the set contains any layer, otherwise false.
◆ IsLayerEnabled()
Checks if a layer is enabled.
- Parameters
-
[in] | name | The name of the layer to check for. |
- Returns
- true if the layer is enabled, otherwise false.
◆ FindLayerSet()
Checks if a layer is in the set.
- Parameters
-
[in] | name | The name of the layer to check for. |
- Returns
- true if the layer is in the set, otherwise false.
◆ GetName()
Gets the set's name.
- Returns
- The name of the set.
◆ GetMode()
◆ SetMode()
Sets a new layer set mode.
- Parameters
-
◆ RemoveLayer()
Removes a layer.
- Parameters
-
[in] | layer | The name of the layer to remove. |
◆ AddLayer()
Adds a layer.
- Parameters
-
[in] | layer | The name of the layer to add. |
◆ FlushLayers()
◆ SetPreviewMode()
void SetPreviewMode |
( |
Int32 |
s | ) |
|
Sets the preview mode.
- Parameters
-
[in] | s | The preview mode to set. |
◆ GetPreviewMode()
Gets the preview mode.
- Returns
- The current preview mode.
◆ operator=()
Assignment operator. Copies the source layerset.
- Parameters
-
[in] | layerset | The source layer set. |
- Returns
- The assigned layer set to the left-operand.
◆ operator==()
Equality operator. Checks if the set and layerset are equal.
- Parameters
-
[in] | layerset | The layer set to compare with. |
- Returns
- true if the layer sets are equal, otherwise false.
◆ CopyTo()
Copies the layer set to dst.
- Parameters
-
[in] | dst | The destination layer set. |
◆ Alloc()
Allocates a layer set data. Destroy the allocated layer set data with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.
- Returns
- The allocated layer set data, or nullptr if the allocation failed.
◆ Free()
Destructs layer set datas allocated with Alloc(). Use AutoAlloc to automate the allocation and destruction based on scope.
- Parameters
-
[in,out] | layerset | The layer set data to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards. |