Kanzi 3.9.10
TextBoxConceptEnums.EditMode Enum Reference

The edit modes. More...

Inheritance diagram for TextBoxConceptEnums.EditMode:
[legend]

Public Member Functions

 EditMode (EditMode enum_)
 Constructs a copy of a EditMode object.
 
 EditMode (int value)
 Constructs a EditMode of an integer value.
 
int getValue ()
 Returns the integer value of the enumeration constant.
 
final int swigValue ()
 Returns the integer value of the enumeration constant.
 

Static Public Member Functions

static EditMode swigToEnum (int swigValue)
 Converts an integer value to the matching enumeration constant.
 
static EditMode toEnum (int value)
 Converts an integer value to the matching enumeration constant.
 

Public Attributes

 Automatic =(0)
 A Text Box node enters the editing state when the node gets the focus, and leaves the editing state
when the node loses the focus.
 
 Triggered =(1)
 A Text Box enters the editing state on a trigger, and remains in this state until another trigger
makes the node leave the editing state.
 

Detailed Description

The edit modes.

Constructor & Destructor Documentation

◆ EditMode() [1/2]

EditMode ( int value)

Constructs a EditMode of an integer value.

Parameters
valueInteger value to convert to enumeration constant.

◆ EditMode() [2/2]

EditMode ( EditMode enum_)

Constructs a copy of a EditMode object.

Parameters
enum_EditMode to be copy constructed.

Member Function Documentation

◆ getValue()

int getValue ( )

Returns the integer value of the enumeration constant.

Returns
Integer value.

Implements Enum.

◆ swigToEnum()

static EditMode swigToEnum ( int swigValue)
static

Converts an integer value to the matching enumeration constant.

Used internally by SWIG generated code.

Parameters
swigValueInteger value to convert to enumeration constant.
Returns
Enumeration constant matching the integer value.

◆ swigValue()

final int swigValue ( )

Returns the integer value of the enumeration constant.

Used internally by SWIG generated code.

Returns
Integer value.

◆ toEnum()

static EditMode toEnum ( int value)
static

Converts an integer value to the matching enumeration constant.

Parameters
valueInteger value to convert to enumeration constant.
Returns
Enumeration constant matching the integer value.

Member Data Documentation

◆ Triggered

Triggered =(1)

A Text Box enters the editing state on a trigger, and remains in this state until another trigger
makes the node leave the editing state.

To enter the editing state use the EnterEditingStateMessage
message or the TextBoxConceptImpl::enterEditingState() method. To leave the editing state use the
LeaveEditingStateMessage message or the TextBoxConceptImpl::leaveEditingState() method.