vguiWindow Class Reference

About this class

VGUI: Window.

Top-most window class in VGUILib.

Inheritance diagram for vguiWindow:

Public Member Functions
void	vguiWindow (void)
nonvirtual void	SetTitle (string)
	Set the title of the window widget. More...
nonvirtual string	GetTitle (void)
	Returns the title of the window widget. More...
nonvirtual void	SetIcon (string)
	Sets the icon of the window widget. More...
nonvirtual string	GetIcon (void)
	Returns the icon of the window widget. More...
nonvirtual void	SetStyleMask (vguiWindowStyle_t)
	Sets the style mask of the specified window. More...
nonvirtual void	CallOnResize (void(void) vFunc)
	Called when the window is was resized by the user. More...
nonvirtual void	CallOnMove (void(void) vFunc)
	Called when the window has been repositioned by the user. More...
nonvirtual void	Close (void)
	Call to close the window, and to destroy its contents. More...
nonvirtual bool	Focus (void)
	Will focus the window when called. More...
nonvirtual void	ShowContents ()
nonvirtual void	HideContents ()
virtual void	Add (vguiWidget wNew)
	Adds a widget into this one. More...
nonvirtual void	SetWindowBackground (string backgroundMaterial)
virtual void	WindowDidMove (vector, vector)
	Called when the vguiWindow got moved successfully. More...
virtual void	WindowDidResize (vector, vector)
	Called when the vguiWindow got resized successfully. More...
virtual void	WindowDidClose (void)
	Called when the vguiWindow was successfully closed. More...
virtual void	Draw (void)
	Called in order to draw the widget. More...
virtual void	SizeChanged (vector, vector)
	Called when the size of the widget has changed in any capacity. 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	NowVisible (void)
virtual void	NowHidden (void)
virtual void	OnRemove (void)
	Called when the widget gets removed, destroyed. More...

Constructor & Destructor Documentation

vguiWindow()

void vguiWindow::vguiWindow

(

void

)

Member Function Documentation

Add()

void vguiWindow::Add ( vguiWidget  wNew )

virtual

Adds a widget into this one.

Reimplemented from vguiView.

CallOnMove()

void vguiWindow::CallOnMove

(

void(void)

vFunc

)

Called when the window has been repositioned by the user.

CallOnResize()

void vguiWindow::CallOnResize

(

void(void)

vFunc

)

Called when the window is was resized by the user.

Close()

void vguiWindow::Close

(

void

)

Call to close the window, and to destroy its contents.

Draw()

void vguiWindow::Draw ( void  )

virtual

Called in order to draw the widget.

Reimplemented from vguiView.

Reimplemented in vguiTool_Console.

Focus()

bool vguiWindow::Focus

(

void

)

Will focus the window when called.

GetIcon()

string vguiWindow::GetIcon

(

void

)

Returns the icon of the window widget.

GetTitle()

string vguiWindow::GetTitle

(

void

)

Returns the title of the window widget.

HideContents()

void vguiWindow::HideContents

(

void

)

Input()

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

virtual

Called whenever an input event gets directed to the widget.

Reimplemented from vguiView.

Reimplemented in vguiTool_Console.

NowHidden()

void vguiWindow::NowHidden ( void  )

virtual

Reimplemented from vguiWidget.

Reimplemented in vguiPanel.

NowVisible()

void vguiWindow::NowVisible ( void  )

virtual

Reimplemented from vguiWidget.

Reimplemented in vguiPanel.

OnRemove()

void vguiWindow::OnRemove ( void  )

virtual

Called when the widget gets removed, destroyed.

Reimplemented from vguiWidget.

SetIcon()

void vguiWindow::SetIcon

(

string

strName

)

Sets the icon of the window widget.

SetStyleMask()

void vguiWindow::SetStyleMask

(

vguiWindowStyle_t

val

)

Sets the style mask of the specified window.

SetTitle()

void vguiWindow::SetTitle

(

string

strName

)

Set the title of the window widget.

SetWindowBackground()

void vguiWindow::SetWindowBackground

(

string

backgroundMaterial

)

ShowContents()

void vguiWindow::ShowContents

(

void

)

SizeChanged()

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

virtual

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

Reimplemented from vguiWidget.

Spawned()

void vguiWindow::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 ncEditorMainFrame, ncSunEdit, and vguiTool_Console.

WindowDidClose()

void vguiWindow::WindowDidClose ( void  )

virtual

Called when the vguiWindow was successfully closed.

Reimplemented in vguiPanel.

WindowDidMove()

void vguiWindow::WindowDidMove ( vector  oldPosition, vector  newPosition  )

virtual

Called when the vguiWindow got moved successfully.

WindowDidResize()

void vguiWindow::WindowDidResize ( vector  oldSize, vector  newSize  )

virtual

Called when the vguiWindow got resized successfully.

---

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

• src/vgui/Window.qc