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:

Collaboration diagram for IGUIScrollBarOwner:

Public Member Functions
	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...

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

Private Member Functions
	NONCOPYABLE (IGUIScrollBarOwner)

Private Attributes
IGUIObject &	m_pObject
	Reference to the IGUIObject. More...

Friends
class	IGUIScrollBar

Detailed Description

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

Constructor & Destructor Documentation

IGUIScrollBarOwner()

IGUIScrollBarOwner::IGUIScrollBarOwner

(

IGUIObject &

m_pObject

)

~IGUIScrollBarOwner()

IGUIScrollBarOwner::~IGUIScrollBarOwner ( )

virtualdefault

Member Function Documentation

AddScrollBar()

void IGUIScrollBarOwner::AddScrollBar ( std::unique_ptr< IGUIScrollBar >  scrollbar )

virtual

Add a scroll-bar.

Draw()

void IGUIScrollBarOwner::Draw ( CCanvas2D &  canvas )

virtual

Reimplemented in CDropDown, CInput, CList, and CText.

GetScrollBar()

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

inlinevirtual

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

GetScrollBarPos()

float IGUIScrollBarOwner::GetScrollBarPos ( const int  index ) const

virtual

Get the position of the scroll bar at.

Parameters

index.

Equivalent to GetScrollbar(index).GetPos().

GetScrollBarStyle()

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

virtual

Interface for the m_ScrollBar to use.

HandleMessage()

void IGUIScrollBarOwner::HandleMessage ( SGUIMessage &  Message )

virtual

See also

IGUIObject::HandleMessage()

Reimplemented in CDropDown, CInput, CList, COList, and CText.

NONCOPYABLE()

IGUIScrollBarOwner::NONCOPYABLE ( IGUIScrollBarOwner  )

private

ResetStates()

void IGUIScrollBarOwner::ResetStates ( )

virtual

See also

IGUIObject::ResetStates()

Reimplemented in CInput, CList, and CText.

Friends And Related Function Documentation

IGUIScrollBar

friend class IGUIScrollBar

friend

Member Data Documentation

m_pObject

IGUIObject& IGUIScrollBarOwner::m_pObject

private

Reference to the IGUIObject.

Private, because we don't want to inherit it in multiple classes.

m_ScrollBars

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

protected

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

---

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

• /home/docker/jenkins/workspace/technical-docs/source/gui/ObjectBases/IGUIScrollBarOwner.h
• /home/docker/jenkins/workspace/technical-docs/source/gui/ObjectBases/IGUIScrollBarOwner.cpp