Guiliani  Version 2.6 revision 7293 (documentation build 12)
CGUICommonEnums Class Reference

#include <GUICommonEnums.h>

Public Types

enum  Alignment_t { ALIGN_TOP , ALIGN_BOTTOM , ALIGN_LEFT , ALIGN_RIGHT }
 Position of control. More...
 
enum  AttributeType {
  AT_BYTE , AT_UBYTE , AT_INT , AT_UINT ,
  AT_HEX , AT_SHORT , AT_USHORT , AT_FLOAT ,
  AT_BOOL , AT_STRING , AT_OBJECTID , AT_IMAGEID ,
  AT_TEXTID , AT_FONTID , AT_SOUNDID , AT_GENRESID ,
  AT_DATAPOOLID , AT_COMMENT , AT_COLOR , AT_COLORID ,
  AT_PROPERTYID , AT_ANIMATION_CHAIN_ID
}
 The possible types of attributes. More...
 
enum  AxisAlignment_t { AA_NONE , AA_HORIZONTAL , AA_VERTICAL , AA_BOTH }
 Axis-alignment for freedom of control. More...
 
enum  AxisStyle_t { AS_LINEAR , AS_LOGARITHMIC }
 Axis-types for displaying values. More...
 
enum  FontWrapper_t { FREETYPE , GLYPHLIB }
 Emumerations for Font-Wrappers. More...
 
enum  GraphicsWrapper_t {
  BLU , EGML , DAVE , OGL ,
  OGLES
}
 Enumeration for Graphics-Wrappers. More...
 
enum  ImageType_t {
  IMAGE_FORMAT = 0 , ALPHA_8 = 1 << 24 , ALPHA_4 , LUM_8 ,
  LUM_4 , RGB_565 = 2 << 24 , BGR_565 , ABGR_4444 ,
  BGRA_4444 , RGB_565_A8 , ARGB_4444 , RGBA_4444 ,
  RGB_888 = 3 << 24 , BGR_888 , ARGB_8888 = 4 << 24 , ABGR_8888 ,
  RGBA_8888 , BGRA_8888 , RGB_8888
}
 
enum  Orientation_t { OR_HORIZONTAL , OR_VERTICAL }
 orientation of controls More...
 
enum  Rotation_t { RO_0 , RO_90 , RO_180 , RO_270 }
 Enumaration for Rotation. More...
 

Static Public Member Functions

static eC_Bool HasHorizontal (const AxisAlignment_t &eAlignment)
 
static eC_Bool HasVertical (const AxisAlignment_t &eAlignment)
 

Detailed Description

This class collects various enumerations which are common to multiple controls.

Member Enumeration Documentation

◆ Alignment_t

Position of control.

Enumerator
ALIGN_TOP 

aligned to top

ALIGN_BOTTOM 

aligned to bottom

ALIGN_LEFT 

aligned left

ALIGN_RIGHT 

aligned right

◆ AttributeType

The possible types of attributes.

Enumerator
AT_BYTE 

8-bit value

AT_UBYTE 

unsigned 8-bit value

AT_INT 

integer value

AT_UINT 

unsigned integer value

AT_HEX 

Integer value, formatted in hex.

AT_SHORT 

Short integer value.

AT_USHORT 

unsigned short integer value

AT_FLOAT 

Float value.

AT_BOOL 

Boolean value.

AT_STRING 

String.

AT_OBJECTID 

Object handle (ID).

AT_IMAGEID 

Image ID.

AT_TEXTID 

Text ID.

AT_FONTID 

Font ID.

AT_SOUNDID 

Sound ID.

AT_GENRESID 

General resource ID.

AT_DATAPOOLID 

DataPool resource ID.

AT_COMMENT 

Comment (for XML comment tags without values).

AT_COLOR 

Colors in hex notation.

AT_COLORID 

Color ID.

AT_PROPERTYID 

Property ID.

AT_ANIMATION_CHAIN_ID 

Animation Chain ID.

◆ AxisAlignment_t

Axis-alignment for freedom of control.

Enumerator
AA_NONE 

not aligned

AA_HORIZONTAL 

horizontal

AA_VERTICAL 

vertical

AA_BOTH 

horizontal + vertical

◆ AxisStyle_t

Axis-types for displaying values.

Enumerator
AS_LINEAR 

linear

AS_LOGARITHMIC 

logarithmic

◆ FontWrapper_t

Emumerations for Font-Wrappers.

Enumerator
FREETYPE 

FreeType.

GLYPHLIB 

GlyphLib.

◆ GraphicsWrapper_t

Enumeration for Graphics-Wrappers.

Enumerator
BLU 

BLU.

EGML 

eGML

DAVE 

DAVE.

OGL 

OpenGL.

OGLES 

OpenGL ES.

◆ ImageType_t

Enumeration ImageType_t for the loaded format.
A = alpha, R = red, G = green, B = blue. The order of the letters in the abbreviation defines the order of a pixel. The number means the number of bits of each color channel.
For example: RGBA_8888 means Red, Green, Blue, Alpha and every channel has 8 bits. So the whole pixel has 32 bits. Red has the most significant bit and alpha the least significant bits. The order is considered big endian so bytewise read, it forms 0xAA 0xRR 0xGG 0xBB. NOTE: when using DWORD as datatype the oder may be inverse depending on endianess.

◆ Orientation_t

orientation of controls

Enumerator
OR_HORIZONTAL 

horizontal orientation

OR_VERTICAL 

vertical orientation

◆ Rotation_t

Enumaration for Rotation.

Enumerator
RO_0 

0 degrees

RO_90 

90 degrees

RO_180 

180 degrees

RO_270 

270 degrees

Member Function Documentation

◆ HasHorizontal()

static eC_Bool CGUICommonEnums::HasHorizontal ( const AxisAlignment_t eAlignment)
inlinestatic

Check if direction has horizonal part

Parameters
eAlignmentalignment to check
Returns
true if horizontal part is present

◆ HasVertical()

static eC_Bool CGUICommonEnums::HasVertical ( const AxisAlignment_t eAlignment)
inlinestatic

Check if direction has vertical part

Parameters
eAlignmentalignment to check
Returns
true if vertical part is present

The documentation for this class was generated from the following file: