Nuclide
Software Development Kit for id Technology (BETA)
vguiTheme Class Reference

About this class

Abstract class than can be set/overriden to customize to final appearance of GUI widgets.

Inheritance diagram for vguiTheme:
vguiDesktopTheme

Public Member Functions

virtual void vguiTheme (void)
 
virtual void Init (void)
 
virtual string GetDefaultThemeFile (void)
 
virtual void DrawBorder (vector, vector, VGUIBorderStyle_t, vguiColor)
 Draw a border at the specified position, size and VGUIBorderStyle_t. More...
 
virtual void DrawControlText (vector, string, float, vector, VGUIDrawState_t, font_s)
 Draws control text onto a widget. More...
 
virtual void DrawControlTextWithIcon (vector, string, float, string, vector, vector, vector, VGUIDrawState_t, font_s)
 Draws control text onto a widget. More...
 
virtual void DrawControlBackground (vector, vector, VGUIDrawState_t)
 Draw a control item background at the specified position, size and VGUIDrawState_t. More...
 
virtual void DrawTextBackground (vector, vector, VGUIDrawState_t)
 Draw a text field background at the specified position, size and VGUIDrawState_t. More...
 
virtual void DrawListBackground (vector, vector, VGUIDrawState_t)
 Draw a text field background at the specified position, size and VGUIDrawState_t. More...
 
virtual void DrawWindowBackground (vector, vector, VGUIDrawState_t)
 Draw a window background at the specified position, size and VGUIDrawState_t. More...
 
virtual void DrawWindowTitle (vector, vector, string, string, font_s, VGUIDrawState_t)
 Draw a window background at the specified position, size and VGUIDrawState_t. More...
 
virtual void DrawButton (vector, vector, VGUIDrawState_t)
 Draw a button body at the specified position, size and VGUIDrawState_t. More...
 
virtual void DrawScroller (vector, vector, VGUIDrawState_t)
 Draw a scroller at the specified position, size and VGUIDrawState_t. More...
 
virtual void DrawScrollbar (vector, vector, VGUIDrawState_t)
 Draw a scrollbar at the specified position, size and VGUIDrawState_t. More...
 
virtual void DrawProgressIndicator (vector, vector, float, VGUIDrawState_t)
 Draw a progress indicator at the specified position, size and VGUIDrawState_t. More...
 
virtual void DrawText (vector, string, vector, font_s)
 Draws generic text onto a widget. More...
 
virtual void DrawHighlightText (vector, string, vector, font_s)
 Draws generic text onto a widget. More...
 
virtual void DrawWindow (vector, vector, VGUIDrawState_t)
 Draw a window body. More...
 
virtual void DrawWindowBorder (vector, vector, VGUIDrawState_t)
 Draw a window body. More...
 
virtual void DrawLabel (vector atPos, string withText, int labelFlags, int sizeOverride, vector boundSize, VGUIDrawState_t drawStyle)
 Draw window text. More...
 
virtual void DrawHighlight (vector atPos, vector withSize, VGUIDrawState_t drawStyle)
 
virtual void DrawMenuBar (vector, vector, VGUIDrawState_t)
 Draw a menu bar body. More...
 
virtual void DrawRadioButton (vector, string, vector, VGUIDrawState_t)
 Draw a control item background at the specified position, size and VGUIDrawState_t. More...
 
virtual bool IconsEnabled (void)
 Returns whether icons are currently enabled. More...
 
virtual void PlaySound (string shortName)
 Plays a UI sound, subject to sound theme guidelines. More...
 

Constructor & Destructor Documentation

◆ vguiTheme()

void vguiTheme::vguiTheme ( void  )
virtual

Member Function Documentation

◆ DrawBorder()

void vguiTheme::DrawBorder ( vector  atPos,
vector  withSize,
VGUIBorderStyle_t  borderStyle,
vguiColor  color 
)
virtual

Draw a border at the specified position, size and VGUIBorderStyle_t.

◆ DrawButton()

void vguiTheme::DrawButton ( vector  atPos,
vector  withSize,
VGUIDrawState_t  drawStyle 
)
virtual

Draw a button body at the specified position, size and VGUIDrawState_t.

◆ DrawControlBackground()

void vguiTheme::DrawControlBackground ( vector  atPos,
vector  withSize,
VGUIDrawState_t  drawStyle 
)
virtual

Draw a control item background at the specified position, size and VGUIDrawState_t.

◆ DrawControlText()

void vguiTheme::DrawControlText ( vector  atPos,
string  withText,
float  keyEquivalent,
vector  boundSize,
VGUIDrawState_t  drawStyle,
font_s  textFont 
)
virtual

Draws control text onto a widget.

◆ DrawControlTextWithIcon()

void vguiTheme::DrawControlTextWithIcon ( vector  atPos,
string  withText,
float  keyEquivalent,
string  iconPath,
vector  iconColor,
vector  iconSize,
vector  boundSize,
VGUIDrawState_t  drawStyle,
font_s  textFont 
)
virtual

Draws control text onto a widget.

◆ DrawHighlight()

void vguiTheme::DrawHighlight ( vector  atPos,
vector  withSize,
VGUIDrawState_t  drawStyle 
)
virtual

◆ DrawHighlightText()

void vguiTheme::DrawHighlightText ( vector  atPos,
string  withText,
vector  boundSize,
font_s  textFont 
)
virtual

Draws generic text onto a widget.

◆ DrawLabel()

void vguiTheme::DrawLabel ( vector  atPos,
string  withText,
int  labelFlags,
int  sizeOverride,
vector  boundSize,
VGUIDrawState_t  drawStyle 
)
virtual

Draw window text.

◆ DrawListBackground()

void vguiTheme::DrawListBackground ( vector  atPos,
vector  withSize,
VGUIDrawState_t  drawStyle 
)
virtual

Draw a text field background at the specified position, size and VGUIDrawState_t.

◆ DrawMenuBar()

void vguiTheme::DrawMenuBar ( vector  atPos,
vector  withSize,
VGUIDrawState_t  drawStyle 
)
virtual

Draw a menu bar body.

◆ DrawProgressIndicator()

void vguiTheme::DrawProgressIndicator ( vector  atPos,
vector  withSize,
float  progressValue,
VGUIDrawState_t  drawStyle 
)
virtual

Draw a progress indicator at the specified position, size and VGUIDrawState_t.

◆ DrawRadioButton()

void vguiTheme::DrawRadioButton ( vector  atPos,
string  withText,
vector  withSize,
VGUIDrawState_t  drawStyle 
)
virtual

Draw a control item background at the specified position, size and VGUIDrawState_t.

◆ DrawScrollbar()

void vguiTheme::DrawScrollbar ( vector  atPos,
vector  withSize,
VGUIDrawState_t  drawStyle 
)
virtual

Draw a scrollbar at the specified position, size and VGUIDrawState_t.

◆ DrawScroller()

void vguiTheme::DrawScroller ( vector  atPos,
vector  withSize,
VGUIDrawState_t  drawStyle 
)
virtual

Draw a scroller at the specified position, size and VGUIDrawState_t.

◆ DrawText()

void vguiTheme::DrawText ( vector  atPos,
string  withText,
vector  boundSize,
font_s  textFont 
)
virtual

Draws generic text onto a widget.

◆ DrawTextBackground()

void vguiTheme::DrawTextBackground ( vector  atPos,
vector  withSize,
VGUIDrawState_t  drawStyle 
)
virtual

Draw a text field background at the specified position, size and VGUIDrawState_t.

◆ DrawWindow()

void vguiTheme::DrawWindow ( vector  atPos,
vector  withSize,
VGUIDrawState_t  drawStyle 
)
virtual

Draw a window body.

◆ DrawWindowBackground()

void vguiTheme::DrawWindowBackground ( vector  atPos,
vector  withSize,
VGUIDrawState_t  drawStyle 
)
virtual

Draw a window background at the specified position, size and VGUIDrawState_t.

◆ DrawWindowBorder()

void vguiTheme::DrawWindowBorder ( vector  atPos,
vector  withSize,
VGUIDrawState_t  drawStyle 
)
virtual

Draw a window body.

◆ DrawWindowTitle()

void vguiTheme::DrawWindowTitle ( vector  atPos,
vector  withSize,
string  titleText,
string  withIcon,
font_s  textFont,
VGUIDrawState_t  drawStyle 
)
virtual

Draw a window background at the specified position, size and VGUIDrawState_t.

◆ GetDefaultThemeFile()

string vguiTheme::GetDefaultThemeFile ( void  )
virtual

Reimplemented in vguiDesktopTheme.

◆ IconsEnabled()

bool vguiTheme::IconsEnabled ( void  )
virtual

Returns whether icons are currently enabled.

Reimplemented in vguiDesktopTheme.

◆ Init()

void vguiTheme::Init ( void  )
virtual

◆ PlaySound()

void vguiTheme::PlaySound ( string  shortName)
virtual

Plays a UI sound, subject to sound theme guidelines.


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