CListBox Class Reference

#include <ui_listbox.h>

Inheritance diagram for CListBox:

Collaboration diagram for CListBox:

Public Member Functions
	CListBox ()
void	DoBegin (const CUIRect *pRect)
void	DoHeader (const CUIRect *pRect, const char *pTitle, float HeaderHeight=20.0f, float Spacing=2.0f)
void	DoAutoSpacing (float Spacing=20.0f)
void	DoSpacing (float Spacing=20.0f)
void	DoFooter (const char *pBottomText, float FooterHeight=20.0f)
void	DoStart (float RowHeight, int NumItems, int ItemsPerRow, int RowsPerScroll, int SelectedIndex, const CUIRect *pRect=nullptr, bool Background=true, int BackgroundCorners=IGraphics::CORNER_ALL, bool ForceShowScrollbar=false)
void	ScrollToSelected ()
CListboxItem	DoNextItem (const void *pId, bool Selected=false, float CornerRadius=5.0f)
CListboxItem	DoSubheader ()
int	DoEnd ()
bool	Active () const
void	SetActive (bool Active)
bool	WasItemSelected () const
bool	WasItemActivated () const
bool	ScrollbarShown () const
float	ScrollbarWidth () const
float	ScrollbarWidthMax () const
void	SetScrollbarWidth (float Width)
float	ScrollbarMargin () const
void	SetScrollbarMargin (float Margin)

Protected Member Functions
CListboxItem	DoNextRow ()

Private Attributes
CUIRect	m_ListBoxView
CUIRect	m_RowView
float	m_ListBoxRowHeight
int	m_ListBoxItemIndex
int	m_ListBoxSelectedIndex
int	m_ListBoxNewSelected
int	m_ListBoxNewSelOffset
bool	m_ListBoxUpdateScroll
int	m_ListBoxNumItems
int	m_ListBoxItemsPerRow
bool	m_ListBoxItemSelected
bool	m_ListBoxItemActivated
bool	m_ScrollbarShown
const char *	m_pBottomText
float	m_FooterHeight
float	m_AutoSpacing
CScrollRegion	m_ScrollRegion
vec2	m_ScrollOffset
int	m_BackgroundCorners
float	m_ScrollbarWidth
float	m_ScrollbarMargin
bool	m_HasHeader
bool	m_Active

Additional Inherited Members
Private Member Functions inherited from CUIElementBase
IClient *	Client () const
IGraphics *	Graphics () const
IInput *	Input () const
ITextRender *	TextRender () const
CUi *	Ui () const
Static Private Member Functions inherited from CUIElementBase
static void	Init (CUi *pUI)

Constructor & Destructor Documentation

CListBox()

CListBox::CListBox

(

)

Member Function Documentation

Active()

bool CListBox::Active ( ) const

inline

DoAutoSpacing()

void CListBox::DoAutoSpacing ( float  Spacing = 20.0f )

inline

DoBegin()

void CListBox::DoBegin

(

const CUIRect *

pRect

)

DoEnd()

int CListBox::DoEnd

(

)

DoFooter()

void CListBox::DoFooter	(	const char *	pBottomText,
		float	FooterHeight = 20.0f
	)

DoHeader()

void CListBox::DoHeader	(	const CUIRect *	pRect,
		const char *	pTitle,
		float	HeaderHeight = 20.0f,
		float	Spacing = 2.0f
	)

DoNextItem()

CListboxItem CListBox::DoNextItem	(	const void *	pId,
		bool	Selected = false,
		float	CornerRadius = 5.0f
	)

DoNextRow()

CListboxItem CListBox::DoNextRow ( )

protected

DoSpacing()

void CListBox::DoSpacing

(

float

Spacing = 20.0f

)

DoStart()

void CListBox::DoStart	(	float	RowHeight,
		int	NumItems,
		int	ItemsPerRow,
		int	RowsPerScroll,
		int	SelectedIndex,
		const CUIRect *	pRect = nullptr,
		bool	Background = true,
		int	BackgroundCorners = IGraphics::CORNER_ALL,
		bool	ForceShowScrollbar = false
	)

DoSubheader()

CListboxItem CListBox::DoSubheader

(

)

ScrollbarMargin()

float CListBox::ScrollbarMargin ( ) const

inline

ScrollbarShown()

bool CListBox::ScrollbarShown ( ) const

inline

ScrollbarWidth()

float CListBox::ScrollbarWidth ( ) const

inline

ScrollbarWidthMax()

float CListBox::ScrollbarWidthMax ( ) const

inline

ScrollToSelected()

void CListBox::ScrollToSelected ( )

inline

SetActive()

void CListBox::SetActive ( bool  Active )

inline

SetScrollbarMargin()

void CListBox::SetScrollbarMargin ( float  Margin )

inline

SetScrollbarWidth()

void CListBox::SetScrollbarWidth ( float  Width )

inline

WasItemActivated()

bool CListBox::WasItemActivated ( ) const

inline

WasItemSelected()

bool CListBox::WasItemSelected ( ) const

inline

Member Data Documentation

m_Active

bool CListBox::m_Active

private

m_AutoSpacing

float CListBox::m_AutoSpacing

private

m_BackgroundCorners

int CListBox::m_BackgroundCorners

private

m_FooterHeight

float CListBox::m_FooterHeight

private

m_HasHeader

bool CListBox::m_HasHeader

private

m_ListBoxItemActivated

bool CListBox::m_ListBoxItemActivated

private

m_ListBoxItemIndex

int CListBox::m_ListBoxItemIndex

private

m_ListBoxItemSelected

bool CListBox::m_ListBoxItemSelected

private

m_ListBoxItemsPerRow

int CListBox::m_ListBoxItemsPerRow

private

m_ListBoxNewSelected

int CListBox::m_ListBoxNewSelected

private

m_ListBoxNewSelOffset

int CListBox::m_ListBoxNewSelOffset

private

m_ListBoxNumItems

int CListBox::m_ListBoxNumItems

private

m_ListBoxRowHeight

float CListBox::m_ListBoxRowHeight

private

m_ListBoxSelectedIndex

int CListBox::m_ListBoxSelectedIndex

private

m_ListBoxUpdateScroll

bool CListBox::m_ListBoxUpdateScroll

private

m_ListBoxView

CUIRect CListBox::m_ListBoxView

private

m_pBottomText

const char* CListBox::m_pBottomText

private

m_RowView

CUIRect CListBox::m_RowView

private

m_ScrollbarMargin

float CListBox::m_ScrollbarMargin

private

m_ScrollbarShown

bool CListBox::m_ScrollbarShown

private

m_ScrollbarWidth

float CListBox::m_ScrollbarWidth

private

m_ScrollOffset

vec2 CListBox::m_ScrollOffset

private

m_ScrollRegion

CScrollRegion CListBox::m_ScrollRegion

private

---

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

• src/game/client/ui_listbox.h
• src/game/client/ui_listbox.cpp