Kanzi 3.9.10
TextFormatEnums.Truncation Enum Reference

Type of truncation boundary for the text that does not fit in the available space. More...

Inheritance diagram for TextFormatEnums.Truncation:
[legend]

Public Member Functions

 Truncation (int value)
 Constructs a Truncation of an integer value.
 
 Truncation (Truncation enum_)
 Constructs a copy of a Truncation object.
 
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 Truncation swigToEnum (int swigValue)
 Converts an integer value to the matching enumeration constant.
 
static Truncation toEnum (int value)
 Converts an integer value to the matching enumeration constant.
 

Public Attributes

 AtCharacter =(1)
 Truncate text character by character.
 
 AtWord =(2)
 Truncate text by entire words.
 
 None =(0)
 Disable truncation.
 

Detailed Description

Type of truncation boundary for the text that does not fit in the available space.

Constructor & Destructor Documentation

◆ Truncation() [1/2]

Truncation ( int value)

Constructs a Truncation of an integer value.

Parameters
valueInteger value to convert to enumeration constant.

◆ Truncation() [2/2]

Constructs a copy of a Truncation object.

Parameters
enum_Truncation 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 Truncation 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 Truncation 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.