Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
PVR::CPVRChannelSwitchingInputHandler Class Reference

#include <PVRGUIActionsChannels.h>

Inheritance diagram for PVR::CPVRChannelSwitchingInputHandler:
PVR::CPVRChannelNumberInputHandler ITimerCallback

Public Member Functions

void GetChannelNumbers (std::vector< std::string > &channelNumbers) override
 Get the currently available channel numbers.
 
void AppendChannelNumberCharacter (char cCharacter) override
 Appends a channel number character.
 
void OnInputDone () override
 This method gets called after the channel number input timer has expired.
 
- Public Member Functions inherited from PVR::CPVRChannelNumberInputHandler
 CPVRChannelNumberInputHandler ()
 
 CPVRChannelNumberInputHandler (int iDelay, int iMaxDigits=CHANNEL_NUMBER_INPUT_MAX_DIGITS)
 ctor.
 
 ~CPVRChannelNumberInputHandler () override=default
 
CEventStream< PVRChannelNumberInputChangedEvent > & Events ()
 Get the events available for CEventStream.
 
void OnTimeout () override
 
bool HasChannelNumber () const
 Check whether a channel number was entered.
 
std::string GetChannelNumberLabel () const
 Get the currently entered channel number as a formatted string.
 
bool CheckInputAndExecuteAction ()
 If a number was entered, execute the associated action.
 

Additional Inherited Members

- Static Public Attributes inherited from PVR::CPVRChannelNumberInputHandler
static const int CHANNEL_NUMBER_INPUT_MAX_DIGITS = 5
 
- Protected Member Functions inherited from PVR::CPVRChannelNumberInputHandler
CPVRChannelNumber GetChannelNumber () const
 Get the currently entered channel number.
 
size_t GetCurrentDigitCount () const
 Get the currently entered number of digits.
 
- Protected Attributes inherited from PVR::CPVRChannelNumberInputHandler
CCriticalSection m_mutex
 

Member Function Documentation

◆ AppendChannelNumberCharacter()

void CPVRChannelSwitchingInputHandler::AppendChannelNumberCharacter ( char cCharacter)
overridevirtual

Appends a channel number character.

Parameters
cCharacterThe character to append. value must be CPVRChannelNumber::SEPARATOR ('.') or any char in the range from '0' to '9'.

Reimplemented from PVR::CPVRChannelNumberInputHandler.

◆ GetChannelNumbers()

void CPVRChannelSwitchingInputHandler::GetChannelNumbers ( std::vector< std::string > & channelNumbers)
overridevirtual

Get the currently available channel numbers.

Parameters
channelNumbersThe list to fill with the channel numbers.

Implements PVR::CPVRChannelNumberInputHandler.

◆ OnInputDone()

void CPVRChannelSwitchingInputHandler::OnInputDone ( )
overridevirtual

This method gets called after the channel number input timer has expired.

Implements PVR::CPVRChannelNumberInputHandler.


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