PVR::CGUIEPGGridContainer Class Reference

#include <GUIEPGGridContainer.h>

Inheritance diagram for PVR::CGUIEPGGridContainer:

Public Member Functions
	CGUIEPGGridContainer (int parentID, int controlID, float posX, float posY, float width, float height, ORIENTATION orientation, int scrollTime, int preloadItems, int minutesPerPage, int rulerUnit, const CTextureInfo &progressIndicatorTexture)
	CGUIEPGGridContainer (const CGUIEPGGridContainer &other)
CGUIEPGGridContainer *	Clone () const override
bool	HasData () const
	Check whether the control currently holds data.
void	AllocResources () override
void	FreeResources (bool immediately) 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	OnMessage (CGUIMessage &message) override
void	SetFocus (bool focus) override
std::string	GetDescription () const override
EVENT_RESULT	OnMouseEvent (const CPoint &point, const KODI::MOUSE::CMouseEvent &event) override
	Perform a mouse action.
void	Process (unsigned int currentTime, CDirtyRegionList &dirtyregions) override
void	Render () override
std::shared_ptr< CGUIListItem >	GetListItem (int offset, unsigned int flag=0) const override
std::string	GetLabel (int info) const override
std::shared_ptr< CFileItem >	GetSelectedGridItem (int offset=0) const
std::shared_ptr< CPVRChannelGroupMember >	GetSelectedChannelGroupMember () const
CDateTime	GetSelectedDate () const
void	LoadLayout (TiXmlElement *layout)
void	SetPageControl (int id)
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	JumpToNow ()
void	JumpToDate (const CDateTime &date)
void	GoToBegin ()
void	GoToEnd ()
void	GoToNow ()
void	GoToDate (const CDateTime &date)
void	GoToFirstChannel ()
void	GoToLastChannel ()
void	GoToTop ()
void	GoToBottom ()
void	GoToMostLeft ()
void	GoToMostRight ()
void	SetTimelineItems (const std::unique_ptr< CFileItemList > &items, const CDateTime &gridStart, const CDateTime &gridEnd)
std::unique_ptr< CFileItemList >	GetCurrentTimeLineItems () const
bool	SetChannel (const std::shared_ptr< CPVRChannel > &channel)
	Set the control's selection to the given channel and set the control's view port to show the channel.
bool	SetChannel (const std::string &channel)
	Set the control's selection to the given channel and set the control's view port to show the channel.
bool	SetChannel (const CPVRChannelNumber &channelNumber)
	Set the control's selection to the given channel and set the control's view port to show the channel.
virtual void	AssignDepth () override
void	AssignItemDepth (CGUIListItem *item, bool focused)
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 void	DoProcess (unsigned int currentTime, CDirtyRegionList &dirtyregions)
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 void	OnFocus ()
virtual void	OnUnFocus ()
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	CanFocus () const
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 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	UpdateVisibility (const CGUIListItem *item)
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
virtual bool	GetCondition (int condition, int data) const
void	SetParentControl (CGUIControl *control)
CGUIControl *	GetParentControl (void) const
virtual void	SaveStates (std::vector< CControlState > &states)
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)

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.
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 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
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
Static Protected Attributes inherited from CGUIControl
static const unsigned int	DIRTY_STATE_CONTROL = 1
static const unsigned int	DIRTY_STATE_CHILD = 2

Constructor & Destructor Documentation

CGUIEPGGridContainer() [1/2]

CGUIEPGGridContainer::CGUIEPGGridContainer	(	int	parentID,
		int	controlID,
		float	posX,
		float	posY,
		float	width,
		float	height,
		ORIENTATION	orientation,
		int	scrollTime,
		int	preloadItems,
		int	minutesPerPage,
		int	rulerUnit,
		const CTextureInfo &	progressIndicatorTexture )

CGUIEPGGridContainer() [2/2]

CGUIEPGGridContainer::CGUIEPGGridContainer

(

const CGUIEPGGridContainer &

other

)

Member Function Documentation

AllocResources()

void CGUIEPGGridContainer::AllocResources ( )

overridevirtual

Reimplemented from CGUIControl.

AssignDepth()

void CGUIEPGGridContainer::AssignDepth ( )

overridevirtual

Reimplemented from CGUIControl.

AssignItemDepth()

void CGUIEPGGridContainer::AssignItemDepth	(	CGUIListItem *	item,
		bool	focused )

Clone()

CGUIEPGGridContainer * PVR::CGUIEPGGridContainer::Clone ( void ) const

inlineoverridevirtual

Implements CGUIControl.

FreeResources()

void CGUIEPGGridContainer::FreeResources ( bool immediately )

overridevirtual

Reimplemented from CGUIControl.

GetCurrentTimeLineItems()

std::unique_ptr< CFileItemList > CGUIEPGGridContainer::GetCurrentTimeLineItems

(

)

const

GetDescription()

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

overridevirtual

Reimplemented from CGUIControl.

GetLabel()

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

overridevirtual

Implements IGUIContainer.

GetListItem()

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

overridevirtual

Implements IGUIContainer.

GetSelectedChannelGroupMember()

std::shared_ptr< CPVRChannelGroupMember > CGUIEPGGridContainer::GetSelectedChannelGroupMember

(

)

const

GetSelectedDate()

CDateTime CGUIEPGGridContainer::GetSelectedDate

(

)

const

GetSelectedGridItem()

CFileItemPtr CGUIEPGGridContainer::GetSelectedGridItem

(

int

offset = 0

)

const

GoToBegin()

void CGUIEPGGridContainer::GoToBegin

(

)

GoToBottom()

void CGUIEPGGridContainer::GoToBottom

(

)

GoToDate()

void CGUIEPGGridContainer::GoToDate

(

const CDateTime &

date

)

GoToEnd()

void CGUIEPGGridContainer::GoToEnd

(

)

GoToFirstChannel()

void CGUIEPGGridContainer::GoToFirstChannel

(

)

GoToLastChannel()

void CGUIEPGGridContainer::GoToLastChannel

(

)

GoToMostLeft()

void CGUIEPGGridContainer::GoToMostLeft

(

)

GoToMostRight()

void CGUIEPGGridContainer::GoToMostRight

(

)

GoToNow()

void CGUIEPGGridContainer::GoToNow

(

)

GoToTop()

void CGUIEPGGridContainer::GoToTop

(

)

HasData()

bool CGUIEPGGridContainer::HasData

(

)

const

Check whether the control currently holds data.

Returns

true if the control has data, false otherwise.

JumpToDate()

void CGUIEPGGridContainer::JumpToDate

(

const CDateTime &

date

)

JumpToNow()

void CGUIEPGGridContainer::JumpToNow

(

)

LoadLayout()

void CGUIEPGGridContainer::LoadLayout

(

TiXmlElement *

layout

)

OnAction()

bool CGUIEPGGridContainer::OnAction ( const CAction & action )

overridevirtual

Reimplemented from CGUIControl.

OnDown()

void CGUIEPGGridContainer::OnDown ( )

overridevirtual

Reimplemented from CGUIControl.

OnLeft()

void CGUIEPGGridContainer::OnLeft ( )

overridevirtual

Reimplemented from CGUIControl.

OnMessage()

bool CGUIEPGGridContainer::OnMessage ( CGUIMessage & message )

overridevirtual

Reimplemented from CGUIControl.

OnMouseEvent()

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

overridevirtual

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 CGUIEPGGridContainer::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.

OnRight()

void CGUIEPGGridContainer::OnRight ( )

overridevirtual

Reimplemented from CGUIControl.

OnUp()

void CGUIEPGGridContainer::OnUp ( )

overridevirtual

Reimplemented from CGUIControl.

Process()

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

overridevirtual

Reimplemented from CGUIControl.

Render()

void CGUIEPGGridContainer::Render ( )

overridevirtual

Reimplemented from CGUIControl.

SetChannel() [1/3]

bool CGUIEPGGridContainer::SetChannel

(

const CPVRChannelNumber &

channelNumber

)

Set the control's selection to the given channel and set the control's view port to show the channel.

Parameters

channelNumber

the channel's number.

Returns

true if the selection was set to the given channel, false otherwise.

SetChannel() [2/3]

bool CGUIEPGGridContainer::SetChannel

(

const std::shared_ptr< CPVRChannel > &

channel

)

Set the control's selection to the given channel and set the control's view port to show the channel.

Parameters

channel

the channel.

Returns

true if the selection was set to the given channel, false otherwise.

SetChannel() [3/3]

bool CGUIEPGGridContainer::SetChannel

(

const std::string &

channel

)

Set the control's selection to the given channel and set the control's view port to show the channel.

Parameters

channel

the channel's path.

Returns

true if the selection was set to the given channel, false otherwise.

SetFocus()

void CGUIEPGGridContainer::SetFocus ( bool focus )

overridevirtual

Reimplemented from CGUIControl.

SetPageControl()

void CGUIEPGGridContainer::SetPageControl

(

int

id

)

SetRenderOffset()

void CGUIEPGGridContainer::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.

SetTimelineItems()

void CGUIEPGGridContainer::SetTimelineItems	(	const std::unique_ptr< CFileItemList > &	items,
		const CDateTime &	gridStart,
		const CDateTime &	gridEnd )

---

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

• GUIEPGGridContainer.h
• GUIEPGGridContainer.cpp