Notation used in Ruby API documentation
Module: db
Description: A piece of layout meta information
Layout meta information is basically additional data that can be attached to a layout. Layout readers may generate meta information and some writers will add layout information to the layout object. Some writers will also read meta information to determine certain attributes.
Multiple layout meta information objects can be attached to one layout using Layout#add_meta_info. Meta information is identified by a unique name and carries a string value plus an optional description string. The description string is for information only and is not evaluated by code.
See also Layout#each_meta_info and Layout#meta_info_value and Layout#remove_meta_info This class has been introduced in version 0.25.
| new LayoutMetaInfo ptr | new | (string name, string value, string description = ) | Creates a layout meta info object |
| 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 LayoutMetaInfo other) | Assigns another object to self | |
| [const] | string | description | Gets the description of the layout meta info object | |
| void | description= | (string arg1) | Sets the description of the layout meta info object | |
| [const] | new LayoutMetaInfo ptr | dup | Creates a copy of self | |
| [const] | string | name | Gets the name of the layout meta info object | |
| void | name= | (string arg1) | Sets the name of the layout meta info object | |
| [const] | string | value | Gets the value of the layout meta info object | |
| void | value= | (string arg1) | Sets the value of the layout meta info object |
| 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 |
_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 LayoutMetaInfo 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. | ||||||
description | Signature: [const] string description Description: Gets the description of the layout meta info object Python specific notes: | ||||||
description= | Signature: void description= (string arg1) Description: Sets the description of the layout meta info object Python specific notes: | ||||||
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 LayoutMetaInfo ptr dup Description: Creates a copy of self Python specific notes: | ||||||
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. | ||||||
name | Signature: [const] string name Description: Gets the name of the layout meta info object Python specific notes: | ||||||
name= | Signature: void name= (string arg1) Description: Sets the name of the layout meta info object Python specific notes: | ||||||
new | Signature: [static] new LayoutMetaInfo ptr new (string name, string value, string description = ) Description: Creates a layout meta info object
Python specific notes: | ||||||
value | Signature: [const] string value Description: Gets the value of the layout meta info object Python specific notes: | ||||||
value= | Signature: void value= (string arg1) Description: Sets the value of the layout meta info object Python specific notes: |