Nuclide
Software Development Kit for id Tech
VGUIButton Class Reference
Inheritance diagram for VGUIButton:
VGUIControl

Public Member Functions

void VGUIButton (void)
 
nonvirtual void SetTitle (string)
 Sets the title of the button. More...
 
nonvirtual void SetIcon (string)
 Sets the icon of the button. More...
 
nonvirtual void SetColor (vector)
 Sets the color of the button text. More...
 
nonvirtual void SetIconColor (vector)
 Sets the color of the icon on the button. More...
 
nonvirtual void SetKeyEquivalent (string)
 Sets the key to be pressed to order to simulate a click event. More...
 
nonvirtual string GetKeyEquivalent (void)
 Returns the key to be pressed in order to simulate a click event. More...
 
nonvirtual string GetTitle (void)
 Gets the title of the button. More...
 
nonvirtual void SetFunc (void(void))
 Sets the function to call when the button is pressed. More...
 
nonvirtual void SetExec (string)
 Sets the command to execute when the button is pressed. More...
 
virtual void Draw (void)
 Called in order to draw the widget. More...
 
virtual bool Input (float, float, float, float)
 Called whenever an input event gets directed to the widget. More...
 
virtual void Spawned (void)
 Called when the widget has fully initialized. More...
 

Constructor & Destructor Documentation

◆ VGUIButton()

void VGUIButton::VGUIButton ( void  )

Member Function Documentation

◆ Draw()

void VGUIButton::Draw ( void  )
virtual

Called in order to draw the widget.

Reimplemented from VGUIWidget.

◆ GetKeyEquivalent()

string VGUIButton::GetKeyEquivalent ( void  )

Returns the key to be pressed in order to simulate a click event.

◆ GetTitle()

string VGUIButton::GetTitle ( void  )

Gets the title of the button.

◆ Input()

bool VGUIButton::Input ( float  flEVType,
float  flKey,
float  flChar,
float  flDevID 
)
virtual

Called whenever an input event gets directed to the widget.

Reimplemented from VGUIWidget.

◆ SetColor()

void VGUIButton::SetColor ( vector  vecColor)

Sets the color of the button text.

◆ SetExec()

void VGUIButton::SetExec ( string  exe)

Sets the command to execute when the button is pressed.

◆ SetFunc()

void VGUIButton::SetFunc ( void(void func)

Sets the function to call when the button is pressed.

◆ SetIcon()

void VGUIButton::SetIcon ( string  strName)

Sets the icon of the button.

◆ SetIconColor()

void VGUIButton::SetIconColor ( vector  vecColor)

Sets the color of the icon on the button.

◆ SetKeyEquivalent()

void VGUIButton::SetKeyEquivalent ( string  keyValue)

Sets the key to be pressed to order to simulate a click event.

◆ SetTitle()

void VGUIButton::SetTitle ( string  strName)

Sets the title of the button.

◆ Spawned()

void VGUIButton::Spawned ( void  )
virtual

Called when the widget has fully initialized.

When you override this, you may call super::Spawned(); to ensure the parent classes get to finish initializing also.

Reimplemented from VGUIWidget.


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