Class LoadLayoutOptions (version 0.18)

Description: Layout reader options

This object describes various layer reader options used for loading layouts.

This class has been introduced in version 0.18.

Class overview

Index

Method Overview

set_layer_map( LayerMap map, bool create_other_layers )	Set a layer map
select_all_layers	Select all layers
ref LayerMap layer_map	Access to the layer map member.
[const] bool is_creating_other_layers?	Tell whether other layers should be created.
create_other_layers=( bool create )	Specifies whether other layers should be created.
[const] bool is_text_enabled?	Tell whether text objects should be read.
text_enabled=( bool enabled )	Specifies whether text objects should be read.
[const] bool is_properties_enabled?	Tell whether properties should be read.
properties_enabled=( bool enabled )	Specifies whether properties should be read.
assign( LoadLayoutOptions other )	Assign the contents of another object to self
[const] LoadLayoutOptions dup	Creates a copy of self.
destroy	Explicitly destroy the object
[const] bool destroyed	Tell, if the object was destroyed

assign( LoadLayoutOptions other )

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

create_other_layers=( bool create )

Description: Specifies whether other layers should be created.

create:

True, if other layers should be created.

destroy

Description: 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 destroyed

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

[const] LoadLayoutOptions dup

Description: Creates a copy of self.

[const] bool is_creating_other_layers?

Description: Tell whether other layers should be created.

returns:

True, if other layers should be created.

[const] bool is_properties_enabled?

Description: Tell whether properties should be read.

returns:

True, if properties should be read.

[const] bool is_text_enabled?

Description: Tell whether text objects should be read.

returns:

True, if text objects should be read.

ref LayerMap layer_map

Description: Access to the layer map member.

returns:

The layer map.

properties_enabled=( bool enabled )

Description: Specifies whether properties should be read.

enabled:

True, if properties should be read.

select_all_layers

Description: Select all layers

This disables any layer map and enables reading of all layers while new layers will be created when required.

set_layer_map( LayerMap map, bool create_other_layers )

Description: Set a layer map

This sets a layer mapping for the reader. The "create_other_layers" specifies whether to create layers that are not in the mapping and automatically assign layers to them.

create_other_layers:

The flag telling whether other layer should be created also. Set to false if just the layers in the mapping table should be read.

text_enabled=( bool enabled )

Description: Specifies whether text objects should be read.

enabled:

True, if text objects should be read.