Multi-column list. More...

#include <COList.h>

Inheritance diagram for COList:

[legend]

Collaboration diagram for COList:

[legend]

Public Member Functions
	COList (CGUI &pGUI)

Public Member Functions inherited from CList
	CList (CGUI &pGUI)

virtual	~CList ()

virtual void	ResetStates ()

virtual void	UpdateCachedSize ()

virtual void	AddItem (const CGUIString &str, const CGUIString &data)
	Adds an item last to the list. More...

void	AddItem (const CGUIString &strAndData)
	Add an item where both parameters are identical. More...

Public Member Functions inherited from IGUIObject
	NONCOPYABLE (IGUIObject)

	IGUIObject (CGUI &pGUI)

virtual	~IGUIObject ()

virtual bool	IsMouseOver () const
	This function checks if the mouse is hovering the rectangle that the base setting "size" makes. More...

virtual bool	IsMouseHovering () const
	This function returns true if the mouse is hovering over this GUI object and if this GUI object is the topmost object in that screen location. More...

const CStr &	GetName () const
	Get object name, name is unique. More...

void	SetName (const CStr &Name)
	Get object name. More...

CStr	GetPresentableName () const

const std::vector< IGUIObject * > &	GetChildren () const
	Return all child objects of the current object. More...

void	RegisterSetting (const CStr &Name, IGUISetting *setting)
	Registers the given setting with the GUI object. More...

void	ReregisterSetting (const CStr &Name, IGUISetting *setting)

bool	SettingExists (const CStr &Setting) const
	Returns whether there is a setting with the given name registered. More...

bool	SetSettingFromString (const CStr &Setting, const CStrW &Value, const bool SendMessage)
	Set a setting by string, regardless of what type it is. More...

bool	IsEnabled () const
	Returns whether this object is set to be hidden or ghost. More...

bool	IsHidden () const
	Returns whether this is object is set to be hidden. More...

void	SetHidden (bool hidden)

bool	IsHiddenOrGhost () const
	Returns whether this object is set to be hidden or ghost. More...

void	PlaySound (const CStrW &soundPath) const
	Retrieves the configured sound filename from the given setting name and plays that once. More...

InReaction	SendEvent (EGUIMessageType type, const CStr &eventName)
	Send event to this GUI object (HandleMessage and ScriptEvent) More...

InReaction	SendMouseEvent (EGUIMessageType type, const CStr &eventName)
	Same as SendEvent, but passes mouse coordinates and button state as an argument. More...

CRect	GetComputedSize ()
	Updates and returns the size of the object. More...

virtual const CStrW &	GetTooltipText () const

virtual const CStr &	GetTooltipStyle () const

void	RegisterScriptHandler (const CStr &eventName, const CStr &Code, CGUI &pGUI)
	Set the script handler for a particular object-specific action. More...

JSObject *	GetJSObject ()
	Retrieves the JSObject representing this GUI object. More...

virtual void	Tick ()
	Called on every GUI tick unless the object or one of its parent is hidden/ghost. More...

template<typename... Args>
void	RecurseObject (bool(IGUIObject::isRestricted)() const, void(IGUIObject::callbackFunction)(Args... args), Args &&... args)
	Calls an IGUIObject member function recursively on this object and its children. More...

CGUI &	GetGUI ()

const CGUI &	GetGUI () const

void	SetFocus ()
	Take focus! More...

void	ReleaseFocus ()
	Release focus. More...

Public Member Functions inherited from IGUIScrollBarOwner
	IGUIScrollBarOwner (IGUIObject &m_pObject)

virtual	~IGUIScrollBarOwner ()

virtual void	Draw (CCanvas2D &canvas)

virtual void	HandleMessage (SGUIMessage &Message)

virtual void	ResetStates ()

virtual const SGUIScrollBarStyle *	GetScrollBarStyle (const CStr8 &style) const
	Interface for the m_ScrollBar to use. More...

virtual void	AddScrollBar (std::unique_ptr< IGUIScrollBar > scrollbar)
	Add a scroll-bar. More...

virtual IGUIScrollBar &	GetScrollBar (const int &index)
	Get Scroll Bar reference (it should be transparent it's actually pointers). More...

virtual float	GetScrollBarPos (const int index) const
	Get the position of the scroll bar at. More...

Public Member Functions inherited from IGUITextOwner
	IGUITextOwner (IGUIObject &pObject)

virtual	~IGUITextOwner ()

CGUIText &	AddText ()
	Adds a text object. More...

CGUIText &	AddText (const CGUIString &Text, const CStrW &Font, const float &Width, const float &BufferZone)
	Adds a text generated by the given arguments. More...

virtual void	HandleMessage (SGUIMessage &Message)

virtual void	UpdateCachedSize ()

virtual void	DrawText (CCanvas2D &canvas, size_t index, const CGUIColor &color, const CVector2D &pos, const CRect &clipping=CRect())
	Draws the Text. More...

Protected Member Functions
void	SetupText ()
	Sets up text, should be called every time changes has been made that can change the visual. More...

void	HandleMessage (SGUIMessage &Message)

virtual bool	HandleAdditionalChildren (const XMBData &xmb, const XMBElement &child)
	Handle the <item> tag. More...

virtual void	AdditionalChildrenHandled ()
	Allow the GUI object to process after all child items were handled. More...

virtual void	DrawList (CCanvas2D &canvas, const int &selected, const CGUISpriteInstance &sprite, const CGUISpriteInstance &spriteOverlay, const CGUISpriteInstance &spriteSelectarea, const CGUISpriteInstance &spriteSelectAreaOverlay, const CGUIColor &textColor)

virtual CRect	GetListRect () const

Protected Member Functions inherited from CList
virtual void	SetupText ()
	Sets up text, should be called every time changes has been made that can change the visual. More...

virtual void	SetupText (bool append)

virtual void	HandleMessage (SGUIMessage &Message)

virtual InReaction	ManuallyHandleKeys (const SDL_Event_ *ev)
	Handle events manually to catch keyboard inputting. More...

virtual void	Draw (CCanvas2D &canvas)
	Draws the List box. More...

virtual void	CreateJSObject ()
	Creates the JS object representing this page upon first use. More...

virtual void	SelectNextElement ()
	Easy select elements functions. More...

virtual void	SelectPrevElement ()

virtual void	SelectFirstElement ()

virtual void	SelectLastElement ()

virtual bool	HandleAdditionalChildren (const XMBData &xmb, const XMBElement &child)
	Handle the <item> tag. More...

void	UpdateAutoScroll ()

virtual void	DrawList (CCanvas2D &canvas, const int &selected, const CGUISpriteInstance &sprite, const CGUISpriteInstance &spriteOverlay, const CGUISpriteInstance &spriteSelectArea, const CGUISpriteInstance &spriteSelectAreaOverlay, const CGUIColor &textColor)

virtual CRect	GetListRect () const

virtual bool	GetModified () const

virtual int	GetHoveredItem ()

Protected Member Functions inherited from IGUIObject
virtual InReaction	PreemptEvent (const SDL_Event_ *ev)
	Some objects need to be able to pre-emptively process SDL_Event_. More...

bool	ApplyStyle (const CStr &StyleName)
	Applies the given style to the object. More...

virtual float	GetBufferedZ () const
	Returns not the Z value, but the actual buffered Z value, i.e. More...

void	RegisterChild (IGUIObject *child)
	Add an object to the hierarchy. More...

void	UnregisterChild (IGUIObject *child)
	Remove an object from the hierarchy. More...

void	SetParent (IGUIObject *pParent)
	Set parent of this object. More...

bool	IsFocused () const
	Check if object is focused. More...

IGUIObject *	GetParent () const
	NOTE! This will not just return m_pParent, when that is need use it! There is one exception to it, when the parent is the top-node (the object that isn't a real object), this will return nullptr, so that the top-node's children are seemingly parentless. More...

void	ScriptEvent (const CStr &eventName)
	Execute the script for a particular action. More...

bool	ScriptEventWithReturn (const CStr &eventName)
	Execute the script for a particular action. More...

void	ScriptEvent (const CStr &eventName, const JS::HandleValueArray &paramData)
	Execute the script for a particular action. More...

bool	ScriptEventWithReturn (const CStr &eventName, const JS::HandleValueArray &paramData)
	Execute the script for a particular action. More...

void	SetScriptHandler (const CStr &eventName, JS::HandleObject Function)
	Assigns a JS function to the event name. More...

void	UnsetScriptHandler (const CStr &eventName)
	Deletes an event handler assigned to the given name, if such a handler exists. More...

void	UpdateMouseOver (IGUIObject *const &pMouseOver)
	Inputes the object that is currently hovered, this function updates this object accordingly (i.e. More...

Protected Member Functions inherited from IGUITextOwner
virtual void	SetupText ()=0
	Setup texts. More...

virtual void	UpdateText ()
	Regenerate the text in case it is invalid. More...

void	CalculateTextPosition (CRect &ObjSize, CVector2D &TextPos, CGUIText &Text)
	Calculate the position for the text, based on the alignment. More...

Protected Attributes
std::vector< COListColumn >	m_Columns
	Available columns. More...

CGUISimpleSetting< CGUISpriteInstance >	m_SpriteHeading

CGUISimpleSetting< bool >	m_Sortable

CGUISimpleSetting< CStr >	m_SelectedColumn

CGUISimpleSetting< i32 >	m_SelectedColumnOrder

CGUISimpleSetting< CGUISpriteInstance >	m_SpriteAsc

CGUISimpleSetting< CGUISpriteInstance >	m_SpriteDesc

CGUISimpleSetting< CGUISpriteInstance >	m_SpriteNotSorted

Protected Attributes inherited from CList
std::vector< float >	m_ItemsYPositions
	List of each element's relative y position. More...

CGUISimpleSetting< float >	m_BufferZone

CGUISimpleSetting< CStrW >	m_Font

CGUISimpleSetting< bool >	m_ScrollBar

CGUISimpleSetting< CStr >	m_ScrollBarStyle

CGUISimpleSetting< bool >	m_ScrollBottom

CGUISimpleSetting< CStrW >	m_SoundDisabled

CGUISimpleSetting< CStrW >	m_SoundSelected

CGUISimpleSetting< CGUISpriteInstance >	m_Sprite

CGUISimpleSetting< CGUISpriteInstance >	m_SpriteOverlay

CGUISimpleSetting< CGUISpriteInstance >	m_SpriteSelectArea

CGUISimpleSetting< CGUISpriteInstance >	m_SpriteSelectAreaOverlay

CGUISimpleSetting< CGUIColor >	m_TextColor

CGUISimpleSetting< CGUIColor >	m_TextColorSelected

CGUISimpleSetting< i32 >	m_Selected

CGUISimpleSetting< bool >	m_AutoScroll

CGUISimpleSetting< i32 >	m_Hovered

CGUISimpleSetting< CGUIList >	m_List

CGUISimpleSetting< CGUIList >	m_ListData

Protected Attributes inherited from IGUIObject
CRect	m_CachedActualSize
	Cached size, real size m_Size is actually dependent on resolution and can have different real outcomes, this is the real outcome cached to avoid slow calculations in real time. More...

CStr	m_Name

std::vector< IGUIObject * >	m_Children

IGUIObject *	m_pParent

double	m_LastClickTime [6]

bool	m_MouseHovering
	This variable is true if the mouse is hovering this object and this object is the topmost object shown in this location. More...

std::map< CStr, IGUISetting * >	m_Settings
	Settings pool, all an object's settings are located here. More...

CGUI &	m_pGUI

std::map< CStr, JS::Heap< JSObject * > >	m_ScriptHandlers

std::unique_ptr< IGUIProxyObject >	m_JSObject

CGUISimpleSetting< bool >	m_Enabled

CGUISimpleSetting< bool >	m_Hidden

CGUISimpleSetting< CGUISize >	m_Size

CGUISimpleSetting< CStr >	m_Style

CGUIHotkey	m_Hotkey

CGUISimpleSetting< float >	m_Z

CGUISimpleSetting< bool >	m_Absolute

CGUISimpleSetting< bool >	m_Ghost

CGUISimpleSetting< float >	m_AspectRatio

CGUISimpleSetting< CStrW >	m_Tooltip

CGUISimpleSetting< CStr >	m_TooltipStyle

Protected Attributes inherited from IGUIScrollBarOwner
std::vector< std::unique_ptr< IGUIScrollBar > >	m_ScrollBars
	Predominately you will only have one, but you can have as many as you like. More...

Protected Attributes inherited from IGUITextOwner
bool	m_GeneratedTextsValid
	Whether the cached text is currently valid (if not then SetupText will be called by Draw) More...

std::vector< CGUIText >	m_GeneratedTexts
	Texts that are generated and ready to be rendered. More...

CGUISimpleSetting< EAlign >	m_TextAlign

CGUISimpleSetting< EVAlign >	m_TextVAlign

Private Attributes
float	m_TotalAvailableColumnWidth

float	m_HeadingHeight

Static Private Attributes
static const CStr	EventNameSelectionColumnChange = "SelectionColumnChange"

Additional Inherited Members
Static Protected Attributes inherited from IGUIObject
static const CStr	EventNameMouseEnter = "MouseEnter"

static const CStr	EventNameMouseMove = "MouseMove"

static const CStr	EventNameMouseLeave = "MouseLeave"

Detailed Description

Multi-column list.

One row can be selected by the user. Individual cells are clipped if the contained text is too long.

The list can be sorted dynamically by JS code when a heading is clicked. A scroll-bar will appear when needed.

Constructor & Destructor Documentation

◆ COList()

COList::COList ( CGUI & pGUI )

Member Function Documentation

◆ AdditionalChildrenHandled()

void COList::AdditionalChildrenHandled ( )

protectedvirtual

Allow the GUI object to process after all child items were handled.

Useful to avoid iterator invalidation with push_back calls.

Reimplemented from IGUIObject.

◆ DrawList()

void COList::DrawList	(	CCanvas2D &	canvas,
		const int &	selected,
		const CGUISpriteInstance &	sprite,
		const CGUISpriteInstance &	spriteOverlay,
		const CGUISpriteInstance &	spriteSelectarea,
		const CGUISpriteInstance &	spriteSelectAreaOverlay,
		const CGUIColor &	textColor
	)

protectedvirtual

Reimplemented from CList.

◆ GetListRect()

CRect COList::GetListRect ( ) const

protectedvirtual

Reimplemented from CList.

◆ HandleAdditionalChildren()

bool COList::HandleAdditionalChildren	(	const XMBData &	xmb,
		const XMBElement &	child
	)

protectedvirtual

Handle the <item> tag.

Reimplemented from CList.

◆ HandleMessage()

void COList::HandleMessage ( SGUIMessage & Message )

protectedvirtual

See also: IGUIObject::HandleMessage()

Reimplemented from CList.

◆ SetupText()

void COList::SetupText ( )

protectedvirtual

Sets up text, should be called every time changes has been made that can change the visual.

Parameters

append - if true, we assume we only need to render the new element at the end of the list.

Reimplemented from CList.

Member Data Documentation

◆ EventNameSelectionColumnChange

const CStr COList::EventNameSelectionColumnChange = "SelectionColumnChange"

staticprivate

◆ m_Columns

std::vector<COListColumn> COList::m_Columns

protected

Available columns.

◆ m_HeadingHeight

float COList::m_HeadingHeight

private

◆ m_SelectedColumn

CGUISimpleSetting<CStr> COList::m_SelectedColumn

protected

◆ m_SelectedColumnOrder

CGUISimpleSetting<i32> COList::m_SelectedColumnOrder

protected

◆ m_Sortable

CGUISimpleSetting<bool> COList::m_Sortable

protected

◆ m_SpriteAsc

CGUISimpleSetting<CGUISpriteInstance> COList::m_SpriteAsc

protected

◆ m_SpriteDesc

CGUISimpleSetting<CGUISpriteInstance> COList::m_SpriteDesc

protected

◆ m_SpriteHeading

CGUISimpleSetting<CGUISpriteInstance> COList::m_SpriteHeading

protected

◆ m_SpriteNotSorted

CGUISimpleSetting<CGUISpriteInstance> COList::m_SpriteNotSorted

protected

◆ m_TotalAvailableColumnWidth

float COList::m_TotalAvailableColumnWidth

private

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

/home/docker/jenkins/workspace/technical-docs/source/gui/ObjectTypes/COList.h
/home/docker/jenkins/workspace/technical-docs/source/gui/ObjectTypes/COList.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ COList()

Member Function Documentation

◆ AdditionalChildrenHandled()

◆ DrawList()

◆ GetListRect()

◆ HandleAdditionalChildren()

◆ HandleMessage()

◆ SetupText()

Member Data Documentation

◆ EventNameSelectionColumnChange

◆ m_Columns

◆ m_HeadingHeight

◆ m_SelectedColumn

◆ m_SelectedColumnOrder

◆ m_Sortable

◆ m_SpriteAsc

◆ m_SpriteDesc

◆ m_SpriteHeading

◆ m_SpriteNotSorted

◆ m_TotalAvailableColumnWidth