BaseCustomGui< plugid > Class Template Reference

#include <customgui_base.h>

Inheritance diagram for BaseCustomGui< plugid >:

详细描述

template<Int32 plugid>
class BaseCustomGui< plugid >

The base class for custom GUIs.

公共成员函数

Int32   GetWidth ()
Int32   GetHeight ()
void  Redraw ()
Bool   LayoutChanged ()
Bool   激活 ()
Bool   SetDefaultForResEdit ()
Bool   SetData (const TriState < GeData > &tristate)
TriState < GeData GetData ()
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   激活 ( Int32 plugid)
Bool   SetDefaultForResEdit ( Int32 plugid)
Bool   SetData ( Int32 plugid, const TriState < GeData > &tristate)
TriState < GeData GetData ( Int32 plugid)
void  SetLayoutMode ( Int32 plugid, Int32 mode)
Int32   GetLayoutMode ( Int32 plugid)
Bool   SupportLayoutSwitch ( Int32 plugid)

私有成员函数

  BaseCustomGui ()
  ~BaseCustomGui ()

构造函数 & 析构函数文档编制

◆  BaseCustomGui()

BaseCustomGui () private

◆  ~BaseCustomGui()

~ BaseCustomGui () private

成员函数文档编制

◆  GetWidth()

Int32 GetWidth ( )

Retrieves the width of the custom GUI in pixels.

返回
The width.

◆  GetHeight()

Int32 GetHeight ( )

Retrieves the height of the custom GUI in pixels.

返回
The height.

◆  Redraw()

void Redraw ( )

Redraws the custom GUI.

◆  LayoutChanged()

Bool LayoutChanged ( )

Tells the custom GUI that the layout has changed.

返回
true if successful, otherwise false .

◆  Activate()

Bool 激活 ( )

Activates the custom GUI.

返回
true if successful, otherwise false .

◆  SetDefaultForResEdit()

Bool SetDefaultForResEdit ( )

Sets the custom GUI to the resource editor defaults.

返回
true if successful, otherwise false .

◆  SetData()

Bool SetData ( const TriState < GeData > &  tristate )

Sets the custom GUI data.

参数
[in] tristate The new data.
返回
true if successful, otherwise false .

◆  GetData()

TriState < GeData > GetData ( )

Retrieves the custom GUI data.

返回
The current data.

◆  SetLayoutMode()

void SetLayoutMode ( Int32   mode )

Sets the layout mode .

参数
[in] mode The new layout mode: LAYOUTMODE

◆  GetLayoutMode()

Int32 GetLayoutMode ( )

Retrieves the layout mode.

返回
The current layout mode: LAYOUTMODE

◆  SupportLayoutSwitch()

Bool SupportLayoutSwitch ( )

Checks if the custom GUI supports layout switching.

返回
true if the layout switch is supported, otherwise false .