Nuclide
Software Development Kit for id Technology
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:
VGUIWidget VGUIButton VGUITabViewItem VGUICommandButton VGUIMenuButton

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...
 
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

◆ 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.

◆ OnMouseEntered()

void VGUIControl::OnMouseEntered ( void  )
virtual

Called when the mouse starts hovering over this element.

◆ 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.

◆ 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: