Kanzi 3.9.10
Node2DEnums.ForegroundHint Enum Reference

Hint for foreground handling of nodes. More...

Inheritance diagram for Node2DEnums.ForegroundHint:
[legend]

Public Member Functions

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

Public Attributes

 None =(0)
 No hint given, assumed the background of a node can be rendered after content.
 
 Opaque =(2)
 Node content is assumed to be fully opaque, meaning that there is no need to render the background.
 
 Translucent =(1)
 Some elements rendered within the node are translucent over the background.
 

Detailed Description

Hint for foreground handling of nodes.

Constructor & Destructor Documentation

◆ ForegroundHint() [1/2]

ForegroundHint ( int value)

Constructs a ForegroundHint of an integer value.

Parameters
valueInteger value to convert to enumeration constant.

◆ ForegroundHint() [2/2]

Constructs a copy of a ForegroundHint object.

Parameters
enum_ForegroundHint 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 ForegroundHint 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 ForegroundHint 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.