Notation used in Ruby API documentation
Module: lay
Description: The BrowserDialog's source for "int" URL's
The source object basically acts as a "server" for special URL's using "int" as the scheme. Classes that want to implement such functionality must derive from BrowserSource and reimplement the get method. This method is supposed to deliver a HTML page for the given URL.
Alternatively to implementing this functionality, a source object may be instantiated using the constructor with a HTML code string. This will create a source object that simply displays the given string as the initial and only page.
| new BrowserSource ptr | new | (string html) | Constructs a BrowserSource object with a default HTML string |
| [const] | BrowserSource 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 | assign | (const BrowserSource other) | Assigns another object to self | |
| [const] | new BrowserSource ptr | dup | Creates a copy of self | |
| [virtual] | string | get | (string url) | Gets the HTML code for a given "int" URL. |
| QImage | get_image | (string url) | Gets the image object for a specific URL | |
| string | next_topic | (string url) | Gets the next topic URL from a given URL | |
| string | prev_topic | (string url) | Gets the previous topic URL from a given URL |
| 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 | |
| [static] | new BrowserSource ptr | new_html | (string html) | Use of this method is deprecated. Use new instead |
_const_cast | Signature: [const] BrowserSource 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. |
assign | Signature: void assign (const BrowserSource other) Description: Assigns another object to self |
create | Signature: void create Description: Ensures the C++ object is created Use of this method is deprecated. Use _create instead 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 Use of this method is deprecated. Use _destroy instead 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 Use of this method is deprecated. Use _destroyed? instead 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 BrowserSource ptr dup Description: Creates a copy of self Python specific notes: |
get | Signature: [virtual] string get (string url) Description: Gets the HTML code for a given "int" URL. If this method returns an empty string, the browser will not be set to a new location. This allows implementing any functionality behind such links. If the method returns a string, the content of this string is displayed in the HTML browser page. |
get_image | Signature: QImage get_image (string url) Description: Gets the image object for a specific URL This method has been introduced in version 0.28. |
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 This method returns true, if self is a const reference. In that case, only const methods may be called on self. |
new | Signature: [static] new BrowserSource ptr new (string html) Description: Constructs a BrowserSource object with a default HTML string The default HTML string is sent when no specific implementation is provided. Python specific notes: |
new_html | Signature: [static] new BrowserSource ptr new_html (string html) Description: Constructs a BrowserSource object with a default HTML string Use of this method is deprecated. Use new instead The default HTML string is sent when no specific implementation is provided. Python specific notes: |
next_topic | Signature: string next_topic (string url) Description: Gets the next topic URL from a given URL An empty string will be returned if no next topic is available. This method has been introduced in version 0.28. |
prev_topic | Signature: string prev_topic (string url) Description: Gets the previous topic URL from a given URL An empty string will be returned if no previous topic is available. This method has been introduced in version 0.28. |