PVR::CPVRGUIChannelNavigator Class Reference

#include <PVRGUIChannelNavigator.h>

Public Member Functions
	CPVRGUIChannelNavigator ()
virtual	~CPVRGUIChannelNavigator ()
template<typename A >
void	Subscribe (A *owner, void(A::*fn)(const PVRPreviewAndPlayerShowInfoChangedEvent &))
	Subscribe to the event stream for changes of channel preview and player show info.
template<typename A >
void	Unsubscribe (A *obj)
	Unsubscribe from the event stream for changes of channel preview and player show info.
void	Notify (const KODI::GUILIB::GUIINFO::PlayerShowInfoChangedEvent &event)
	CEventStream callback for player show info flag changes.
void	SelectNextChannel (ChannelSwitchMode eSwitchMode)
	Select the next channel in currently playing channel group, relative to the currently selected channel.
void	SelectPreviousChannel (ChannelSwitchMode eSwitchMode)
	Select the previous channel in currently playing channel group, relative to the currently selected channel.
void	SwitchToCurrentChannel ()
	Switch to the currently selected channel.
bool	IsPreview () const
	Query the state of channel preview.
bool	IsPreviewAndShowInfo () const
	Query the state of channel preview and channel info OSD.
void	ShowInfo ()
	Show the channel info OSD.
void	HideInfo ()
	Hide the channel info OSD.
void	ToggleInfo ()
	Toggle the channel info OSD visibility.
void	SetPlayingChannel (const std::shared_ptr< CPVRChannelGroupMember > &groupMember)
	Set a new playing channel group member and show the channel info OSD for the new channel.
void	ClearPlayingChannel ()
	Clear the currently playing channel and hide the channel info OSD.

Constructor & Destructor Documentation

CPVRGUIChannelNavigator()

CPVRGUIChannelNavigator::CPVRGUIChannelNavigator

(

)

~CPVRGUIChannelNavigator()

CPVRGUIChannelNavigator::~CPVRGUIChannelNavigator ( )

virtual

Member Function Documentation

ClearPlayingChannel()

void CPVRGUIChannelNavigator::ClearPlayingChannel

(

)

Clear the currently playing channel and hide the channel info OSD.

HideInfo()

void CPVRGUIChannelNavigator::HideInfo

(

)

Hide the channel info OSD.

IsPreview()

bool CPVRGUIChannelNavigator::IsPreview

(

)

const

Query the state of channel preview.

Returns

True, if the currently selected channel is different from the currently playing channel, False otherwise.

IsPreviewAndShowInfo()

bool CPVRGUIChannelNavigator::IsPreviewAndShowInfo

(

)

const

Query the state of channel preview and channel info OSD.

Returns

True, if the currently selected channel is different from the currently playing channel and channel info OSD is active, False otherwise.

Notify()

void CPVRGUIChannelNavigator::Notify

(

const KODI::GUILIB::GUIINFO::PlayerShowInfoChangedEvent &

event

)

CEventStream callback for player show info flag changes.

Parameters

event

The event.

SelectNextChannel()

void CPVRGUIChannelNavigator::SelectNextChannel

(

ChannelSwitchMode

eSwitchMode

)

Select the next channel in currently playing channel group, relative to the currently selected channel.

Parameters

eSwitchMode

controls whether only the channel info OSD is triggered or whether additionally a (delayed) channel switch will be done.

SelectPreviousChannel()

void CPVRGUIChannelNavigator::SelectPreviousChannel

(

ChannelSwitchMode

eSwitchMode

)

Select the previous channel in currently playing channel group, relative to the currently selected channel.

Parameters

eSwitchMode

controls whether only the channel info OSD is triggered or whether additionally a (delayed) channel switch will be done.

SetPlayingChannel()

void CPVRGUIChannelNavigator::SetPlayingChannel

(

const std::shared_ptr< CPVRChannelGroupMember > &

groupMember

)

Set a new playing channel group member and show the channel info OSD for the new channel.

Parameters

groupMember

The new playing channel group member

ShowInfo()

void CPVRGUIChannelNavigator::ShowInfo

(

)

Show the channel info OSD.

Subscribe()

template<typename A >

void PVR::CPVRGUIChannelNavigator::Subscribe ( A * owner, void(A::*)(const PVRPreviewAndPlayerShowInfoChangedEvent &) fn )

inline

Subscribe to the event stream for changes of channel preview and player show info.

Parameters

owner	The subscriber.
fn	The callback function of the subscriber for the events.

SwitchToCurrentChannel()

void CPVRGUIChannelNavigator::SwitchToCurrentChannel

(

)

Switch to the currently selected channel.

ToggleInfo()

void CPVRGUIChannelNavigator::ToggleInfo

(

)

Toggle the channel info OSD visibility.

Unsubscribe()

template<typename A >

void PVR::CPVRGUIChannelNavigator::Unsubscribe ( A * obj )

inline

Unsubscribe from the event stream for changes of channel preview and player show info.

Parameters

obj	The subscriber.

---

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

• PVRGUIChannelNavigator.h
• PVRGUIChannelNavigator.cpp