Notation used in Ruby API documentation
Module: lay
Description: The plugin framework's editor options page base class
Class hierarchy: EditorOptionsPageBase » QWidget » QObject
Subclasses: EditorOptionsPage
This class is provided as an interface to the base class implementation for various functions. You can use these methods in order to pass down events to the original implementation or access objects not created in script space.
It features some useful methods such as 'view' and provides a slot to call for triggering a data transfer ('edited').
Note that even though the page class is derived from QWidget, you can call QWidget methods but not overload virtual methods from QWidget.
This class has been introduced in version 0.30.4.
| [const] | EditorOptionsPageBase 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. | ||
| void | apply | (Dispatcher ptr dispatcher) | Transfers data from the page to the configuration | |
| void | cancel | Gets called when the Escape key is pressed on a non-modal page | ||
| void | commit | (Dispatcher ptr arg1) | Gets called when the Enter key is pressed on a non-modal page | |
| bool | focus_page | Gets a flag indicating whether the page is a focus page | ||
| void | focus_page= | (bool flag) | Sets a flag indicating whether the page is a focus page | |
| bool | is_focus_page? | Gets a flag indicating whether the page is a focus page | ||
| bool | is_modal_page? | Gets a flag indicating whether the page is a modal page | ||
| bool | is_toolbox_widget? | Gets a flag indicating whether the page is a toolbox widget | ||
| [const] | bool | is_transparent? | Gets a flag indicating whether the widget is transparent | |
| [const] | bool | is_visible? | Gets a flag indicating whether the widget is visible | |
| bool | modal_page | Gets a flag indicating whether the page is a modal page | ||
| void | modal_page= | (bool flag) | Sets a flag indicating whether the page is a modal page | |
| int | order | Gets the order index of the page | ||
| void | setup | (Dispatcher ptr dispatcher) | Transfers data from the configuration to the page | |
| int | show | Shows the page | ||
| string | title | Gets the title string of the page | ||
| bool | toolbox_widget | Gets a flag indicating whether the page is a toolbox widget | ||
| void | toolbox_widget= | (bool flag) | Sets a flag indicating whether the page is a toolbox widget | |
| [const] | bool | transparent | Gets a flag indicating whether the widget is transparent | |
| void | transparent= | (bool flag) | Sets a flag indicating whether the widget is transparent | |
| LayoutView ptr | view | Gets the view object this page is associated with | ||
| [const] | bool | visible | Gets a flag indicating whether the widget is visible | |
| void | visible= | (bool flag) | Sets a flag indicating whether the widget is visible |
_const_cast | Signature: [const] EditorOptionsPageBase 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. | ||
apply | Signature: void apply (Dispatcher ptr dispatcher) Description: Transfers data from the page to the configuration | ||
cancel | Signature: void cancel Description: Gets called when the Escape key is pressed on a non-modal page This method has been introduced in version 0.30.6. | ||
commit | Signature: void commit (Dispatcher ptr arg1) Description: Gets called when the Enter key is pressed on a non-modal page This method has been introduced in version 0.30.6. | ||
focus_page | Signature: bool focus_page Description: Gets a flag indicating whether the page is a focus page See focus_page= for a description is this attribute. The 'focus_page' getter was added in version 0.30.6. Python specific notes: | ||
focus_page= | Signature: void focus_page= (bool flag) Description: Sets a flag indicating whether the page is a focus page The focus page is the page that is selected when the tab key is pressed during some plugin action. By default, this flag is not set. Python specific notes: | ||
is_focus_page? | Signature: bool is_focus_page? Description: Gets a flag indicating whether the page is a focus page See focus_page= for a description is this attribute. The 'focus_page' getter was added in version 0.30.6. Python specific notes: | ||
is_modal_page? | Signature: bool is_modal_page? Description: Gets a flag indicating whether the page is a modal page See modal_page= for a description is this attribute. The 'modal_page' getter was added in version 0.30.6. Python specific notes: | ||
is_toolbox_widget? | Signature: bool is_toolbox_widget? Description: Gets a flag indicating whether the page is a toolbox widget See toolbox_widget= for a description is this attribute. This attribute was added in version 0.30.6. Python specific notes: | ||
is_transparent? | Signature: [const] bool is_transparent? Description: Gets a flag indicating whether the widget is transparent See transparent= for a description is this attribute. This attribute was added in version 0.30.6. Python specific notes: | ||
is_visible? | Signature: [const] bool is_visible? Description: Gets a flag indicating whether the widget is visible See visible= for a description is this attribute. This attribute was added in version 0.30.6. Python specific notes: | ||
modal_page | Signature: bool modal_page Description: Gets a flag indicating whether the page is a modal page See modal_page= for a description is this attribute. The 'modal_page' getter was added in version 0.30.6. Python specific notes: | ||
modal_page= | Signature: void modal_page= (bool flag) Description: Sets a flag indicating whether the page is a modal page A modal page is shown in a modal dialog upon show. Non-modal pages are shown in the editor options dock. By default, this flag is not set. Python specific notes: | ||
order | Signature: int order Description: Gets the order index of the page | ||
setup | Signature: void setup (Dispatcher ptr dispatcher) Description: Transfers data from the configuration to the page | ||
show | Signature: int show Description: Shows the page
Provided the page is selected because the plugin is active, this method will open a dialog to show the page if it is modal, or locate the page in the editor options dock and bring it to the front if it is non-modal. Before the page is shown, setup is called. When the page is dismissed (accepted), apply is called. You can overload these methods to transfer data to and from the configuration space or to perform other actions, not related to configuration parameters. | ||
title | Signature: string title Description: Gets the title string of the page | ||
toolbox_widget | Signature: bool toolbox_widget Description: Gets a flag indicating whether the page is a toolbox widget See toolbox_widget= for a description is this attribute. This attribute was added in version 0.30.6. Python specific notes: | ||
toolbox_widget= | Signature: void toolbox_widget= (bool flag) Description: Sets a flag indicating whether the page is a toolbox widget A toolbox widget is shown at the top of the layout view. It can be made transparent, so the background shows the layout canvas. See transparent= for details. A toolbox widget should also be the focus widget. This way, pressing the Tab key will enter the toolbox widget and enables editing of the widgets there. By default, this flag is not set. This attribute was added in version 0.30.6. Python specific notes: | ||
transparent | Signature: [const] bool transparent Description: Gets a flag indicating whether the widget is transparent See transparent= for a description is this attribute. This attribute was added in version 0.30.6. Python specific notes: | ||
transparent= | Signature: void transparent= (bool flag) Description: Sets a flag indicating whether the widget is transparent A transparent widget is useful for toolbox widgets and makes the layout canvas become visible in parts which are not covered by child widgets of the page. By default, the page is not transparent. This attribute was added in version 0.30.6. Python specific notes: | ||
view | Signature: LayoutView ptr view Description: Gets the view object this page is associated with | ||
visible | Signature: [const] bool visible Description: Gets a flag indicating whether the widget is visible See visible= for a description is this attribute. This attribute was added in version 0.30.6. Python specific notes: | ||
visible= | Signature: void visible= (bool flag) Description: Sets a flag indicating whether the widget is visible Instead of using 'show' and 'hide' or 'isVisible', use this attribute to control whether the page is visible or not. The visibility attribute is useful mainly for conditionally enabling editor option pages based on the status of the plugin. By default, the page is visible. This attribute was added in version 0.30.6. Python specific notes: |