Notation used in Ruby API documentation
Module: lay
Description: The plugin framework's configuration page
Class hierarchy: ConfigPage » QFrame » QWidget » QObject
This object provides a way to establish plugin-specific configuration pages.
The only way of communication between the page and the plugin is through configuration parameters. One advantage of this approach is that the current state is automatically persisted. Configuration parameters can be obtained by the plugin directly from the Dispatcher object) or by listening to 'configure' calls.
For the purpose of data transfer, the configuration page has two methods: 'apply' which is supposed to transfer the editor widget's state into configuration parameters. 'setup' does the inverse and transfer configuration parameters into editor widget states. Both methods are called by the system when some transfer is needed.
This class has been introduced in version 0.30.4.
| new ConfigPage ptr | new | (string title) | Creates a new ConfigPage object |
| [const] | ConfigPage 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. | ||
| [virtual] | void | apply | (Dispatcher ptr dispatcher) | Reimplement this method to transfer data from the page to the configuration |
| [virtual] | void | setup | (Dispatcher ptr dispatcher) | Reimplement this method to transfer data from the configuration to the page |
_const_cast | Signature: [const] ConfigPage 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: [virtual] void apply (Dispatcher ptr dispatcher) Description: Reimplement this method to transfer data from the page to the configuration In this method, you should transfer all widget data into corresponding configuration updates. Use Dispatcher#set_config on the dispatcher object ('dispatcher' argument) to set a configuration parameter. | ||
new | Signature: [static] new ConfigPage ptr new (string title) Description: Creates a new ConfigPage object
The title has the form 'Group|Page' - e.g. 'Application|Macro Development IDE' will place the configuration page in the 'Application' group and into the 'Macro Development IDE' page. Python specific notes: | ||
setup | Signature: [virtual] void setup (Dispatcher ptr dispatcher) Description: Reimplement this method to transfer data from the configuration to the page In this method, you should transfer all configuration data to the widgets. Use Dispatcher#get_config on the dispatcher object ('dispatcher' argument) to get a configuration parameter and set the editing widget's state accordingly. |