Inheritance diagram for PVR::CPVRGUIActionsTimers:

Collaboration diagram for PVR::CPVRGUIActionsTimers:

Public Member Functions
bool	AddTimer (bool bRadio) const
	Open the timer settings dialog to create a new tv or radio timer. More...

bool	AddTimer (const CFileItem &item, bool bShowTimerSettings) const
	Create a new timer, either interactive or non-interactive. More...

bool	AddTimer (const std::shared_ptr< CPVRTimerInfoTag > &item) const
	Add a timer to the client. Doesn't add the timer to the container. The backend will do this. More...

bool	AddTimerRule (const CFileItem &item, bool bShowTimerSettings, bool bFallbackToOneShotTimer) const
	Create a new timer rule, either interactive or non-interactive. More...

bool	ToggleTimer (const CFileItem &item) const
	Creates or deletes a timer for the given epg tag. More...

bool	ToggleTimerState (const CFileItem &item) const
	Toggles a given timer's enabled/disabled state. More...

bool	EditTimer (const CFileItem &item) const
	Open the timer settings dialog to edit an existing timer. More...

bool	EditTimerRule (const CFileItem &item) const
	Open the timer settings dialog to edit an existing timer rule. More...

std::shared_ptr< CFileItem >	GetTimerRule (const CFileItem &item) const
	Get the timer rule for a given timer. More...

bool	DeleteTimer (const CFileItem &item) const
	Delete a timer, always showing a confirmation dialog. More...

bool	DeleteTimerRule (const CFileItem &item) const
	Delete a timer rule, always showing a confirmation dialog. More...

bool	ToggleRecordingOnPlayingChannel ()
	Toggle recording on the currently playing channel, if any. More...

bool	SetRecordingOnChannel (const std::shared_ptr< CPVRChannel > &channel, bool bOnOff)
	Start or stop recording on a given channel. More...

bool	StopRecording (const CFileItem &item) const
	Stop a currently active recording, always showing a confirmation dialog. More...

bool	AddReminder (const CFileItem &item) const
	Create a new reminder timer, non-interactive. More...

void	AnnounceReminders () const
	Announce due reminders, if any.

Member Function Documentation

◆ AddReminder()

bool CPVRGUIActionsTimers::AddReminder ( const CFileItem & item ) const

Create a new reminder timer, non-interactive.

Parameters

item	containing epg data to create a reminder timer for. item must be an epg tag.

Returns: true, if the timer was created successfully, false otherwise.

◆ AddTimer() [1/3]

bool CPVRGUIActionsTimers::AddTimer ( bool bRadio ) const

Open the timer settings dialog to create a new tv or radio timer.

Parameters

bRadio indicates whether a radio or tv timer shall be created.

Returns: true on success, false otherwise.

◆ AddTimer() [2/3]

bool CPVRGUIActionsTimers::AddTimer	(	const CFileItem &	item,
		bool	bShowTimerSettings
	)		const

Create a new timer, either interactive or non-interactive.

Parameters

item	containing epg data to create a timer for. item must be an epg tag or a channel.
bShowTimerSettings	is used to control whether a settings dialog will be opened prior creating the timer.

Returns: true, if the timer was created successfully, false otherwise.

◆ AddTimer() [3/3]

bool CPVRGUIActionsTimers::AddTimer ( const std::shared_ptr< CPVRTimerInfoTag > & item ) const

Add a timer to the client. Doesn't add the timer to the container. The backend will do this.

Returns: True if it was sent correctly, false if not.

◆ AddTimerRule()

bool CPVRGUIActionsTimers::AddTimerRule	(	const CFileItem &	item,
		bool	bShowTimerSettings,
		bool	bFallbackToOneShotTimer
	)		const

Create a new timer rule, either interactive or non-interactive.

Parameters

item	containing epg data to create a timer rule for. item must be an epg tag or a channel.
bShowTimerSettings	is used to control whether a settings dialog will be opened prior creating the timer rule.
bFallbackToOneShotTimer	if no timer rule can be created, try to create a one-shot timer instead.

Returns: true, if the timer rule was created successfully, false otherwise.

◆ DeleteTimer()

bool CPVRGUIActionsTimers::DeleteTimer ( const CFileItem & item ) const

Delete a timer, always showing a confirmation dialog.

Parameters

item	containing a timer to delete. item must be a timer, an epg tag or a channel.

Returns: true, if the timer was deleted successfully, false otherwise.

◆ DeleteTimerRule()

bool CPVRGUIActionsTimers::DeleteTimerRule ( const CFileItem & item ) const

Delete a timer rule, always showing a confirmation dialog.

Parameters

item	containing a timer rule to delete. item must be a timer, an epg tag or a channel.

Returns: true, if the timer rule was deleted successfully, false otherwise.

◆ EditTimer()

bool CPVRGUIActionsTimers::EditTimer ( const CFileItem & item ) const

Open the timer settings dialog to edit an existing timer.

Parameters

item	containing an epg tag or a timer.

Returns: true on success, false otherwise.

◆ EditTimerRule()

bool CPVRGUIActionsTimers::EditTimerRule ( const CFileItem & item ) const

Open the timer settings dialog to edit an existing timer rule.

Parameters

item	containing an epg tag or a timer.

Returns: true on success, false otherwise.

◆ GetTimerRule()

std::shared_ptr< CFileItem > CPVRGUIActionsTimers::GetTimerRule ( const CFileItem & item ) const

Get the timer rule for a given timer.

Parameters

item	containing an item to query the timer rule for. item must be a timer or an epg tag.

Returns: The timer rule item, or nullptr if none was found.

◆ SetRecordingOnChannel()

bool CPVRGUIActionsTimers::SetRecordingOnChannel	(	const std::shared_ptr< CPVRChannel > &	channel,
		bool	bOnOff
	)

Start or stop recording on a given channel.

Parameters

channel	the channel to start/stop recording.
bOnOff	True to start recording, false to stop.

Returns: True if the recording was started or stopped successfully, false otherwise.

◆ StopRecording()

bool CPVRGUIActionsTimers::StopRecording ( const CFileItem & item ) const

Stop a currently active recording, always showing a confirmation dialog.

Parameters

item	containing a recording to stop. item must be a timer, an epg tag or a channel.

Returns: true, if the recording was stopped successfully, false otherwise.

◆ ToggleRecordingOnPlayingChannel()

bool CPVRGUIActionsTimers::ToggleRecordingOnPlayingChannel ( )

Toggle recording on the currently playing channel, if any.

Returns: True if the recording was started or stopped successfully, false otherwise.

◆ ToggleTimer()

bool CPVRGUIActionsTimers::ToggleTimer ( const CFileItem & item ) const

Creates or deletes a timer for the given epg tag.

Parameters

item	containing an epg tag.

Returns: true on success, false otherwise.

◆ ToggleTimerState()

bool CPVRGUIActionsTimers::ToggleTimerState ( const CFileItem & item ) const

Toggles a given timer's enabled/disabled state.

Parameters

item	containing a timer.

Returns: true on success, false otherwise.

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

xbmc/pvr/guilib/PVRGUIActionsTimers.h
xbmc/pvr/guilib/PVRGUIActionsTimers.cpp

Public Member Functions

Member Function Documentation

◆ AddReminder()

◆ AddTimer() [1/3]

◆ AddTimer() [2/3]

◆ AddTimer() [3/3]

◆ AddTimerRule()

◆ DeleteTimer()

◆ DeleteTimerRule()

◆ EditTimer()

◆ EditTimerRule()

◆ GetTimerRule()

◆ SetRecordingOnChannel()

◆ StopRecording()

◆ ToggleRecordingOnPlayingChannel()

◆ ToggleTimer()

◆ ToggleTimerState()