vdr  2.2.0
Public Member Functions | Private Attributes | List of all members
cSkins Class Reference

#include <skins.h>

Public Member Functions

 cSkins (void)
 
 ~cSkins ()
 
bool SetCurrent (const char *Name=NULL)
 
cSkinCurrent (void)
 
bool IsOpen (void)
 
eKeys Message (eMessageType Type, const char *s, int Seconds=0)
 
int QueueMessage (eMessageType Type, const char *s, int Seconds=0, int Timeout=0)
 
void ProcessQueuedMessages (void)
 
void Flush (void)
 
virtual void Clear (void)
 
- Public Member Functions inherited from cList< cSkin >
cSkinGet (int Index) const
 
cSkinFirst (void) const
 
cSkinLast (void) const
 
cSkinPrev (const cSkin *object) const
 
cSkinNext (const cSkin *object) const
 
- Public Member Functions inherited from cListBase
virtual ~cListBase ()
 
void Add (cListObject *Object, cListObject *After=NULL)
 
void Ins (cListObject *Object, cListObject *Before=NULL)
 
void Del (cListObject *Object, bool DeleteObject=true)
 
virtual void Move (int From, int To)
 
void Move (cListObject *From, cListObject *To)
 
cListObjectGet (int Index) const
 
int Count (void) const
 
void Sort (void)
 

Private Attributes

cSkincurrent
 
cSkinDisplayMessagedisplayMessage
 
cMutex queueMessageMutex
 

Additional Inherited Members

- Protected Member Functions inherited from cListBase
 cListBase (void)
 
- Protected Attributes inherited from cListBase
cListObjectobjects
 
cListObjectlastObject
 
int count
 

Detailed Description

Definition at line 425 of file skins.h.

Constructor & Destructor Documentation

cSkins::cSkins ( void  )

Definition at line 221 of file skins.c.

References displayMessage.

cSkins::~cSkins ( )

Definition at line 226 of file skins.c.

References displayMessage.

Member Function Documentation

void cSkins::Clear ( void  )
virtual

Free up all registered skins.

Reimplemented from cListBase.

Definition at line 397 of file skins.c.

References cListBase::Clear(), and displayMessage.

Referenced by main().

cSkin* cSkins::Current ( void  )
inline
void cSkins::Flush ( void  )

Flushes the currently active cSkinDisplay, if any.

Definition at line 391 of file skins.c.

References cSkinDisplay::Current(), and cSkinDisplay::Flush().

Referenced by cInterface::GetKey(), and cInterface::Wait().

bool cSkins::IsOpen ( void  )
inline

Returns true if there is currently a skin display object active.

Definition at line 438 of file skins.h.

References cSkinDisplay::Current(), cSkinDisplay::Flush(), and Skins.

Referenced by main().

eKeys cSkins::Message ( eMessageType  Type,
const char *  s,
int  Seconds = 0 
)

Displays the given message, either through a currently visible display object that is capable of doing so, or by creating a temporary cSkinDisplayMessage object.

The return value is the key pressed by the user. If no user input has been received within Seconds (the default value of 0 results in the value defined for "Message time" in the setup), kNone will be returned.

Definition at line 250 of file skins.c.

References cSkinDisplay::Current(), displayMessage, dsyslog, esyslog, cSkinDisplay::Flush(), Interface, cThread::IsMainThread(), isyslog, kNone, cStatus::MsgOsdClear(), cStatus::MsgOsdStatusMessage(), mtError, mtInfo, mtStatus, mtWarning, cSkinDisplay::SetMessage(), and cInterface::Wait().

Referenced by cMenuRecordingEdit::Action(), cMenuSetupCAM::Activate(), cMenuPathEdit::ApplyChanges(), cMenuRecordingEdit::ApplyChanges(), cControl::Attach(), cCountdown::Cancel(), cInterface::Confirm(), cMenuEditFolder::Confirm(), cShutdownHandler::ConfirmShutdown(), cDisplayTracks::Create(), cDisplaySubtitleTracks::Create(), cMenuRecordings::Delete(), cMenuChannels::Delete(), cMenuRecordingEdit::Delete(), cReplayControl::EditCut(), cMenuCommands::Execute(), main(), cPluginPictures::MainMenuAction(), cMenuSetupCAM::Menu(), cRecordControls::PauseLiveVideo(), cEITScanner::Process(), cMenuEditTimer::ProcessKey(), cMenuEditChannel::ProcessKey(), cMenuCam::ProcessKey(), cMenuSetupPlugins::ProcessKey(), ProcessQueuedMessages(), cMenuRecordingEdit::RefreshRecording(), cMenuRecording::RefreshRecording(), cMenuSetupCAM::Reset(), cMenuCam::Select(), cRecordControls::Start(), cReplayControl::Stop(), cMenuWhatsOn::Switch(), cMenuSchedule::Switch(), cDevice::SwitchChannel(), and cCountdown::Update().

void cSkins::ProcessQueuedMessages ( void  )
int cSkins::QueueMessage ( eMessageType  Type,
const char *  s,
int  Seconds = 0,
int  Timeout = 0 
)

Like Message(), but this function may be called from a background thread.

The given message is put into a queue and the main program loop will display it as soon as this is suitable. If Timeout is 0, QueueMessage() returns immediately and the return value will be kNone. If a positive Timeout is given, the thread will wait at most the given number of seconds for the message to be actually displayed (note that the user may currently be doing something that doesn't allow for queued messages to be displayed immediately). If the timeout expires and the message hasn't been displayed yet, the return value is -1 and the message will be removed from the queue without being displayed. Positive values of Timeout are only allowed for background threads. If QueueMessage() is called from the foreground thread with a Timeout greater than 0, the call is ignored and nothing is displayed. Queued messages will be displayed in the sequence they have been put into the queue, so messages from different threads may appear mingled. If a particular thread queues a message with a Timeout of -1, and the previous message from the same thread also had a Timeout of -1, only the last message will be displayed. This can be used for progress displays, where only the most recent message is actually important. Type may only be mtInfo, mtWarning or mtError. A call with mtStatus will be ignored. A call with an empty message from a background thread removes all queued messages from the calling thread. A call with an empty message from the main thread will be ignored.

Definition at line 293 of file skins.c.

References cListBase::Add(), cSkinQueuedMessage::condVar, dsyslog, isempty(), cThread::IsMainThread(), cSkinQueuedMessage::key, kNone, cList< T >::Last(), cMutex::Lock(), mtStatus, cSkinQueuedMessage::mutex, cList< T >::Prev(), queueMessageMutex, cSkinQueuedMessage::state, cThread::ThreadId(), cCondVar::TimedWait(), and cMutex::Unlock().

Referenced by cIndexFileGenerator::Action(), AssertFreeDiskSpace(), cSVDRP::CmdMESG(), main(), and cCaActivationReceiver::Receive().

bool cSkins::SetCurrent ( const char *  Name = NULL)

Sets the current skin to the one indicated by name.

If no such skin can be found, the first one will be used.

Definition at line 231 of file skins.c.

References cSkinDisplay::current, esyslog, cList< cSkin >::First(), isyslog, and cList< cSkin >::Next().

Referenced by main(), cMenuSetupOSD::ProcessKey(), and cPluginSkinCurses::Start().

Member Data Documentation

cSkin* cSkins::current
private

Definition at line 427 of file skins.h.

Referenced by cSkinDisplay::cSkinDisplay(), and cSkinDisplay::~cSkinDisplay().

cSkinDisplayMessage* cSkins::displayMessage
private

Definition at line 428 of file skins.h.

Referenced by Clear(), cSkins(), Message(), and ~cSkins().

cMutex cSkins::queueMessageMutex
private

Definition at line 429 of file skins.h.

Referenced by ProcessQueuedMessages(), and QueueMessage().


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