API reference - Class LayoutMetaInfo

Notation used in Ruby API documentation

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. 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.

Public constructors

new LayoutMetaInfo ptrnew(string name,
string value,
string description = )
Creates a layout meta info object

Public methods

void_createEnsures the C++ object is created
void_destroyExplicitly 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_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidassign(const LayoutMetaInfo other)Assigns another object to self
[const]stringdescriptionGets the description of the layout meta info object
voiddescription=(string arg1)Sets the description of the layout meta info object
[const]new LayoutMetaInfo ptrdupCreates a copy of self
[const]stringnameGets the name of the layout meta info object
voidname=(string arg1)Sets the name of the layout meta info object
[const]stringvalueGets the value of the layout meta info object
voidvalue=(string arg1)Sets the value of the layout meta info object

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_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.

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

description

Signature: [const] string description

Description: Gets the description of the layout meta info object

Python specific notes:
The object exposes a readable attribute 'description'. This is the getter.

description=

Signature: void description= (string arg1)

Description: Sets the description of the layout meta info object

Python specific notes:
The object exposes a writable attribute 'description'. This is the setter.

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

dup

Signature: [const] new LayoutMetaInfo 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

Use of this method is deprecated. Use _is_const_object? instead

name

Signature: [const] string name

Description: Gets the name of the layout meta info object

Python specific notes:
The object exposes a readable attribute 'name'. This is the getter.

name=

Signature: void name= (string arg1)

Description: Sets the name of the layout meta info object

Python specific notes:
The object exposes a writable attribute 'name'. This is the setter.

new

Signature: [static] new LayoutMetaInfo ptr new (string name,string value,string description = )

Description: Creates a layout meta info object

name:The name
value:The value
description:An optional description text

Python specific notes:
This method is the default initializer of the object

value

Signature: [const] string value

Description: Gets the value of the layout meta info object

Python specific notes:
The object exposes a readable attribute 'value'. This is the getter.

value=

Signature: void value= (string arg1)

Description: Sets the value of the layout meta info object

Python specific notes:
The object exposes a writable attribute 'value'. This is the setter.