Notation used in Ruby API documentation
Module: lay
Description: A layer properties node structure
Class hierarchy: LayerPropertiesNode » LayerProperties
This class is derived from LayerProperties. Objects of this class are used in the hierarchy of layer views that are arranged in a tree while the LayerProperties object reflects the properties of a single node.
| [const] | bool | != | (const LayerPropertiesNode other) | Inequality |
| [const] | bool | == | (const LayerPropertiesNode other) | Equality |
| void | _assign | (const LayerPropertiesNode other) | Assigns another object to self | |
| [const] | LayerPropertiesNode ptr | _const_cast | Returns a non-const reference to self. | |
| void | _create | Ensures the C++ object is created | ||
| void | _destroy | Explicitly destroys the object | ||
| [const] | bool | _destroyed? | Returns a value indicating whether the object was already destroyed | |
| [const] | new LayerPropertiesNode ptr | _dup | Creates a copy of self | |
| [const] | bool | _is_const_object? | Returns a value indicating whether the reference is a const reference | |
| void | _manage | Marks the object as managed by the script side. | ||
| void | _unmanage | Marks the object as no longer owned by the script side. | ||
| LayerPropertiesNodeRef | add_child | Add a child entry | ||
| LayerPropertiesNodeRef | add_child | (const LayerProperties ptr child) | Add a child entry | |
| [const] | DBox | bbox | Compute the bbox of this layer | |
| void | clear_children | Clears all children | ||
| void | expanded= | (bool ex) | Set a value indicating whether the layer tree node is expanded. | |
| [const] | LayerPropertiesNode | flat | return the "flattened" (effective) layer properties node for this node | |
| [const] | bool | has_children? | Test, if there are children | |
| [const] | unsigned int | id | Obtain the unique ID | |
| [const] | bool | is_expanded? | Gets a value indicating whether the layer tree node is expanded. | |
| [const] | unsigned int | list_index | Gets the index of the layer properties list that the node lives in | |
| LayoutView ptr | view | Gets the view this node lives in |
!= | Signature: [const] bool != (const LayerPropertiesNode other) Description: Inequality
| ||
== | Signature: [const] bool == (const LayerPropertiesNode other) Description: Equality
| ||
_assign | Signature: void _assign (const LayerPropertiesNode other) Description: Assigns another object to self | ||
_const_cast | Signature: [const] LayerPropertiesNode ptr _const_cast Description: Returns a non-const reference to self. Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects. This method has been introduced in version 0.29.6. | ||
_create | Signature: void _create Description: Ensures the C++ object is created Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created. | ||
_destroy | Signature: void _destroy Description: Explicitly destroys the object Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing. | ||
_destroyed? | Signature: [const] bool _destroyed? Description: Returns a value indicating whether the object was already destroyed This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself. | ||
_dup | Signature: [const] new LayerPropertiesNode ptr _dup Description: Creates a copy of self | ||
_is_const_object? | Signature: [const] bool _is_const_object? Description: Returns a value indicating whether the reference is a const reference This method returns true, if self is a const reference. In that case, only const methods may be called on self. | ||
_manage | Signature: void _manage Description: Marks the object as managed by the script side. After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required. Usually it's not required to call this method. It has been introduced in version 0.24. | ||
_unmanage | Signature: void _unmanage Description: Marks the object as no longer owned by the script side. Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur. Usually it's not required to call this method. It has been introduced in version 0.24. | ||
add_child | (1) Signature: LayerPropertiesNodeRef add_child Description: Add a child entry
This method allows building a layer properties tree by adding children to node objects. It returns a reference to the node object created which is a freshly initialized one. The parameterless version of this method was introduced in version 0.25. | ||
(2) Signature: LayerPropertiesNodeRef add_child (const LayerProperties ptr child) Description: Add a child entry
This method allows building a layer properties tree by adding children to node objects. It returns a reference to the node object created. This method was introduced in version 0.22. | |||
bbox | Signature: [const] DBox bbox Description: Compute the bbox of this layer
This takes the layout and path definition (supported by the given default layout or path, if no specific is given). The node must have been attached to a view to make this operation possible. | ||
clear_children | Signature: void clear_children Description: Clears all children This method was introduced in version 0.22. | ||
expanded= | Signature: void expanded= (bool ex) Description: Set a value indicating whether the layer tree node is expanded. Setting this value to 'true' will expand (open) the tree node. Setting it to 'false' will collapse the node. This predicate has been introduced in version 0.28.6. Python specific notes: | ||
flat | Signature: [const] LayerPropertiesNode flat Description: return the "flattened" (effective) layer properties node for this node This method returns a LayerPropertiesNode object that is not embedded into a hierarchy. This object represents the effective layer properties for the given node. In particular, all 'local' properties are identical to the 'real' properties. Such an object can be used as a basis for manipulations. Unlike the name suggests, this node will still contain a hierarchy of nodes below if the original node did so. | ||
has_children? | Signature: [const] bool has_children? Description: Test, if there are children | ||
id | Signature: [const] unsigned int id Description: Obtain the unique ID Each layer properties node object has a unique ID that is created when a new LayerPropertiesNode object is instantiated. The ID is copied when the object is copied. The ID can be used to identify the object irregardless of its content. | ||
is_expanded? | Signature: [const] bool is_expanded? Description: Gets a value indicating whether the layer tree node is expanded. This predicate has been introduced in version 0.28.6. Python specific notes: | ||
list_index | Signature: [const] unsigned int list_index Description: Gets the index of the layer properties list that the node lives in | ||
view | Signature: LayoutView ptr view Description: Gets the view this node lives in This reference can be nil if the node is a orphan node that lives outside a view. |