Class Application (version 0.18)Description: The application object The application object is the main port from which to access all the internals of the application, in particular the main window.
Method Overview
destroyDescription: Explicitly destroy the object Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing.
[const] bool destroyedDescription: Tell, if the object was 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.
int execDescription: Execute the application's main loop This method must be called in order to execute the application in the main script if a script is provided.
[const] string get_config( string name )Description: Query a configuration parameter This method returns the value of the given configuration parameter. If the parameter is not known, an exception will be thrown. Use get_config_names to obtain a list of all configuration parameter names available. Configuration parameters are always stored as strings. The actual format of this string is specific to the configuration parameter. The values delivered by this method correspond to the values stored in the configuration file
[const] string[ ] get_config_namesDescription: Query 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.
[const] string inst_pathDescription: Return the application's installation path (where the executable is located) This method has been added in version 0.18.
[static] ref Application instanceDescription: Return the singleton instance of the application There is exactly one instance of the application. This instance can be obtained with this method.
[const] bool is_editable?Description: Return true if the application is in editable mode
[const] ref MainWindow main_windowDescription: Return a reference to the main window
process_eventsDescription: Process pending events This method processes pending events and dispatches them internally. Calling this method periodically during a long operation keeps the application 'alive'
bool read_config( string file_name )Description: Read 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( string name, string value )Description: Set a configuration parameter with the given name to the given value This method sets the configuration parameter with the given name to the given value. Values can only be strings. Numerical values have to be converted into strings first. The actual format of the value depends on the configuration parameter. The name must be one of the names returned by get_config_names.
[const] string versionDescription: Return the application's version string
bool write_config( string file_name )Description: Write configuration to a file If the configuration file cannot be written, is returned but no exception is thrown.
|