API reference - Class Text

!=

Signature: [const] bool != (const Text text)

Description: Inequality

Return true, if this text object and the given text are not equal

<

Signature: [const] bool < (const Text t)

Description: Less operator

This operator is provided to establish some, not necessarily a certain sorting order

==

Signature: [const] bool == (const Text text)

Description: Equality

Return true, if this text object and the given text are equal

HAlignCenter

Signature: [static,const] HAlign HAlignCenter

Description: Centered horizontal alignment

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

HAlignLeft

Signature: [static,const] HAlign HAlignLeft

Description: Left horizontal alignment

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

HAlignRight

Signature: [static,const] HAlign HAlignRight

Description: Right horizontal alignment

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

NoHAlign

Signature: [static,const] HAlign NoHAlign

Description: Undefined horizontal alignment

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

NoVAlign

Signature: [static,const] VAlign NoVAlign

Description: Undefined vertical alignment

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

VAlignBottom

Signature: [static,const] VAlign VAlignBottom

Description: Bottom vertical alignment

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

VAlignCenter

Signature: [static,const] VAlign VAlignCenter

Description: Centered vertical alignment

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

VAlignTop

Signature: [static,const] VAlign VAlignTop

Description: Top vertical alignment

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

_const_cast

Signature: [const] Text 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 Text other)

Description: Assigns another object to self

bbox

Signature: [const] Box bbox

Description: Gets the bounding box of the text

The bounding box of the text is a single point - the location of the text. Both points of the box are identical.

This method has been added in version 0.28.

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 Text ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

font

Signature: [const] int font

Description: Gets the font number

See font= for a description of this property.

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

font=

Signature: void font= (int f)

Description: Sets the font number

The font number does not play a role for KLayout. This property is provided for compatibility with other systems which allow using different fonts for the text objects.

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

from_s

Signature: [static] new Text ptr from_s (string s)

Description: Creates an object from a string

Creates the object from a string representation (as returned by to_s)

This method has been added in version 0.23.

halign

Signature: [const] HAlign halign

Description: Gets the horizontal alignment

See halign= for a description of this property.

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

halign=

(1) Signature: void halign= (int a)

Description: Sets the horizontal alignment

Use of this method is deprecated

This is the version accepting integer values. It's provided for backward compatibility.

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

(2) Signature: void halign= (HAlign a)

Description: Sets the horizontal alignment

This property specifies how the text is aligned relative to the anchor point. This property has been introduced in version 0.22 and extended to enums in 0.28.

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

hash

Signature: [const] unsigned long hash

Description: Computes a hash value

Returns a hash value for the given text object. This method enables texts as hash keys.

This method has been introduced in version 0.25.

Python specific notes:
This method is also available as 'hash(object)'.

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.

move

(1) Signature: Text move (const Vector distance)

Description: Moves the text by a certain distance (modifies self)

Moves the text by a given offset and returns the moved text. Does not check for coordinate overflows.

(2) Signature: Text move (int dx, int dy)

Description: Moves the text by a certain distance (modifies self)

Moves the text by a given distance in x and y direction and returns the moved text. Does not check for coordinate overflows.

This method was introduced in version 0.23.

moved

(1) Signature: [const] Text moved (const Vector distance)

Description: Returns the text moved by a certain distance (does not modify self)

Moves the text by a given offset and returns the moved text. Does not modify *this. Does not check for coordinate overflows.

(2) Signature: [const] Text moved (int dx, int dy)

Description: Returns the text moved by a certain distance (does not modify self)

Moves the text by a given offset and returns the moved text. Does not modify *this. Does not check for coordinate overflows.

This method was introduced in version 0.23.

new

(1) Signature: [static] new Text ptr new (const DText dtext)

Description: Creates an integer coordinate text from a floating-point coordinate text

This constructor has been introduced in version 0.25 and replaces the previous static method 'from_dtext'.

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

(2) Signature: [static] new Text ptr new

Description: Default constructor

Creates a text with unit transformation and empty text.

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

(3) Signature: [static] new Text ptr new (string string, const Trans trans)

Description: Constructor with string and transformation

A string and a transformation is provided to this constructor. The transformation specifies the location and orientation of the text object.

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

(4) Signature: [static] new Text ptr new (string string, int x, int y)

Description: Constructor with string and location

A string and a location is provided to this constructor. The location is specifies as a pair of x and y coordinates.

This method has been introduced in version 0.23.

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

(5) Signature: [static] new Text ptr new (string string, const Trans trans, int height, int font)

Description: Constructor with string, transformation, text height and font

A string and a transformation is provided to this constructor. The transformation specifies the location and orientation of the text object. In addition, the text height and font can be specified.

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

position

Signature: [const] Point position

Description: Gets the position of the text

This convenience method has been added in version 0.28.

size

Signature: [const] int size

Description: Gets the text height

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

size=

Signature: void size= (int s)

Description: Sets the text height of this object

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

string

Signature: [const] string string

Description: Get the text string

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

string=

Signature: void string= (string text)

Description: Assign a text string to this object

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

to_dtype

Signature: [const] DText to_dtype (double dbu = 1)

Description: Converts the text to a floating-point coordinate text

The database unit can be specified to translate the integer-coordinate text into a floating-point coordinate text in micron units. The database unit is basically a scaling factor.

This method has been introduced in version 0.25.

to_s

Signature: [const] string to_s (double dbu = 0)

Description: Converts the object to a string.

If a DBU is given, the output units will be micrometers.

The DBU argument has been added in version 0.27.6.

Python specific notes:
This method is also available as 'str(object)'.

trans

Signature: [const] Trans trans

Description: Gets the transformation

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

trans=

Signature: void trans= (const Trans t)

Description: Assign a transformation (text position and orientation) to this object

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

transformed

(1) Signature: [const] Text transformed (const ICplxTrans t)

Description: Transform the text with the given complex transformation

This method has been introduced in version 0.18.

(2) Signature: [const] Text transformed (const Trans t)

Description: Transforms the text with the given simple transformation

(3) Signature: [const] DText transformed (const CplxTrans t)

Description: Transforms the text with the given complex transformation

valign

Signature: [const] VAlign valign

Description: Gets the vertical alignment

See valign= for a description of this property.

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

valign=

(1) Signature: void valign= (int a)

Description: Sets the vertical alignment

Use of this method is deprecated

This is the version accepting integer values. It's provided for backward compatibility.

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

(2) Signature: void valign= (VAlign a)

Description: Sets the vertical alignment

This property specifies how the text is aligned relative to the anchor point. This property has been introduced in version 0.22 and extended to enums in 0.28.

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

x

Signature: [const] int x

Description: Gets the x location of the text

This method has been introduced in version 0.23.

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

x=

Signature: void x= (int x)

Description: Sets the x location of the text

This method has been introduced in version 0.23.

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

y

Signature: [const] int y

Description: Gets the y location of the text

This method has been introduced in version 0.23.

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

y=

Signature: void y= (int y)

Description: Sets the y location of the text

This method has been introduced in version 0.23.

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