IGUIScrollBarOwner Class Reference

Base-class this if you want an object to contain one, or several, scroll-bars. More...

#include <IGUIScrollBarOwner.h>

Inheritance diagram for IGUIScrollBarOwner:

Public Member Functions
	IGUIScrollBarOwner ()
virtual	~IGUIScrollBarOwner ()
virtual void	Draw ()
	Draws the object. More...
virtual void	HandleMessage (SGUIMessage &Message)
virtual void	ResetStates ()
virtual const SGUIScrollBarStyle *	GetScrollBarStyle (const CStr &style) const
	Interface for the m_ScrollBar to use. More...
virtual void	AddScrollBar (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...
Public Member Functions inherited from IGUIObject
	IGUIObject ()
virtual	~IGUIObject ()
virtual bool	MouseOver ()
	Checks if mouse is hovering this object. More...
virtual bool	MouseOverIcon ()
	Test if mouse position is over an icon. More...
const CStr &	GetName () const
	Get object name, name is unique. More...
void	SetName (const CStr &Name)
	Get object name. More...
CStr	GetPresentableName () const
void	AddToPointersMap (map_pObjects &ObjectMap)
	Adds object and its children to the map, it's name being the first part, and the second being itself. More...
void	AddChild (IGUIObject *pChild)
	Notice nothing will be returned or thrown if the child hasn't been inputted into the GUI yet. More...
vector_pObjects::iterator	ChildrenItBegin ()
vector_pObjects::iterator	ChildrenItEnd ()
bool	SettingExists (const CStr &Setting) const
	Checks if settings exists, only available for derived classes that has this set up, that's why the base class just returns false. More...
virtual void	UpdateCachedSize ()
	All sizes are relative to resolution, and the calculation is not wanted in real time, therefore it is cached, update the cached size with this function. More...
PSRETURN	SetSetting (const CStr &Setting, const CStrW &Value, const bool &SkipMessage=false)
	Set a setting by string, regardless of what type it is. More...
PSRETURN	GetSettingType (const CStr &Setting, EGUISettingType &Type) const
	Retrieves the type of a named setting. More...
void	RegisterScriptHandler (const CStr &Action, 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...
CGUI *	GetGUI ()
const CGUI *	GetGUI () const
void	SetFocus ()
	Take focus! More...

Protected Attributes
std::vector< IGUIScrollBar * >	m_ScrollBars
	Predominately you will only have one, but you can have as many as you like. More...
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
vector_pObjects	m_Children
IGUIObject *	m_pParent
double	m_LastClickTime [6]
bool	m_MouseHovering
	This is an array of true or false, each element is associated with a string representing a setting. More...

Friends
class	IGUIScrollBar

Detailed Description

Base-class this if you want an object to contain one, or several, scroll-bars.

See Also

IGUIObject

IGUIScrollBar

Definition at line 61 of file IGUIScrollBarOwner.h.

Constructor & Destructor Documentation

IGUIScrollBarOwner::IGUIScrollBarOwner

(

)

Definition at line 29 of file IGUIScrollBarOwner.cpp.

IGUIScrollBarOwner::~IGUIScrollBarOwner ( )

virtual

Definition at line 33 of file IGUIScrollBarOwner.cpp.

Member Function Documentation

void IGUIScrollBarOwner::AddScrollBar ( IGUIScrollBar *  scrollbar )

virtual

Add a scroll-bar.

Definition at line 54 of file IGUIScrollBarOwner.cpp.

void IGUIScrollBarOwner::Draw ( )

virtual

Draws the object.

Exceptions

PSERROR

if any. But this will mostlikely be very rare since if an object is drawn unsuccessfully it'll probably only output in the Error log, and not disrupt the whole GUI drawing.

Implements IGUIObject.

Reimplemented in CInput, CList, CText, and CDropDown.

Definition at line 88 of file IGUIScrollBarOwner.cpp.

virtual IGUIScrollBar& IGUIScrollBarOwner::GetScrollBar ( const int &  index )

inlinevirtual

Get Scroll Bar reference (it should be transparent it's actually pointers).

Definition at line 95 of file IGUIScrollBarOwner.h.

const SGUIScrollBarStyle * IGUIScrollBarOwner::GetScrollBarStyle ( const CStr &  style ) const

virtual

Interface for the m_ScrollBar to use.

Definition at line 61 of file IGUIScrollBarOwner.cpp.

void IGUIScrollBarOwner::HandleMessage ( SGUIMessage &  Message )

virtual

See Also

IGUIObject::HandleMessage()

Reimplemented from IGUIObject.

Reimplemented in CList, CInput, CText, and CDropDown.

Definition at line 79 of file IGUIScrollBarOwner.cpp.

void IGUIScrollBarOwner::ResetStates ( )

virtual

See Also

IGUIObject::ResetStates()

Reimplemented from IGUIObject.

Reimplemented in CInput, CList, and CText.

Definition at line 43 of file IGUIScrollBarOwner.cpp.

Friends And Related Function Documentation

friend class IGUIScrollBar

friend

Definition at line 63 of file IGUIScrollBarOwner.h.

Member Data Documentation

std::vector<IGUIScrollBar*> IGUIScrollBarOwner::m_ScrollBars

protected

Predominately you will only have one, but you can have as many as you like.

Definition at line 106 of file IGUIScrollBarOwner.h.

---

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

• /home/sathyam/0ad.svn/source/gui/IGUIScrollBarOwner.h
• /home/sathyam/0ad.svn/source/gui/IGUIScrollBarOwner.cpp