class UIElement

File location: framework/cauldron/framework/inc/core/uimanager.h

Construction

Return type

Description
UIElement ( uint64_t id, UIElementType type, const char* description, const bool& enableControl, bool shown, bool sameLineAsPreviousElement )
Constructor. Creates the UI element.

Methods

Return type

Description

UIElementType
GetType () const
Get the element type.

const char*
GetDesc () const
Get the element description.

void
SetDesc (const char* description)
Set the element type.

bool
Enabled () const
Check if the element is enabled.

bool
SameLine () const
Check if the element is same line.

uint64_t
ID () const
Get the element ID.

bool
IsShown () const
Check the element is shown.

void
Show (bool show)
Show or hide the element.

void
Release ()
Release UIElement.

void
BuildUI () = 0
Build the UI in each UI backend.

Detailed description

Construction

UIElement

Copied!

UIElement (
    uint64_t id,
    UIElementType  type,
    const char* description,
    const bool& enableControl,
    bool shown,
    bool sameLineAsPreviousElement
)

Constructor. Creates the UI element.

Methods

GetType

Copied!

UIElementType  GetType () const

Get the element type.

GetDesc

Copied!

const char* GetDesc () const

Get the element description.

SetDesc

Copied!

void SetDesc (const char* description)

Set the element type.

Enabled

Copied!

bool Enabled () const

Check if the element is enabled.

SameLine

Copied!

bool SameLine () const

Check if the element is same line.

ID

Copied!

uint64_t ID () const

Get the element ID.

IsShown

Copied!

bool IsShown () const

Check the element is shown.

Show

Copied!

void Show (bool show)

Show or hide the element.

Release

Copied!

void Release ()

Release UIElement.

BuildUI

Copied!

virtual void BuildUI () = 0

Build the UI in each UI backend.