KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

KLayout Documentation (Qt 5): Main Index » Class Index » API reference - Class Macro::Format

API reference - Class Macro::Format

Notation used in Ruby API documentation

Module: lay

Description: Specifies the format of a macro

This class is equivalent to the class Macro::Format

This enum has been introduced in version 0.27.5.

Public constructors

new Macro::Format ptrnew(int i)Creates an enum from an integer value
new Macro::Format ptrnew(string s)Creates an enum from a string value

Public methods

[const]bool!=(const Macro::Format other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const Macro::Format other)Returns true if the first enum is less (in the enum symbol order) than the second
[const]bool<(int other)Returns true if the enum is less (in the enum symbol order) than the integer value
[const]bool==(const Macro::Format other)Compares two enums
[const]bool==(int other)Compares an enum with an integer value
[const]inthashGets the hash value from the enum
[const]stringinspectConverts an enum to a visual string
[const]intto_iGets the integer value from the enum
[const]stringto_sGets the symbolic string from an enum

Public static methods and constants

[static,const]Macro::FormatMacroFormatThe macro has macro (XML) format
[static,const]Macro::FormatPlainTextFormatThe macro has plain text format
[static,const]Macro::FormatPlainTextWithHashAnnotationsFormatThe macro has plain text format with special pseudo-comment annotations

Detailed description

!=

(1) Signature: [const] bool != (const Macro::Format other)

Description: Compares two enums for inequality

(2) Signature: [const] bool != (int other)

Description: Compares an enum with an integer for inequality

<

(1) Signature: [const] bool < (const Macro::Format other)

Description: Returns true if the first enum is less (in the enum symbol order) than the second

(2) Signature: [const] bool < (int other)

Description: Returns true if the enum is less (in the enum symbol order) than the integer value

==

(1) Signature: [const] bool == (const Macro::Format other)

Description: Compares two enums

(2) Signature: [const] bool == (int other)

Description: Compares an enum with an integer value

MacroFormat

Signature: [static,const] Macro::Format MacroFormat

Description: The macro has macro (XML) format

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

PlainTextFormat

Signature: [static,const] Macro::Format PlainTextFormat

Description: The macro has plain text format

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

PlainTextWithHashAnnotationsFormat

Signature: [static,const] Macro::Format PlainTextWithHashAnnotationsFormat

Description: The macro has plain text format with special pseudo-comment annotations

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

hash

Signature: [const] int hash

Description: Gets the hash value from the enum

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

inspect

Signature: [const] string inspect

Description: Converts an enum to a visual string

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

new

(1) Signature: [static] new Macro::Format ptr new (int i)

Description: Creates an enum from an integer value

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

(2) Signature: [static] new Macro::Format ptr new (string s)

Description: Creates an enum from a string value

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

to_i

Signature: [const] int to_i

Description: Gets the integer value from the enum

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

to_s

Signature: [const] string to_s

Description: Gets the symbolic string from an enum

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