Notation used in Ruby API documentation
Module: lay
Description: A widget to select a cell view from a view
Class hierarchy: CellViewSelectionComboBox » QComboBox » QWidget » QObject
To use the widget, first associate it to a view by using layout_view=. The widget will show the cell views available inside the layout view and allows selecting one of them.
This class has been introduced in version 0.30.11.
| new CellViewSelectionComboBox ptr | new | (QWidget ptr parent) | Creates a new cell view selection combo box |
| [const] | CellViewSelectionComboBox 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] | 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. | ||
| [const] | int | current_cell_view_index | Gets the index of the currently selected cell view | |
| void | current_cell_view_index= | (int cv_index) | Sets the index of the current cell view | |
| [signal] | void | current_cv_index_changed | (int cell_view_index) | This signal is emitted when a different cell view is selected. |
| [const] | const LayoutView ptr | layout_view | Gets the view object this widget is associated with. | |
| void | layout_view= | (const LayoutView ptr view) | Associates the selection widget with a specific view. |
_const_cast | Signature: [const] CellViewSelectionComboBox 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_cell_view_index | Signature: [const] int current_cell_view_index Description: Gets the index of the currently selected cell view See current_cell_view= for details of this attribute. Python specific notes: |
current_cell_view_index= | Signature: void current_cell_view_index= (int cv_index) Description: Sets the index of the current cell view A negative value corresponds to 'no view selected'. The cell view index addresses a CellView inside the LayoutView associated with this selection widget through layout_view=. Python specific notes: |
current_cv_index_changed | Signature: [signal] void current_cv_index_changed (int cell_view_index) Description: This signal is emitted when a different cell view is selected. The signal is also emitted if the cell view is changed programmatically. Python specific notes: |
layout_view | Signature: [const] const LayoutView ptr layout_view Description: Gets the view object this widget is associated with. See layout_view= for details about this attribute. Python specific notes: |
layout_view= | Signature: void layout_view= (const LayoutView ptr view) Description: Associates the selection widget with a specific view. The view provides the list of selectable cell views. Hence, only selection widgets that are associated with a view are useful. Set this attribute to attach the widget to a specific view. Python specific notes: |
new | Signature: [static] new CellViewSelectionComboBox ptr new (QWidget ptr parent) Description: Creates a new cell view selection combo box Python specific notes: |