vguiButton Class Reference

About this class

VGUI Widget: Button.

Inheritance diagram for vguiButton:

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

Constructor & Destructor Documentation

vguiButton()

void vguiButton::vguiButton

(

void

)

Member Function Documentation

ButtonDisabled()

bool vguiButton::ButtonDisabled

(

void

)

Draw()

void vguiButton::Draw ( void )

virtual

Called in order to draw the widget.

Reimplemented from vguiWidget.

Reimplemented in vguiCommandButton, and vguiMenuButton.

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.

Reimplemented in vguiCommandButton, and vguiMenuButton.

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.

Reimplemented in vguiMenuButton.

---

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

• src/vgui/Button.qc