vdr 2.7.5
|
#include <skins.h>
Public Member Functions | |
cSkins (void) | |
~cSkins () | |
bool | SetCurrent (const char *Name=NULL) |
cSkin * | Current (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) override |
Public Member Functions inherited from cList< cSkin > | |
cList (const char *NeedsLocking=NULL) | |
const cSkin * | Get (int Index) const |
const cSkin * | First (void) const |
const cSkin * | Last (void) const |
const cSkin * | Prev (const cSkin *Object) const |
const cSkin * | Next (const cSkin *Object) const |
Public Member Functions inherited from cListBase | |
virtual | ~cListBase () |
bool | Lock (cStateKey &StateKey, bool Write=false, int TimeoutMs=0) const |
void | SetSyncStateKey (cStateKey &StateKey) |
void | SetUseGarbageCollector (void) |
void | SetExplicitModify (void) |
void | SetModified (void) |
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) |
bool | Contains (const cListObject *Object) const |
const cListObject * | Get (int Index) const |
cListObject * | Get (int Index) |
int | Count (void) const |
void | Sort (void) |
Private Attributes | |
cSkin * | current |
cSkinDisplayMessage * | displayMessage |
cMutex | queueMessageMutex |
Additional Inherited Members | |
Protected Member Functions inherited from cListBase | |
cListBase (const char *NeedsLocking=NULL) | |
Protected Attributes inherited from cListBase | |
cListObject * | objects |
cListObject * | lastObject |
int | count |
cStateLock | stateLock |
const char * | needsLocking |
bool | useGarbageCollector |
cSkins::cSkins | ( | void | ) |
Definition at line 255 of file skins.c.
References displayMessage.
cSkins::~cSkins | ( | ) |
Definition at line 260 of file skins.c.
References displayMessage.
|
overridevirtual |
Free up all registered skins.
Reimplemented from cListBase.
Definition at line 442 of file skins.c.
References cListBase::Clear(), and displayMessage.
|
inline |
void cSkins::Flush | ( | void | ) |
Flushes the currently active cSkinDisplay, if any.
Definition at line 436 of file skins.c.
References cSkinDisplay::Current(), and cSkinDisplay::Flush().
|
inline |
Returns true if there is currently a skin display object active.
Definition at line 470 of file skins.h.
References cSkinDisplay::Current().
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. If Message() is called from a background thread and Type is not mtStatus, the call will be automatically forwarded to QueueMessage().
Definition at line 284 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, QueueMessage(), and cSkinDisplay::SetMessage().
void cSkins::ProcessQueuedMessages | ( | void | ) |
Processes the first queued message, if any.
Definition at line 386 of file skins.c.
References cCondVar::Broadcast(), cSkinQueuedMessage::condVar, cSkinDisplay::Current(), dsyslog, cThread::IsMainThread(), cSkinQueuedMessage::key, cMutex::Lock(), cSkinQueuedMessage::message, cSkinQueuedMessage::mutex, queueMessageMutex, cSkinQueuedMessage::seconds, SkinQueuedMessages, Skins, cSkinQueuedMessage::state, cSkinQueuedMessage::timeout, cSkinQueuedMessage::type, and cMutex::Unlock().
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 330 of file skins.c.
References cSkinQueuedMessage::condVar, dsyslog, isempty(), cThread::IsMainThread(), cSkinQueuedMessage::key, kNone, cMutex::Lock(), mtStatus, cSkinQueuedMessage::mutex, queueMessageMutex, SkinQueuedMessages, cSkinQueuedMessage::state, cThread::ThreadId(), cCondVar::TimedWait(), and cMutex::Unlock().
Referenced by Message().
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 265 of file skins.c.
References current, esyslog, cList< cSkin >::First(), isyslog, and cList< cSkin >::Next().
|
private |
Definition at line 459 of file skins.h.
Referenced by Current(), and SetCurrent().
|
private |
|
private |
Definition at line 461 of file skins.h.
Referenced by ProcessQueuedMessages(), and QueueMessage().