CGUIBaseContainer Class Reference

#include <GUIBaseContainer.h>

Inheritance diagram for CGUIBaseContainer:

Classes
struct	RENDERITEM

Public Member Functions
	CGUIBaseContainer (int parentID, int controlID, float posX, float posY, float width, float height, ORIENTATION orientation, const CScroller &scroller, int preloadItems)
	CGUIBaseContainer (const CGUIBaseContainer &other)
	~CGUIBaseContainer (void) override
bool	OnAction (const CAction &action) override
void	OnDown () override
void	OnUp () override
void	OnLeft () override
void	OnRight () override
bool	OnMouseOver (const CPoint &point) override
	Called when the mouse is over the control. Default implementation selects the control.
bool	CanFocus () const override
bool	OnMessage (CGUIMessage &message) override
void	SetFocus (bool bOnOff) override
void	AllocResources () override
void	FreeResources (bool immediately=false) override
void	UpdateVisibility (const CGUIListItem *item=NULL) override
void	AssignDepth () override
virtual unsigned int	GetRows () const
virtual bool	HasNextPage () const
virtual bool	HasPreviousPage () const
void	SetPageControl (int id)
std::string	GetDescription () const override
void	SaveStates (std::vector< CControlState > &states) override
virtual int	GetSelectedItem () const
void	DoProcess (unsigned int currentTime, CDirtyRegionList &dirtyregions) override
void	Process (unsigned int currentTime, CDirtyRegionList &dirtyregions) override
void	LoadLayout (TiXmlElement *layout)
void	LoadListProvider (TiXmlElement *content, int defaultItem, bool defaultAlways)
std::shared_ptr< CGUIListItem >	GetListItem (int offset, unsigned int flag=0) const override
bool	GetCondition (int condition, int data) const override
std::string	GetLabel (int info) const override
void	SetListProvider (std::unique_ptr< IListProvider > provider)
	Set the list provider for this container (for python).
void	SetRenderOffset (const CPoint &offset)
	Set the offset of the first item in the container from the container's position Useful for lists/panels where the focused item may be larger than the non-focused items and thus normally cut off from the clipping window defined by the container's position + size.
void	SetClickActions (const CGUIAction &clickActions)
void	SetFocusActions (const CGUIAction &focusActions)
void	SetUnFocusActions (const CGUIAction &unfocusActions)
void	SetAutoScrolling (const TiXmlNode *node)
void	ResetAutoScrolling ()
void	UpdateAutoScrolling (unsigned int currentTime)
Public Member Functions inherited from IGUIContainer
	IGUIContainer (int parentID, int controlID, float posX, float posY, float width, float height)
bool	IsContainer () const override
VIEW_TYPE	GetType () const
const std::string &	GetLabel () const
void	SetType (VIEW_TYPE type, const std::string &label)
Public Member Functions inherited from CGUIControl
	CGUIControl ()
	CGUIControl (int parentID, int controlID, float posX, float posY, float width, float height)
	CGUIControl (const CGUIControl &)
virtual	~CGUIControl (void)
virtual CGUIControl *	Clone () const =0
virtual void	DoRender ()
virtual void	RenderEx ()
bool	HasProcessed () const
	Returns whether or not we have processed.
virtual bool	OnBack ()
virtual bool	OnInfo ()
virtual void	OnNextControl ()
virtual void	OnPrevControl ()
virtual EVENT_RESULT	SendMouseEvent (const CPoint &point, const KODI::MOUSE::CMouseEvent &event)
	React to a mouse event.
virtual void	UnfocusFromPoint (const CPoint &point)
	Unfocus the control if the given point on screen is not within it's boundary.
virtual bool	HitTest (const CPoint &point) const
	Used to test whether the point is inside a control.
virtual int	GetID (void) const
virtual void	SetID (int id)
int	GetParentID () const
virtual bool	HasFocus () const
virtual void	DynamicResourceAlloc (bool bOnOff)
virtual bool	IsDynamicallyAllocated ()
virtual bool	IsVisible () const
bool	IsVisibleFromSkin () const
virtual bool	IsDisabled () const
virtual void	SetPosition (float posX, float posY)
virtual void	SetHitRect (const CRect &rect, const KODI::UTILS::COLOR::Color &color)
virtual void	SetCamera (const CPoint &camera)
virtual void	SetStereoFactor (const float &factor)
bool	SetColorDiffuse (const KODI::GUILIB::GUIINFO::CGUIInfoColor &color)
CPoint	GetRenderPosition () const
virtual float	GetXPosition () const
virtual float	GetYPosition () const
virtual float	GetWidth () const
virtual float	GetHeight () const
void	MarkDirtyRegion (const unsigned int dirtyState=DIRTY_STATE_CONTROL)
bool	IsControlDirty () const
const CRect &	GetRenderRegion () const
	return the render region in screen coordinates of this control
virtual CRect	CalcRenderRegion () const
	calculate the render region in parentcontrol coordinates of this control Called during process to update m_renderRegion
void	SetActions (const ActionMap &actions)
void	SetAction (int actionID, const CGUIAction &action, bool replace=true)
	Set actions to perform on navigation Navigations are set if replace is true or if there is no previously set action.
CGUIAction	GetAction (int actionID) const
	Get an action the control can be perform.
bool	Navigate (int direction) const
	Start navigating in given direction.
virtual void	SetWidth (float width)
virtual void	SetHeight (float height)
virtual void	SetVisible (bool bVisible, bool setVisState=false)
void	SetVisibleCondition (const std::string &expression, const std::string &allowHiddenFocus="")
bool	HasVisibleCondition () const
void	SetEnableCondition (const std::string &expression)
virtual void	SetInitialVisibility ()
virtual void	SetEnabled (bool bEnable)
virtual void	SetInvalid ()
virtual void	SetPulseOnSelect (bool pulse)
virtual std::string	GetDescriptionByIndex (int index) const
void	SetAnimations (const std::vector< CAnimation > &animations)
const std::vector< CAnimation > &	GetAnimations () const
virtual void	QueueAnimation (ANIMATION_TYPE anim)
virtual bool	IsAnimating (ANIMATION_TYPE anim)
virtual bool	HasAnimation (ANIMATION_TYPE anim)
CAnimation *	GetAnimation (ANIMATION_TYPE type, bool checkConditions=true)
virtual void	ResetAnimation (ANIMATION_TYPE type)
virtual void	ResetAnimations ()
virtual void	UpdateInfo (const CGUIListItem *item=NULL)
virtual void	SetPushUpdates (bool pushUpdates)
virtual bool	IsGroup () const
void	SetParentControl (CGUIControl *control)
CGUIControl *	GetParentControl (void) const
virtual CGUIControl *	GetControl (int id, std::vector< CGUIControl * > *idCollector=nullptr)
void	SetControlStats (GUICONTROLSTATS *controlStats)
virtual void	UpdateControlStats ()
GUICONTROLTYPES	GetControlType () const
bool	IsControlRenderable ()
	Test whether the control is "drawable" (not a group or similar)

Protected Types
typedef std::vector< std::shared_ptr< CGUIListItem > >::iterator	iItems

Protected Member Functions
EVENT_RESULT	OnMouseEvent (const CPoint &point, const KODI::MOUSE::CMouseEvent &event) override
	Perform a mouse action.
bool	OnClick (int actionID)
virtual void	ProcessItem (float posX, float posY, std::shared_ptr< CGUIListItem > &item, bool focused, unsigned int currentTime, CDirtyRegionList &dirtyregions)
void	Render () override
virtual void	RenderItem (float posX, float posY, CGUIListItem *item, bool focused)
virtual void	Scroll (int amount)
virtual bool	MoveDown (bool wrapAround)
virtual bool	MoveUp (bool wrapAround)
virtual bool	GetOffsetRange (int &minOffset, int &maxOffset) const
virtual void	ValidateOffset ()
virtual int	CorrectOffset (int offset, int cursor) const
virtual void	UpdateLayout (bool refreshAllItems=false)
virtual void	SetPageControlRange ()
virtual void	UpdatePageControl (int offset)
virtual void	CalculateLayout ()
virtual void	SelectItem (int item)
virtual bool	SelectItemFromPoint (const CPoint &point)
virtual int	GetCursorFromPoint (const CPoint &point, CPoint *itemPoint=NULL) const
virtual void	Reset ()
virtual size_t	GetNumItems () const
virtual int	GetCurrentPage () const
bool	InsideLayout (const CGUIListItemLayout *layout, const CPoint &point) const
void	OnFocus () override
void	OnUnFocus () override
void	UpdateListProvider (bool forceRefresh=false)
int	ScrollCorrectionRange () const
float	Size () const
void	FreeMemory (int keepStart, int keepEnd)
void	GetCurrentLayouts ()
CGUIListItemLayout *	GetFocusedLayout () const
virtual void	ScrollToOffset (int offset)
void	SetContainerMoving (int direction)
void	UpdateScrollOffset (unsigned int currentTime)
void	UpdateScrollByLetter ()
void	GetCacheOffsets (int &cacheBefore, int &cacheAfter) const
int	GetCacheCount () const
bool	ScrollingDown () const
bool	ScrollingUp () const
void	OnNextLetter ()
void	OnPrevLetter ()
void	OnJumpLetter (const std::string &letter, bool skip=false)
void	OnJumpSMS (int letter)
virtual void	SetCursor (int cursor)
	Set the cursor position Should be used by all base classes rather than directly setting it, as this also marks the control as dirty (if needed)
int	GetCursor () const
void	SetOffset (int offset)
	Set the container offset Should be used by all base classes rather than directly setting it, as this also marks the control as dirty (if needed)
int	GetOffset () const
	Returns the index of the first visible row returns the first row. This may be outside of the range of available items. Use GetItemOffset() to retrieve the first visible item in the list.
int	GetItemOffset () const
	Returns the index of the first visible item returns the first visible item. This will always be in the range of available items. Use GetOffset() to retrieve the first visible row in the list.
Protected Member Functions inherited from CGUIControl
virtual CPoint	GetPosition () const
	Return the coordinates of the top left of the control, in the control's parent coordinates.
virtual bool	CanFocusFromPoint (const CPoint &point) const
	Test whether we can focus a control from a point on screen.
virtual bool	UpdateColors (const CGUIListItem *item)
virtual bool	Animate (unsigned int currentTime)
virtual bool	CheckAnimation (ANIMATION_TYPE animType)
void	UpdateStates (ANIMATION_TYPE type, ANIMATION_PROCESS currentProcess, ANIMATION_STATE currentState)
bool	SendWindowMessage (CGUIMessage &message) const

Protected Attributes
CPoint	m_renderOffset
	render offset of the first item in the list
float	m_analogScrollCount
unsigned int	m_lastHoldTime
ORIENTATION	m_orientation
int	m_itemsPerPage
std::vector< std::shared_ptr< CGUIListItem > >	m_items
std::shared_ptr< CGUIListItem >	m_lastItem
int	m_pageControl
std::list< CGUIListItemLayout >	m_layouts
std::list< CGUIListItemLayout >	m_focusedLayouts
CGUIListItemLayout *	m_layout {nullptr}
CGUIListItemLayout *	m_focusedLayout {nullptr}
bool	m_layoutCondition = false
bool	m_focusedLayoutCondition = false
CScroller	m_scroller
std::unique_ptr< IListProvider >	m_listProvider
bool	m_wasReset
std::vector< std::pair< int, std::string > >	m_letterOffsets
INFO::InfoPtr	m_autoScrollCondition
int	m_autoScrollMoveTime
unsigned int	m_autoScrollDelayTime
bool	m_autoScrollIsReversed
unsigned int	m_lastRenderTime
Protected Attributes inherited from IGUIContainer
VIEW_TYPE	m_type = VIEW_TYPE_NONE
std::string	m_label
Protected Attributes inherited from CGUIControl
ActionMap	m_actions
float	m_posX
float	m_posY
float	m_height
float	m_width
CRect	m_hitRect
KODI::UTILS::COLOR::Color	m_hitColor = 0xffffffff
KODI::GUILIB::GUIINFO::CGUIInfoColor	m_diffuseColor
int	m_controlID
int	m_parentID
bool	m_bHasFocus
bool	m_bInvalidated
bool	m_bAllocated
bool	m_pulseOnSelect
GUICONTROLTYPES	ControlType
GUICONTROLSTATS *	m_controlStats
CGUIControl *	m_parentControl
INFO::InfoPtr	m_visibleCondition
GUIVISIBLE	m_visible
bool	m_visibleFromSkinCondition
bool	m_forceHidden
KODI::GUILIB::GUIINFO::CGUIInfoBool	m_allowHiddenFocus
bool	m_hasProcessed
INFO::InfoPtr	m_enableCondition
bool	m_enabled
bool	m_pushedUpdates
std::vector< CAnimation >	m_animations
CPoint	m_camera
bool	m_hasCamera
float	m_stereo
TransformMatrix	m_transform
TransformMatrix	m_cachedTransform
bool	m_isCulled {true}
unsigned int	m_controlDirtyState
CRect	m_renderRegion

Additional Inherited Members
Public Types inherited from CGUIControl
enum	GUICONTROLTYPES {   GUICONTROL_UNKNOWN , GUICONTAINER_EPGGRID , GUICONTAINER_FIXEDLIST , GUICONTAINER_LIST ,   GUICONTAINER_PANEL , GUICONTAINER_WRAPLIST , GUICONTROL_BORDEREDIMAGE , GUICONTROL_BUTTON ,   GUICONTROL_COLORBUTTON , GUICONTROL_EDIT , GUICONTROL_FADELABEL , GUICONTROL_GAME ,   GUICONTROL_GAMECONTROLLER , GUICONTROL_GAMECONTROLLERLIST , GUICONTROL_GROUP , GUICONTROL_GROUPLIST ,   GUICONTROL_IMAGE , GUICONTROL_LABEL , GUICONTROL_LISTGROUP , GUICONTROL_LISTLABEL ,   GUICONTROL_MOVER , GUICONTROL_MULTI_IMAGE , GUICONTROL_PROGRESS , GUICONTROL_RADIO ,   GUICONTROL_RANGES , GUICONTROL_RENDERADDON , GUICONTROL_RESIZE , GUICONTROL_RSS ,   GUICONTROL_SCROLLBAR , GUICONTROL_SETTINGS_SLIDER , GUICONTROL_SLIDER , GUICONTROL_SPIN ,   GUICONTROL_SPINEX , GUICONTROL_TEXTBOX , GUICONTROL_TOGGLEBUTTON , GUICONTROL_VIDEO ,   GUICONTROL_VISUALISATION }
enum	GUIVISIBLE { HIDDEN = 0 , DELAYED , VISIBLE }
enum	GUISCROLLVALUE { FOCUS = 0 , NEVER , ALWAYS }
typedef std::map< int, CGUIAction >	ActionMap
	Set actions to perform on navigation.
Static Protected Attributes inherited from CGUIControl
static const unsigned int	DIRTY_STATE_CONTROL = 1
static const unsigned int	DIRTY_STATE_CHILD = 2

Member Typedef Documentation

iItems

std::vector<std::shared_ptr<CGUIListItem>>::iterator CGUIBaseContainer::iItems

protected

Constructor & Destructor Documentation

CGUIBaseContainer() [1/2]

CGUIBaseContainer::CGUIBaseContainer	(	int	parentID,
		int	controlID,
		float	posX,
		float	posY,
		float	width,
		float	height,
		ORIENTATION	orientation,
		const CScroller &	scroller,
		int	preloadItems )

CGUIBaseContainer() [2/2]

CGUIBaseContainer::CGUIBaseContainer ( const CGUIBaseContainer & other )

explicit

~CGUIBaseContainer()

CGUIBaseContainer::~CGUIBaseContainer ( void )

override

Member Function Documentation

AllocResources()

void CGUIBaseContainer::AllocResources ( )

overridevirtual

Reimplemented from CGUIControl.

AssignDepth()

void CGUIBaseContainer::AssignDepth ( )

overridevirtual

Reimplemented from CGUIControl.

CalculateLayout()

void CGUIBaseContainer::CalculateLayout ( )

protectedvirtual

Reimplemented in CGUIPanelContainer.

CanFocus()

bool CGUIBaseContainer::CanFocus ( ) const

overridevirtual

Reimplemented from CGUIControl.

CorrectOffset()

int CGUIBaseContainer::CorrectOffset ( int offset, int cursor ) const

protectedvirtual

Reimplemented in CGUIPanelContainer, and CGUIWrappingListContainer.

DoProcess()

void CGUIBaseContainer::DoProcess ( unsigned int currentTime, CDirtyRegionList & dirtyregions )

overridevirtual

Reimplemented from CGUIControl.

FreeMemory()

void CGUIBaseContainer::FreeMemory ( int keepStart, int keepEnd )

protected

FreeResources()

void CGUIBaseContainer::FreeResources ( bool immediately = false )

overridevirtual

Reimplemented from CGUIControl.

GetCacheCount()

int CGUIBaseContainer::GetCacheCount ( ) const

inlineprotected

GetCacheOffsets()

void CGUIBaseContainer::GetCacheOffsets ( int & cacheBefore, int & cacheAfter ) const

protected

GetCondition()

bool CGUIBaseContainer::GetCondition ( int condition, int data ) const

overridevirtual

Reimplemented from CGUIControl.

Reimplemented in CGUIPanelContainer.

GetCurrentLayouts()

void CGUIBaseContainer::GetCurrentLayouts ( )

protected

GetCurrentPage()

int CGUIBaseContainer::GetCurrentPage ( ) const

protectedvirtual

Reimplemented in CGUIFixedListContainer, and CGUIWrappingListContainer.

GetCursor()

int CGUIBaseContainer::GetCursor ( ) const

inlineprotected

GetCursorFromPoint()

virtual int CGUIBaseContainer::GetCursorFromPoint ( const CPoint & point, CPoint * itemPoint = NULL ) const

inlineprotectedvirtual

Reimplemented in CGUIFixedListContainer, CGUIListContainer, and CGUIPanelContainer.

GetDescription()

std::string CGUIBaseContainer::GetDescription ( void ) const

overridevirtual

Reimplemented from CGUIControl.

GetFocusedLayout()

CGUIListItemLayout * CGUIBaseContainer::GetFocusedLayout ( ) const

protected

GetItemOffset()

int CGUIBaseContainer::GetItemOffset ( ) const

inlineprotected

Returns the index of the first visible item returns the first visible item. This will always be in the range of available items. Use GetOffset() to retrieve the first visible row in the list.

See also

GetOffset

GetLabel()

std::string CGUIBaseContainer::GetLabel ( int info ) const

overridevirtual

Implements IGUIContainer.

Reimplemented in CGUIPanelContainer.

GetListItem()

std::shared_ptr< CGUIListItem > CGUIBaseContainer::GetListItem ( int offset, unsigned int flag = 0 ) const

overridevirtual

Implements IGUIContainer.

GetNumItems()

virtual size_t CGUIBaseContainer::GetNumItems ( ) const

inlineprotectedvirtual

Reimplemented in CGUIWrappingListContainer.

GetOffset()

int CGUIBaseContainer::GetOffset ( ) const

inlineprotected

Returns the index of the first visible row returns the first row. This may be outside of the range of available items. Use GetItemOffset() to retrieve the first visible item in the list.

See also

GetItemOffset

GetOffsetRange()

bool CGUIBaseContainer::GetOffsetRange ( int & minOffset, int & maxOffset ) const

protectedvirtual

Reimplemented in CGUIFixedListContainer, and CGUIWrappingListContainer.

GetRows()

unsigned int CGUIBaseContainer::GetRows ( ) const

virtual

Reimplemented in CGUIPanelContainer.

GetSelectedItem()

int CGUIBaseContainer::GetSelectedItem ( ) const

virtual

Reimplemented in CGUIWrappingListContainer.

HasNextPage()

bool CGUIBaseContainer::HasNextPage ( ) const

virtual

Reimplemented in CGUIFixedListContainer, CGUIListContainer, and CGUIPanelContainer.

HasPreviousPage()

bool CGUIBaseContainer::HasPreviousPage ( ) const

virtual

Reimplemented in CGUIFixedListContainer, CGUIListContainer, and CGUIPanelContainer.

InsideLayout()

bool CGUIBaseContainer::InsideLayout ( const CGUIListItemLayout * layout, const CPoint & point ) const

protected

LoadLayout()

void CGUIBaseContainer::LoadLayout

(

TiXmlElement *

layout

)

LoadListProvider()

void CGUIBaseContainer::LoadListProvider	(	TiXmlElement *	content,
		int	defaultItem,
		bool	defaultAlways )

MoveDown()

bool CGUIBaseContainer::MoveDown ( bool wrapAround )

protectedvirtual

Reimplemented in CGUIFixedListContainer, CGUIListContainer, CGUIPanelContainer, and CGUIWrappingListContainer.

MoveUp()

bool CGUIBaseContainer::MoveUp ( bool wrapAround )

protectedvirtual

Reimplemented in CGUIFixedListContainer, CGUIListContainer, CGUIPanelContainer, and CGUIWrappingListContainer.

OnAction()

bool CGUIBaseContainer::OnAction ( const CAction & action )

overridevirtual

Reimplemented from CGUIControl.

Reimplemented in CGUIFixedListContainer, CGUIListContainer, CGUIPanelContainer, and CGUIWrappingListContainer.

OnClick()

bool CGUIBaseContainer::OnClick ( int actionID )

protected

OnDown()

void CGUIBaseContainer::OnDown ( )

overridevirtual

Reimplemented from CGUIControl.

Reimplemented in CGUIPanelContainer.

OnFocus()

void CGUIBaseContainer::OnFocus ( )

overrideprotectedvirtual

Reimplemented from CGUIControl.

OnJumpLetter()

void CGUIBaseContainer::OnJumpLetter ( const std::string & letter, bool skip = false )

protected

OnJumpSMS()

void CGUIBaseContainer::OnJumpSMS ( int letter )

protected

OnLeft()

void CGUIBaseContainer::OnLeft ( )

overridevirtual

Reimplemented from CGUIControl.

Reimplemented in CGUIPanelContainer.

OnMessage()

bool CGUIBaseContainer::OnMessage ( CGUIMessage & message )

overridevirtual

Reimplemented from CGUIControl.

Reimplemented in CGUIListContainer, CGUIPanelContainer, and CGUIWrappingListContainer.

OnMouseEvent()

EVENT_RESULT CGUIBaseContainer::OnMouseEvent ( const CPoint & point, const KODI::MOUSE::CMouseEvent & event )

overrideprotectedvirtual

Perform a mouse action.

Mouse actions are sent from the window to all controls, and each control can react based on the event and location of the actions.

Parameters

point	the location in transformed skin coordinates from the upper left corner of the parent control.
event	the mouse event to perform

Returns

EVENT_RESULT corresponding to whether the control handles this event

See also

SendMouseEvent, HitTest, CanFocusFromPoint, CMouseEvent

Reimplemented from CGUIControl.

OnMouseOver()

bool CGUIBaseContainer::OnMouseOver ( const CPoint & point )

overridevirtual

Called when the mouse is over the control. Default implementation selects the control.

Parameters

point

location of the mouse in transformed skin coordinates

Returns

true if handled, false otherwise.

Reimplemented from CGUIControl.

OnNextLetter()

void CGUIBaseContainer::OnNextLetter ( )

protected

OnPrevLetter()

void CGUIBaseContainer::OnPrevLetter ( )

protected

OnRight()

void CGUIBaseContainer::OnRight ( )

overridevirtual

Reimplemented from CGUIControl.

Reimplemented in CGUIPanelContainer.

OnUnFocus()

void CGUIBaseContainer::OnUnFocus ( void )

overrideprotectedvirtual

Reimplemented from CGUIControl.

OnUp()

void CGUIBaseContainer::OnUp ( )

overridevirtual

Reimplemented from CGUIControl.

Reimplemented in CGUIPanelContainer.

Process()

void CGUIBaseContainer::Process ( unsigned int currentTime, CDirtyRegionList & dirtyregions )

overridevirtual

Reimplemented from CGUIControl.

Reimplemented in CGUIPanelContainer.

ProcessItem()

void CGUIBaseContainer::ProcessItem ( float posX, float posY, std::shared_ptr< CGUIListItem > & item, bool focused, unsigned int currentTime, CDirtyRegionList & dirtyregions )

protectedvirtual

Render()

void CGUIBaseContainer::Render ( )

overrideprotectedvirtual

Reimplemented from CGUIControl.

Reimplemented in CGUIPanelContainer.

RenderItem()

void CGUIBaseContainer::RenderItem ( float posX, float posY, CGUIListItem * item, bool focused )

protectedvirtual

Reset()

void CGUIBaseContainer::Reset ( )

protectedvirtual

Reimplemented in CGUIWrappingListContainer.

ResetAutoScrolling()

void CGUIBaseContainer::ResetAutoScrolling

(

)

SaveStates()

void CGUIBaseContainer::SaveStates ( std::vector< CControlState > & states )

overridevirtual

Reimplemented from CGUIControl.

Scroll()

void CGUIBaseContainer::Scroll ( int amount )

protectedvirtual

Reimplemented in CGUIFixedListContainer, CGUIListContainer, CGUIPanelContainer, and CGUIWrappingListContainer.

ScrollCorrectionRange()

int CGUIBaseContainer::ScrollCorrectionRange ( ) const

protected

ScrollingDown()

bool CGUIBaseContainer::ScrollingDown ( ) const

inlineprotected

ScrollingUp()

bool CGUIBaseContainer::ScrollingUp ( ) const

inlineprotected

ScrollToOffset()

void CGUIBaseContainer::ScrollToOffset ( int offset )

protectedvirtual

Reimplemented in CGUIPanelContainer.

SelectItem()

virtual void CGUIBaseContainer::SelectItem ( int item )

inlineprotectedvirtual

Reimplemented in CGUIFixedListContainer, CGUIListContainer, CGUIPanelContainer, and CGUIWrappingListContainer.

SelectItemFromPoint()

virtual bool CGUIBaseContainer::SelectItemFromPoint ( const CPoint & point )

inlineprotectedvirtual

Reimplemented in CGUIFixedListContainer, CGUIListContainer, CGUIPanelContainer, and CGUIWrappingListContainer.

SetAutoScrolling()

void CGUIBaseContainer::SetAutoScrolling

(

const TiXmlNode *

node

)

SetClickActions()

void CGUIBaseContainer::SetClickActions ( const CGUIAction & clickActions )

inline

SetContainerMoving()

void CGUIBaseContainer::SetContainerMoving ( int direction )

protected

SetCursor()

void CGUIBaseContainer::SetCursor ( int cursor )

protectedvirtual

Set the cursor position Should be used by all base classes rather than directly setting it, as this also marks the control as dirty (if needed)

Reimplemented in CGUIListContainer, and CGUIPanelContainer.

SetFocus()

void CGUIBaseContainer::SetFocus ( bool bOnOff )

overridevirtual

Reimplemented from CGUIControl.

SetFocusActions()

void CGUIBaseContainer::SetFocusActions ( const CGUIAction & focusActions )

inline

SetListProvider()

void CGUIBaseContainer::SetListProvider

(

std::unique_ptr< IListProvider >

provider

)

Set the list provider for this container (for python).

Parameters

provider

the list provider to use for this container.

SetOffset()

void CGUIBaseContainer::SetOffset ( int offset )

protected

Set the container offset Should be used by all base classes rather than directly setting it, as this also marks the control as dirty (if needed)

SetPageControl()

void CGUIBaseContainer::SetPageControl

(

int

id

)

SetPageControlRange()

void CGUIBaseContainer::SetPageControlRange ( )

protectedvirtual

Reimplemented in CGUIWrappingListContainer.

SetRenderOffset()

void CGUIBaseContainer::SetRenderOffset

(

const CPoint &

offset

)

Set the offset of the first item in the container from the container's position Useful for lists/panels where the focused item may be larger than the non-focused items and thus normally cut off from the clipping window defined by the container's position + size.

Parameters

offset

CPoint holding the offset in skin coordinates.

SetUnFocusActions()

void CGUIBaseContainer::SetUnFocusActions ( const CGUIAction & unfocusActions )

inline

Size()

float CGUIBaseContainer::Size ( ) const

inlineprotected

UpdateAutoScrolling()

void CGUIBaseContainer::UpdateAutoScrolling

(

unsigned int

currentTime

)

UpdateLayout()

void CGUIBaseContainer::UpdateLayout ( bool refreshAllItems = false )

protectedvirtual

UpdateListProvider()

void CGUIBaseContainer::UpdateListProvider ( bool forceRefresh = false )

protected

UpdatePageControl()

void CGUIBaseContainer::UpdatePageControl ( int offset )

protectedvirtual

Reimplemented in CGUIWrappingListContainer.

UpdateScrollByLetter()

void CGUIBaseContainer::UpdateScrollByLetter ( )

protected

UpdateScrollOffset()

void CGUIBaseContainer::UpdateScrollOffset ( unsigned int currentTime )

protected

UpdateVisibility()

void CGUIBaseContainer::UpdateVisibility ( const CGUIListItem * item = NULL )

overridevirtual

Reimplemented from CGUIControl.

ValidateOffset()

void CGUIBaseContainer::ValidateOffset ( )

protectedvirtual

Reimplemented in CGUIFixedListContainer, CGUIListContainer, CGUIPanelContainer, and CGUIWrappingListContainer.

Member Data Documentation

m_analogScrollCount

float CGUIBaseContainer::m_analogScrollCount

protected

m_autoScrollCondition

INFO::InfoPtr CGUIBaseContainer::m_autoScrollCondition

protected

m_autoScrollDelayTime

unsigned int CGUIBaseContainer::m_autoScrollDelayTime

protected

m_autoScrollIsReversed

bool CGUIBaseContainer::m_autoScrollIsReversed

protected

m_autoScrollMoveTime

int CGUIBaseContainer::m_autoScrollMoveTime

protected

m_focusedLayout

CGUIListItemLayout* CGUIBaseContainer::m_focusedLayout {nullptr}

protected

m_focusedLayoutCondition

bool CGUIBaseContainer::m_focusedLayoutCondition = false

protected

m_focusedLayouts

std::list<CGUIListItemLayout> CGUIBaseContainer::m_focusedLayouts

protected

m_items

std::vector<std::shared_ptr<CGUIListItem> > CGUIBaseContainer::m_items

protected

m_itemsPerPage

int CGUIBaseContainer::m_itemsPerPage

protected

m_lastHoldTime

unsigned int CGUIBaseContainer::m_lastHoldTime

protected

m_lastItem

std::shared_ptr<CGUIListItem> CGUIBaseContainer::m_lastItem

protected

m_lastRenderTime

unsigned int CGUIBaseContainer::m_lastRenderTime

protected

m_layout

CGUIListItemLayout* CGUIBaseContainer::m_layout {nullptr}

protected

m_layoutCondition

bool CGUIBaseContainer::m_layoutCondition = false

protected

m_layouts

std::list<CGUIListItemLayout> CGUIBaseContainer::m_layouts

protected

m_letterOffsets

std::vector< std::pair<int, std::string> > CGUIBaseContainer::m_letterOffsets

protected

m_listProvider

std::unique_ptr<IListProvider> CGUIBaseContainer::m_listProvider

protected

m_orientation

ORIENTATION CGUIBaseContainer::m_orientation

protected

m_pageControl

int CGUIBaseContainer::m_pageControl

protected

m_renderOffset

CPoint CGUIBaseContainer::m_renderOffset

protected

render offset of the first item in the list

See also

SetRenderOffset

m_scroller

CScroller CGUIBaseContainer::m_scroller

protected

m_wasReset

bool CGUIBaseContainer::m_wasReset

protected

---

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

• GUIBaseContainer.h
• GUIBaseContainer.cpp