API reference - Class PluginRoot
Notation used in Ruby API documentation
Description: Root of the configuration space in the plugin context
- Public constructors
- Public methods
- Public static methods and constants
- Deprecated methods (protected, public, static, non-static and constructors)
- Detailed description
This class provides access to the root configuration space in the context of plugin programming. You can use this class to obtain configuration parameters from the configuration tree during plugin initialization. However, the preferred way of plugin configuration is through Plugin#configure.
Currently, the application object provides an identical entry point for configuration modification. For example, "Application::instance.set_config" is identical to "PluginRoot::instance.set_config". Hence there is little motivation for the PluginRoot class currently and this interface may be modified or removed in the future.
This class has been introduced in version 0.25.
Public constructors
| new PluginRoot ptr | new | Creates a new object of this class |
Public methods
| 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 | clear_config | Clears the configuration parameters | ||
| void | commit_config | Commits the configuration settings | ||
| variant | get_config | (string name) | Gets the value of a local configuration parameter | |
| string[] | get_config_names | Gets the configuration parameter names | ||
| bool | read_config | (string file_name) | Reads the configuration from a file | |
| void | set_config | (string name, string value) | Set a local configuration parameter with the given name to the given value | |
| bool | write_config | (string file_name) | Writes configuration to a file |
Public static methods and constants
| PluginRoot ptr | instance | Gets the singleton instance of the PluginRoot object |
Deprecated methods (protected, public, static, non-static and constructors)
| void | create | Use of this method is deprecated. Use _create instead | ||
| void | destroy | Use of this method is deprecated. Use _destroy instead | ||
| [const] | bool | destroyed? | Use of this method is deprecated. Use _destroyed? instead | |
| [const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead |
Detailed description
_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. | ||||
clear_config | Signature: void clear_config Description: Clears the configuration parameters | ||||
commit_config | Signature: void commit_config Description: Commits the configuration settings Some configuration options are queued for performance reasons and become active only after 'commit_config' has been called. After a sequence of set_config calls, this method should be called to activate the settings made by these calls. | ||||
create | Signature: void create Description: Ensures the C++ object is created Use of this method is deprecated. Use _create instead | ||||
destroy | Signature: void destroy Description: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead | ||||
destroyed? | Signature: [const] bool destroyed? Description: Returns a value indicating whether the object was already destroyed Use of this method is deprecated. Use _destroyed? instead | ||||
get_config | Signature: variant get_config (string name) Description: Gets the value of a local configuration parameter
| ||||
get_config_names | Signature: string[] get_config_names Description: Gets the configuration parameter names
This method returns the names of all known configuration parameters. These names can be used to get and set configuration parameter values. | ||||
instance | Signature: [static] PluginRoot ptr instance Description: Gets the singleton instance of the PluginRoot object
| ||||
is_const_object? | Signature: [const] bool is_const_object? Description: Returns a value indicating whether the reference is a const reference Use of this method is deprecated. Use _is_const_object? instead | ||||
new | Signature: [static] new PluginRoot ptr new Description: Creates a new object of this class Python specific notes: | ||||
read_config | Signature: bool read_config (string file_name) Description: Reads the configuration from a file
This method siletly does nothing, if the config file does not exist. If it does and an error occured, the error message is printed on stderr. In both cases, false is returned. | ||||
set_config | Signature: void set_config (string name,string value) Description: Set a local configuration parameter with the given name to the given value
This method sets a configuration parameter with the given name to the given value. Values can only be strings. Numerical values have to be converted into strings first. Local configuration parameters override global configurations for this specific view. This allows for example to override global settings of background colors. Any local settings are not written to the configuration file. | ||||
write_config | Signature: bool write_config (string file_name) Description: Writes configuration to a file
If the configuration file cannot be written, false is returned but no exception is thrown. |