Notation used in Ruby API documentation
Module: lay
Description: A BrowserSource implementation delivering the help text for the help dialog
Class hierarchy: HelpSource » BrowserSource
This class can be used together with a BrowserPanel or BrowserDialog object to implement custom help systems.
The basic URL's served by this class are: "int:/index.xml" for the index page and "int:/search.xml?string=..." for the search topic retrieval.
This class has been added in version 0.25.
| void | _assign | (const HelpSource other) | Assigns another object to self | |
| [const] | HelpSource 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] | new HelpSource ptr | _dup | Creates a copy of self | |
| [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. | ||
| QDomDocument | get_dom | (string path) | Reserved for internal use | |
| [const] | variant | get_option | (string key) | Reserved for internal use |
| string | parent_of | (string path) | Reserved internal use | |
| void | scan | Reserved internal use | ||
| void | set_option | (string key, variant value) | Reserved for internal use | |
| string | title_for | (string path) | Reserved internal use | |
| string[] | urls | Reserved for internal use |
| void | create_index_file | (string path) | Reserved internal use | |
| new HelpSource ptr | plain | Reserved for internal use |
_assign | Signature: void _assign (const HelpSource other) Description: Assigns another object to self |
_const_cast | Signature: [const] HelpSource 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. |
_dup | Signature: [const] new HelpSource ptr _dup Description: Creates a copy of self |
_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. |
create_index_file | Signature: [static] void create_index_file (string path) Description: Reserved internal use |
get_dom | Signature: QDomDocument get_dom (string path) Description: Reserved for internal use |
get_option | Signature: [const] variant get_option (string key) Description: Reserved for internal use |
parent_of | Signature: string parent_of (string path) Description: Reserved internal use |
plain | Signature: [static] new HelpSource ptr plain Description: Reserved for internal use |
scan | Signature: void scan Description: Reserved internal use |
set_option | Signature: void set_option (string key, variant value) Description: Reserved for internal use |
title_for | Signature: string title_for (string path) Description: Reserved internal use |
urls | Signature: string[] urls Description: Reserved for internal use |