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

KLayout Documentation (Qt 5): Main Index » Class Index » API reference - Class PCellParameterState::ParameterStateIcon

API reference - Class PCellParameterState::ParameterStateIcon

Notation used in Ruby API documentation

Module: db

Description: This enum specifies the icon shown next to the parameter in PCell parameter list.

This class is equivalent to the class PCellParameterState::ParameterStateIcon

This enum was introduced in version 0.28.

Public constructors

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

Public methods

[const]bool!=(const PCellParameterState::ParameterStateIcon other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const PCellParameterState::ParameterStateIcon 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 PCellParameterState::ParameterStateIcon 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]PCellParameterState::ParameterStateIconErrorIconAn icon indicating an error is shown
[static,const]PCellParameterState::ParameterStateIconInfoIconA general 'information' icon is shown
[static,const]PCellParameterState::ParameterStateIconNoIconNo icon is shown for the parameter
[static,const]PCellParameterState::ParameterStateIconWarningIconAn icon indicating a warning is shown

Detailed description

!=

(1) Signature: [const] bool != (const PCellParameterState::ParameterStateIcon 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 PCellParameterState::ParameterStateIcon 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 PCellParameterState::ParameterStateIcon other)

Description: Compares two enums

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

Description: Compares an enum with an integer value

ErrorIcon

Signature: [static,const] PCellParameterState::ParameterStateIcon ErrorIcon

Description: An icon indicating an error is shown

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

InfoIcon

Signature: [static,const] PCellParameterState::ParameterStateIcon InfoIcon

Description: A general 'information' icon is shown

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

NoIcon

Signature: [static,const] PCellParameterState::ParameterStateIcon NoIcon

Description: No icon is shown for the parameter

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

WarningIcon

Signature: [static,const] PCellParameterState::ParameterStateIcon WarningIcon

Description: An icon indicating a warning is shown

Python specific notes:
The object exposes a readable attribute 'WarningIcon'. 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 PCellParameterState::ParameterStateIcon 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 PCellParameterState::ParameterStateIcon 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)'.