Inheritance diagram for PVR::CPVRGUIActionsChannels:

Collaboration diagram for PVR::CPVRGUIActionsChannels:

Public Member Functions
CEventStream< PVRChannelNumberInputChangedEvent > &	Events ()
	Get the events available for CEventStream. More...

void	RegisterChannelNumberInputHandler (CPVRChannelNumberInputHandler *handler)
	Register a handler for channel number input. More...

void	DeregisterChannelNumberInputHandler (CPVRChannelNumberInputHandler *handler)
	Deregister a handler for channel number input. More...

void	Notify (const PVRChannelNumberInputChangedEvent &event)
	CEventStream callback for channel number input changes. More...

bool	HideChannel (const CFileItem &item) const
	Hide a channel, always showing a confirmation dialog. More...

bool	StartChannelScan ()
	Open a selection dialog and start a channel scan on the selected client. More...

bool	StartChannelScan (int clientId)
	Start a channel scan on the specified client or open a dialog to select a client. More...

bool	IsRunningChannelScan () const

std::shared_ptr< CPVRChannelGroupMember >	GetChannelGroupMember (const std::shared_ptr< const CPVRChannel > &channel) const
	Get a channel group member for the given channel, either from the currently active group or if not found there, from the 'all channels' group. More...

std::shared_ptr< CPVRChannelGroupMember >	GetChannelGroupMember (const CFileItem &item) const
	Get a channel group member for the given item, either from the currently active group or if not found there, from the 'all channels' group. More...

CPVRChannelNumberInputHandler &	GetChannelNumberInputHandler ()
	Get the currently active channel number input handler. More...

CPVRGUIChannelNavigator &	GetChannelNavigator ()
	Get the channel navigator. More...

void	OnPlaybackStarted (const CFileItem &item)
	Inform GUI actions that playback of an item just started. More...

void	OnPlaybackStopped (const CFileItem &item)
	Inform GUI actions that playback of an item was stopped due to user interaction. More...

std::string	GetSelectedChannelPath (bool bRadio) const
	Get the currently selected channel item path; used across several windows/dialogs to share item selection. More...

void	SetSelectedChannelPath (bool bRadio, const std::string &path)
	Set the currently selected channel item path; used across several windows/dialogs to share item selection. More...

Member Function Documentation

◆ DeregisterChannelNumberInputHandler()

void CPVRGUIActionsChannels::DeregisterChannelNumberInputHandler ( CPVRChannelNumberInputHandler * handler )

Deregister a handler for channel number input.

Parameters

handler The handler to deregister.

◆ Events()

CEventStream<PVRChannelNumberInputChangedEvent>& PVR::CPVRGUIActionsChannels::Events ( )

inline

Get the events available for CEventStream.

Returns: The events.

◆ GetChannelGroupMember() [1/2]

std::shared_ptr< CPVRChannelGroupMember > CPVRGUIActionsChannels::GetChannelGroupMember ( const std::shared_ptr< const CPVRChannel > & channel ) const

Get a channel group member for the given channel, either from the currently active group or if not found there, from the 'all channels' group.

Parameters

channel the channel.

Returns: the group member or nullptr if not found.

◆ GetChannelGroupMember() [2/2]

std::shared_ptr< CPVRChannelGroupMember > CPVRGUIActionsChannels::GetChannelGroupMember ( const CFileItem & item ) const

Get a channel group member for the given item, either from the currently active group or if not found there, from the 'all channels' group.

Parameters

item	the item containing a channel, channel group, recording, timer or epg tag.

Returns: the group member or nullptr if not found.

◆ GetChannelNavigator()

CPVRGUIChannelNavigator & CPVRGUIActionsChannels::GetChannelNavigator ( )

Get the channel navigator.

Returns: the navigator.

◆ GetChannelNumberInputHandler()

CPVRChannelNumberInputHandler & CPVRGUIActionsChannels::GetChannelNumberInputHandler ( )

Get the currently active channel number input handler.

Returns: the handler.

◆ GetSelectedChannelPath()

std::string CPVRGUIActionsChannels::GetSelectedChannelPath ( bool bRadio ) const

Get the currently selected channel item path; used across several windows/dialogs to share item selection.

Parameters

bRadio True to query the selected path for PVR radio, false for Live TV.

Returns: the path.

◆ HideChannel()

bool CPVRGUIActionsChannels::HideChannel ( const CFileItem & item ) const

Hide a channel, always showing a confirmation dialog.

Parameters

item	containing a channel or an epg tag.

Returns: true on success, false otherwise.

◆ IsRunningChannelScan()

bool PVR::CPVRGUIActionsChannels::IsRunningChannelScan ( ) const

inline

Returns: True when a channel scan is currently running, false otherwise.

◆ Notify()

void CPVRGUIActionsChannels::Notify ( const PVRChannelNumberInputChangedEvent & event )

CEventStream callback for channel number input changes.

Parameters

event The event.

◆ OnPlaybackStarted()

void CPVRGUIActionsChannels::OnPlaybackStarted ( const CFileItem & item )

Inform GUI actions that playback of an item just started.

Parameters

item	The item that started to play.

◆ OnPlaybackStopped()

void CPVRGUIActionsChannels::OnPlaybackStopped ( const CFileItem & item )

Inform GUI actions that playback of an item was stopped due to user interaction.

Parameters

item	The item that stopped to play.

◆ RegisterChannelNumberInputHandler()

void CPVRGUIActionsChannels::RegisterChannelNumberInputHandler ( CPVRChannelNumberInputHandler * handler )

Register a handler for channel number input.

Parameters

handler The handler to register.

◆ SetSelectedChannelPath()

void CPVRGUIActionsChannels::SetSelectedChannelPath	(	bool	bRadio,
		const std::string &	path
	)

Set the currently selected channel item path; used across several windows/dialogs to share item selection.

Parameters

bRadio	True to set the selected path for PVR radio, false for Live TV.
path	The new path to set.

◆ StartChannelScan() [1/2]

bool CPVRGUIActionsChannels::StartChannelScan ( )

Open a selection dialog and start a channel scan on the selected client.

Returns: true on success, false otherwise.

◆ StartChannelScan() [2/2]

bool CPVRGUIActionsChannels::StartChannelScan ( int clientId )

Start a channel scan on the specified client or open a dialog to select a client.

Parameters

clientId the id of client to scan or PVR_INVALID_CLIENT_ID if a dialog will be opened

Returns: true on success, false otherwise.

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

xbmc/pvr/guilib/PVRGUIActionsChannels.h
xbmc/pvr/guilib/PVRGUIActionsChannels.cpp

Public Member Functions

Member Function Documentation

◆ DeregisterChannelNumberInputHandler()

◆ Events()

◆ GetChannelGroupMember() [1/2]

◆ GetChannelGroupMember() [2/2]

◆ GetChannelNavigator()

◆ GetChannelNumberInputHandler()

◆ GetSelectedChannelPath()

◆ HideChannel()

◆ IsRunningChannelScan()

◆ Notify()

◆ OnPlaybackStarted()

◆ OnPlaybackStopped()

◆ RegisterChannelNumberInputHandler()

◆ SetSelectedChannelPath()

◆ StartChannelScan() [1/2]

◆ StartChannelScan() [2/2]