vguiWidget Class Reference

About this class

The base VGUI widget class.

Every VGUI widget is based off of this.

Inheritance diagram for vguiWidget:

Public Member Functions
void	vguiWidget (void)
virtual void	Add (vguiWidget)
	Adds a widget into this one. More...
nonvirtual void	FlagAdd (int)
	Add a flag to the widget. More...
nonvirtual void	FlagRemove (int)
	Remove a flag from the widget. More...
nonvirtual bool	HasFlag (int)
	Check if the vguiWidget has a flag attached. More...
nonvirtual bool	IsEnabled (void)
	Returns if the widget is active. More...
nonvirtual bool	HasFocus (void)
nonvirtual void	SetPos (vector)
	Set the position within its context. More...
nonvirtual vector	GetPos (void)
	Return the position of the widget within its context. More...
nonvirtual int	GetPosWidth (void)
	Returns the X coordinate of the widget position within its context. More...
nonvirtual int	GetPosHeight (void)
	Returns the Y coordinate of the widget position within its context. More...
nonvirtual vector	GetAbsPos (void)
nonvirtual void	SetSize (vector)
	Set the size of the widget to a new one. More...
nonvirtual vector	GetSize (void)
	Returns the size of the widget, in pixels. More...
nonvirtual int	GetWidth (void)
	Returns the width of the widget, in pixels. More...
nonvirtual int	GetHeight (void)
	Returns the height of the widget, in pixels. More...
nonvirtual void	SetMinSize (vector)
	Sets the minimum size of the widget. More...
nonvirtual vector	GetMinSize (void)
	Returns the minimum size of the widget. More...
nonvirtual void	SetMaxSize (vector)
	Sets the maximum size of the widget. More...
nonvirtual vector	GetMaxSize (void)
	Returns the maximum size of the widget. More...
nonvirtual bool	Visible (void)
	Returns true/false depending on if the widget is visible. More...
nonvirtual void	Show (void)
	Show the widget. More...
nonvirtual void	Hide (void)
	Hide the widget. More...
nonvirtual void	SetTheme (vguiTheme)
	Sets the vguiTheme to use on this widget (and any children it may have) More...
nonvirtual vguiTheme	GetTheme (void)
	Returns the VGUI that will be used on this widget. More...
virtual void	PositionChanged (vector, vector)
	Called when the position of the widget was changed in any capacity. More...
virtual void	SizeChanged (vector, vector)
	Called when the size of the widget has changed in any capacity. More...
virtual void	NowVisible (void)
virtual void	NowHidden (void)
nonvirtual void	Enable (void)
	Enable the widget. More...
nonvirtual void	Disable (void)
	Disable the widget. More...
virtual void	NowEnabled (void)
virtual void	NowDisabled (void)
virtual void	ReloadVideoResources (void)
virtual void	Draw (void)
	Called in order to draw the widget. More...
virtual void	Reposition (void)
	Called whenever the physical properties of the display change. 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...
virtual void	OnRemove (void)
	Called when the widget gets removed, destroyed. More...
nonvirtual void	Remove (void)
nonvirtual vguiWidget	GetRootWindow (void)
nonvirtual vector	GetMousePos (void)
nonvirtual bool	MouseAbove (void)

Constructor & Destructor Documentation

vguiWidget()

void vguiWidget::vguiWidget

(

void

)

Member Function Documentation

Add()

void vguiWidget::Add ( vguiWidget  wNew )

virtual

Adds a widget into this one.

Reimplemented in vguiWindow, vguiMenu, vguiMenuBar, vguiView, and vguiRootWindow.

Disable()

void vguiWidget::Disable

(

void

)

Disable the widget.

Draw()

void vguiWidget::Draw ( void  )

virtual

Called in order to draw the widget.

Reimplemented in vguiDesktop, vguiDesktop_Computer, vguiDesktop_Editor, vguiDesktop_Home, vguiTool_Console, vgui3DView, vguiButton, vguiCheckbox, vguiCommandButton, vguiFeeder, vguiFeederListBox, vguiFrame, vguiHGradient, vguiImageList, vguiLabel, vguiList, vguiListBox, vguiMenuBar, vguiMenuButton, vguiMenuItem, vguiMenuTitle, vguiPic, vguiProgressBar, vguiRadio, vguiRect, vguiScriptedItem, vguiScriptedMenu, vguiSlider, vguiTabView, vguiTabViewItem, vguiTextBox, vguiTextView, vguiToggleButton, vguiVGradient, vguiVideo, vguiView, vguiRootWindow, vguiWindow, and vguiXView.

Enable()

void vguiWidget::Enable

(

void

)

Enable the widget.

FlagAdd()

void vguiWidget::FlagAdd

(

int

iFlag

)

Add a flag to the widget.

FlagRemove()

void vguiWidget::FlagRemove

(

int

iFlag

)

Remove a flag from the widget.

GetAbsPos()

vector vguiWidget::GetAbsPos

(

void

)

GetHeight()

int vguiWidget::GetHeight

(

void

)

Returns the height of the widget, in pixels.

GetMaxSize()

vector vguiWidget::GetMaxSize

(

void

)

Returns the maximum size of the widget.

GetMinSize()

vector vguiWidget::GetMinSize

(

void

)

Returns the minimum size of the widget.

GetMousePos()

vector vguiWidget::GetMousePos

(

void

)

GetPos()

vector vguiWidget::GetPos

(

void

)

Return the position of the widget within its context.

GetPosHeight()

int vguiWidget::GetPosHeight

(

void

)

Returns the Y coordinate of the widget position within its context.

GetPosWidth()

int vguiWidget::GetPosWidth

(

void

)

Returns the X coordinate of the widget position within its context.

GetRootWindow()

vguiWidget vguiWidget::GetRootWindow

(

void

)

GetSize()

vector vguiWidget::GetSize

(

void

)

Returns the size of the widget, in pixels.

GetTheme()

vguiTheme vguiWidget::GetTheme

(

void

)

Returns the VGUI that will be used on this widget.

GetWidth()

int vguiWidget::GetWidth

(

void

)

Returns the width of the widget, in pixels.

HasFlag()

bool vguiWidget::HasFlag

(

int

flag

)

Check if the vguiWidget has a flag attached.

HasFocus()

bool vguiWidget::HasFocus

(

void

)

Hide()

void vguiWidget::Hide

(

void

)

Hide the widget.

Input()

bool vguiWidget::Input ( float  flEVType, float  flKey, float  flChar, float  flDevID  )

virtual

Called whenever an input event gets directed to the widget.

Reimplemented in vguiDesktop, vguiDesktop_Editor, vguiTool_Console, vgui3DView, vguiAudioStream, vguiButton, vguiCheckbox, vguiCommandButton, vguiFeeder, vguiFeederListBox, vguiHGradient, vguiLabel, vguiList, vguiListBox, vguiMenuBar, vguiMenuButton, vguiMenuTitle, vguiPic, vguiRadio, vguiRect, vguiScriptedItem, vguiScriptedMenu, vguiSlider, vguiTabView, vguiTabViewItem, vguiTextBox, vguiTextView, vguiToggleButton, vguiVGradient, vguiView, vguiWebView, vguiRootWindow, vguiWindow, and vguiXView.

IsEnabled()

bool vguiWidget::IsEnabled

(

void

)

Returns if the widget is active.

MouseAbove()

bool vguiWidget::MouseAbove

(

void

)

NowDisabled()

void vguiWidget::NowDisabled ( void  )

virtual

NowEnabled()

void vguiWidget::NowEnabled ( void  )

virtual

NowHidden()

void vguiWidget::NowHidden ( void  )

virtual

Reimplemented in vguiPanel, and vguiWindow.

NowVisible()

void vguiWidget::NowVisible ( void  )

virtual

Reimplemented in vguiMenu, vguiPanel, and vguiWindow.

OnRemove()

void vguiWidget::OnRemove ( void  )

virtual

Called when the widget gets removed, destroyed.

Reimplemented in vguiAudioStream, vguiScriptedItem, vguiWebView, vguiWindow, and vguiXView.

PositionChanged()

void vguiWidget::PositionChanged ( vector  vecOld, vector  vecNew  )

virtual

Called when the position of the widget was changed in any capacity.

Reimplemented in vguiTabView.

ReloadVideoResources()

void vguiWidget::ReloadVideoResources ( void  )

virtual

Reimplemented in vguiPic, vguiScriptedItem, vguiVideo, and vguiWebView.

Remove()

void vguiWidget::Remove

(

void

)

Reposition()

void vguiWidget::Reposition ( void  )

virtual

Called whenever the physical properties of the display change.

Reimplemented in ncEditorMainFrame, ncSunEdit, vguiMenuButton, vguiMenuTitle, vguiScriptedItem, vguiScriptedMenu, vguiScriptedView, and vguiRootWindow.

SetMaxSize()

void vguiWidget::SetMaxSize

(

vector

vecNewSize

)

Sets the maximum size of the widget.

SetMinSize()

void vguiWidget::SetMinSize

(

vector

vecNewSize

)

Sets the minimum size of the widget.

SetPos()

void vguiWidget::SetPos

(

vector

vecNewPos

)

Set the position within its context.

SetSize()

void vguiWidget::SetSize

(

vector

vecNewSize

)

Set the size of the widget to a new one.

SetTheme()

void vguiWidget::SetTheme

(

vguiTheme

theme

)

Sets the vguiTheme to use on this widget (and any children it may have)

Show()

void vguiWidget::Show

(

void

)

Show the widget.

SizeChanged()

void vguiWidget::SizeChanged ( vector  vecOld, vector  vecNew  )

virtual

Called when the size of the widget has changed in any capacity.

Reimplemented in vguiAudioStream, vguiTabView, vguiWebView, vguiWindow, and vguiXView.

Spawned()

void vguiWidget::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 in vguiDesktop, vguiDesktop_Computer, vguiDesktop_Editor, vguiDesktop_Home, ncEditorMainFrame, ncSunEdit, vguiTool_Console, vgui3DView, vguiButton, vguiCheckbox, vguiFeeder, vguiFeederListBox, vguiHGradient, vguiLabel, vguiList, vguiListBox, vguiMenuButton, vguiPic, vguiRadio, vguiRect, vguiSlider, vguiTabView, vguiTabViewItem, vguiTextBox, vguiTextView, vguiToggleButton, vguiVGradient, vguiVideo, and vguiWindow.

Visible()

bool vguiWidget::Visible

(

void

)

Returns true/false depending on if the widget is visible.

---

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

• src/vgui/Widget.h
• src/vgui/Widget.qc