vguiControl Class Reference

About this class

VGUI: Abstract Control Class.

This is an abstract control class for various VGUI related widgets.

Inheritance diagram for vguiControl:

Public Member Functions
virtual void	vguiControl (void)
nonvirtual void	SetTag (int)
	Set the control tag. More...
nonvirtual int	GetTag (void)
	Returns the control tag. 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...
virtual void	OnMouseEntered (void)
	Called when the mouse starts hovering over this element. More...
virtual void	OnMouseExited (void)
	Called when the mouse stops hovering over this element. More...
virtual void	OnMouseDown (void)
	Called when the mouse starts klicking down on this element. More...
virtual void	OnMouseUp (void)
	Called when the mouse stops klicking down on this element. More...

Constructor & Destructor Documentation

vguiControl()

void vguiControl::vguiControl ( void  )

virtual

Member Function Documentation

GetKeyEquivalent()

string vguiControl::GetKeyEquivalent

(

void

)

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

GetTag()

int vguiControl::GetTag

(

void

)

Returns the control tag.

Used for identification purposes.

OnMouseDown()

void vguiControl::OnMouseDown ( void  )

virtual

Called when the mouse starts klicking down on this element.

Reimplemented in vguiMenuButton.

OnMouseEntered()

void vguiControl::OnMouseEntered ( void  )

virtual

Called when the mouse starts hovering over this element.

Reimplemented in vguiMenuMakerButton, and vguiMenuButton.

OnMouseExited()

void vguiControl::OnMouseExited ( void  )

virtual

Called when the mouse stops hovering over this element.

OnMouseUp()

void vguiControl::OnMouseUp ( void  )

virtual

Called when the mouse stops klicking down on this element.

This is when actions usually need to be triggered.

Reimplemented in vguiMenuBarItem, vguiMenuButton, and vguiMenuItem.

SetKeyEquivalent()

void vguiControl::SetKeyEquivalent

(

string

keyValue

)

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

SetTag()

void vguiControl::SetTag

(

int

val

)

Set the control tag.

Used for identification purposes.

---

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

• src/vgui/Control.qc