API reference - Class LayerSelectionComboBox

_const_cast

Signature: [const] LayerSelectionComboBox 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.

_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.

current_layer=

(1) Signature: void current_layer= (const LayerInfo layer_info)

Description: Selects the current layer by layer properties.

'no layer' is selected by using an empty LayerInfo object.

Python specific notes:
The object exposes a writable attribute 'current_layer'. This is the setter.

(2) Signature: void current_layer= (int layer_index)

Description: Selects the current layer by layer index in the current layout the widget is attached to.

'no layer' is selected by using a negative layer index.

Python specific notes:
The object exposes a writable attribute 'current_layer'. This is the setter.

current_layer_changed

Signature: [signal] void current_layer_changed

Description: This signal is emitted when a new layer is selected.

The signal is not emitted if the layer is changed programmatically.

Python specific notes:
The object exposes a readable attribute 'current_layer_changed'. This is the getter.
The object exposes a writable attribute 'current_layer_changed'. This is the setter.

current_layer_index

Signature: [const] int current_layer_index

Description: Gets the index of the currently selected layer.

A negative value is returned if the currently selected layer does not exist yet in the associated Layout or 'no layer' is selected. To differentiate, use the is_no_layer_selected attribute - it will return true, if 'no layer' is selected and false, if the layer is not created yet (also rendering a negative index).

In most cases, it will be easier to use current_layer_index_ensure, which makes sure the requested layer is created in the Layout object and only returns a negative index, if 'no layer' is requested.

current_layer_index_ensure

Signature: int current_layer_index_ensure

Description: Gets the index of the currently selected layer and creates the layer if required.

See current_layer_index for a discussion of this method.

current_layer_info

Signature: [const] LayerInfo current_layer_info

Description: Gets the layer properties of the currently selected layer.

This method can be used alternatively to current_layer_index or current_layer_index_ensure and will deliver the LayerInfo object of the currently selected layer.

If 'no layer' is selected, an empty LayerInfo object is returned.

is_new_layer_enabled?

Signature: [const] bool is_new_layer_enabled?

Description: Gets a flag indicating whether the 'new layer' option is available.

See new_layer_enabled= for details about this attribute.

Python specific notes:
The object exposes a readable attribute 'new_layer_enabled'. This is the getter.

is_no_layer_selected

Signature: [const] bool is_no_layer_selected

Description: Gets a value indicating whether 'no layer' is selected.

See current_layer_index for a discussion of this method.

is_optional?

Signature: [const] bool is_optional?

Description: Sets a flag indicating whether it is possible to choose 'no layer'.

See optional= for details about this attribute.

Python specific notes:
The object exposes a readable attribute 'optional'. This is the getter.

new

Signature: [static] new LayerSelectionComboBox ptr new (QWidget ptr parent)

Description: Creates a new layer selection combo box

Python specific notes:
This method is the default initializer of the object.

new_layer_enabled=

Signature: void new_layer_enabled= (bool enabled)

Description: Sets a flag indicating whether the 'new layer' option is available.

With this attribute set to true, the drop-down list provides an entry that allows creating new layers.

Python specific notes:
The object exposes a writable attribute 'new_layer_enabled'. This is the setter.

optional=

Signature: void optional= (bool enabled)

Description: Sets a flag indicating whether it is possible to choose 'no layer'.

With this attribute set to true, the drop-down list provides an entry that allows selecting 'nothing'.

Python specific notes:
The object exposes a writable attribute 'optional'. This is the setter.

set_layout

Signature: void set_layout (const Layout ptr layout)

Description: Attaches the widget to a layout.

The widget will display the layers present in the layout and allows selecting one of them. Alternatively, the widget can be associated with a view using set_view.

set_view

Signature: void set_view (LayoutView ptr view, int cv_index, bool all_layers = false)

Description: Attaches the widget to a layout view.

After attaching the widget to a view, the layers present in the layout view for the given cell view are shown in the widget. If 'all_layers' is set to true, also layers are shown which are in the layer list, but not created as layers yet in the underlying Layout object.

Alternatively, the widget can be attached to a Layout object directly using set_layout, but in that case, layer colors or styles are not indicated.