BaseCustomGui< plugid > Class Template Reference

#include <customgui_base.h>

Inheritance diagram for BaseCustomGui< plugid >:

Detailed Description

template<Int32 plugid>
class BaseCustomGui< plugid >

The base class for custom GUIs.

Public Member Functions

Int32 GetWidth ()
 
Int32 GetHeight ()
 
void Redraw ()
 
Bool LayoutChanged ()
 
Bool Activate ()
 
Bool SetDefaultForResEdit ()
 
Bool SetData (const TriState< GeData > &tristate)
 
TriState< GeDataGetData ()
 
void SetLayoutMode (Int32 mode)
 
Int32 GetLayoutMode ()
 
Bool SupportLayoutSwitch ()
 
- Public Member Functions inherited from _BaseCustomGui
Int32 GetWidth (Int32 plugid)
 
Int32 GetHeight (Int32 plugid)
 
void Redraw (Int32 plugid)
 
Bool LayoutChanged (Int32 plugid)
 
Bool Activate (Int32 plugid)
 
Bool SetDefaultForResEdit (Int32 plugid)
 
Bool SetData (Int32 plugid, const TriState< GeData > &tristate)
 
TriState< GeDataGetData (Int32 plugid)
 
void SetLayoutMode (Int32 plugid, Int32 mode)
 
Int32 GetLayoutMode (Int32 plugid)
 
Bool SupportLayoutSwitch (Int32 plugid)
 

Private Member Functions

 BaseCustomGui ()
 
 ~BaseCustomGui ()
 

Constructor & Destructor Documentation

◆ BaseCustomGui()

BaseCustomGui ( )
private

◆ ~BaseCustomGui()

~BaseCustomGui ( )
private

Member Function Documentation

◆ GetWidth()

Int32 GetWidth ( )

Retrieves the width of the custom GUI in pixels.

Returns
The width.

◆ GetHeight()

Int32 GetHeight ( )

Retrieves the height of the custom GUI in pixels.

Returns
The height.

◆ Redraw()

void Redraw ( )

Redraws the custom GUI.

◆ LayoutChanged()

Bool LayoutChanged ( )

Tells the custom GUI that the layout has changed.

Returns
true if successful, otherwise false.

◆ Activate()

Bool Activate ( )

Activates the custom GUI.

Returns
true if successful, otherwise false.

◆ SetDefaultForResEdit()

Bool SetDefaultForResEdit ( )

Sets the custom GUI to the resource editor defaults.

Returns
true if successful, otherwise false.

◆ SetData()

Bool SetData ( const TriState< GeData > &  tristate)

Sets the custom GUI data.

Parameters
[in]tristateThe new data.
Returns
true if successful, otherwise false.

◆ GetData()

TriState<GeData> GetData ( )

Retrieves the custom GUI data.

Returns
The current data.

◆ SetLayoutMode()

void SetLayoutMode ( Int32  mode)

Sets the layout mode.

Parameters
[in]modeThe new layout mode: LAYOUTMODE

◆ GetLayoutMode()

Int32 GetLayoutMode ( )

Retrieves the layout mode.

Returns
The current layout mode: LAYOUTMODE

◆ SupportLayoutSwitch()

Bool SupportLayoutSwitch ( )

Checks if the custom GUI supports layout switching.

Returns
true if the layout switch is supported, otherwise false.