My Project
|
The main class to inherit from when creating a sally application or screensaver (or both). More...
#include <ApplicationWindow.h>
Public Member Functions | |
CApplicationWindow (SallyAPI::GUI::CGUIBaseObject *parent, int graphicId, const std::string &pluginPath) | |
Constructor. | |
virtual | ~CApplicationWindow () |
Destructor. | |
std::string | GetAPIVersion () |
Gets a pi version. | |
std::string | GetAppName () |
Gets the application name. | |
std::string | GetAuthor () |
Gets the author. | |
std::string | GetVersion () |
Gets the version. | |
std::string | GetPluginPath () |
Gets the plugin path. | |
virtual bool | ActivateScreensaver () |
Activates a screensaver. | |
virtual bool | DeactivateScreensaver () |
Deactivate screensaver. | |
virtual bool | HasScreensaver () |
Query if this object has screensaver. | |
virtual bool | HasApplication () |
Query if this object has application. | |
virtual bool | IsFacebookNeeded () |
Query if this facebook connect need to be enabled. | |
virtual bool | IsGame () |
Query if this object is game. | |
virtual bool | VoiceCommand (const std::string &command) |
Voice command. | |
virtual bool | VoiceCommandActive (const std::string &command) |
Voice command active. | |
virtual bool | VoiceCommandFocus (const std::string &command) |
Voice command focus. | |
virtual bool | SpecialKeyPressed (int key) |
Special key pressed. | |
virtual void | SendMessageToChilds (SallyAPI::GUI::CGUIBaseObject *reporter, int reporterId, int messageId, SallyAPI::GUI::SendMessage::CParameterBase *messageParameter=NULL) |
Send message to childs. | |
virtual void | SendMessageToParent (SallyAPI::GUI::CGUIBaseObject *reporter, int reporterId, int messageId, SallyAPI::GUI::SendMessage::CParameterBase *messageParameter=NULL) |
Send message to parent. | |
Protected Member Functions | |
void | UnloadPicture (int id) |
Unload picture. | |
void | LoadApplicationImage (const std::string &name, int id, bool scalable=false) |
Loads a picture. | |
virtual void | LoadConfig (SallyAPI::GUI::SendMessage::CParameterIntegerVector *messageParameter=NULL) |
Loads a configuration. | |
virtual void | SaveConfig () |
Is called when the configuration should be saved. | |
virtual void | SallyConfigChanged () |
The config for this application was changed. Normally called from the the save action of the config panel. | |
virtual void | MuteSound () |
Mute sound. | |
virtual void | UnMuteSound () |
Un mute sound. | |
Protected Attributes | |
std::string | m_strPluginPath |
std::string | m_strAppName |
std::string | m_strAuthor |
std::string | m_strVersion |
The main class to inherit from when creating a sally application or screensaver (or both).
CApplicationWindow::CApplicationWindow | ( | SallyAPI::GUI::CGUIBaseObject * | parent, |
int | graphicId, | ||
const std::string & | pluginPath | ||
) |
Constructor.
[in,out] | parent | If non-null, the parent. |
graphicId | Identifier for the graphic. | |
pluginPath | Full pathname of the plugin file. |
CApplicationWindow::~CApplicationWindow | ( | ) | [virtual] |
Destructor.
bool CApplicationWindow::ActivateScreensaver | ( | ) | [virtual] |
Activates a screensaver.
bool CApplicationWindow::DeactivateScreensaver | ( | ) | [virtual] |
Deactivate screensaver.
std::string CApplicationWindow::GetAPIVersion | ( | ) |
Gets a pi version.
std::string CApplicationWindow::GetAppName | ( | ) |
Gets the application name.
std::string CApplicationWindow::GetAuthor | ( | ) |
Gets the author.
std::string CApplicationWindow::GetPluginPath | ( | ) |
Gets the plugin path.
std::string CApplicationWindow::GetVersion | ( | ) |
Gets the version.
bool CApplicationWindow::HasApplication | ( | ) | [virtual] |
Query if this object has application.
bool CApplicationWindow::HasScreensaver | ( | ) | [virtual] |
Query if this object has screensaver.
bool CApplicationWindow::IsFacebookNeeded | ( | ) | [virtual] |
Query if this facebook connect need to be enabled.
bool CApplicationWindow::IsGame | ( | ) | [virtual] |
Query if this object is game.
Reimplemented in SallyAPI::GUI::CGameWindow.
void CApplicationWindow::LoadApplicationImage | ( | const std::string & | name, |
int | id, | ||
bool | scalable = false |
||
) | [protected] |
Loads a picture.
name | The name. |
id | The identifier. |
scalable | true to scalable. |
void CApplicationWindow::LoadConfig | ( | SallyAPI::GUI::SendMessage::CParameterIntegerVector * | messageParameter = NULL | ) | [protected, virtual] |
Loads a configuration.
[in,out] | messageParameter | If non-null, the message parameter. |
void CApplicationWindow::MuteSound | ( | ) | [protected, virtual] |
Mute sound.
void CApplicationWindow::SallyConfigChanged | ( | ) | [protected, virtual] |
The config for this application was changed. Normally called from the the save action of the config panel.
void CApplicationWindow::SaveConfig | ( | ) | [protected, virtual] |
Is called when the configuration should be saved.
void CApplicationWindow::SendMessageToChilds | ( | SallyAPI::GUI::CGUIBaseObject * | reporter, |
int | reporterId, | ||
int | messageId, | ||
SallyAPI::GUI::SendMessage::CParameterBase * | messageParameter = NULL |
||
) | [virtual] |
Send message to childs.
[in,out] | reporter | If non-null, the reporter. |
reporterId | Identifier for the reporter. | |
messageId | Identifier for the message. | |
[in,out] | messageParameter | If non-null, the message parameter. |
Reimplemented from SallyAPI::GUI::CForm.
void CApplicationWindow::SendMessageToParent | ( | SallyAPI::GUI::CGUIBaseObject * | reporter, |
int | reporterId, | ||
int | messageId, | ||
SallyAPI::GUI::SendMessage::CParameterBase * | messageParameter = NULL |
||
) | [virtual] |
Send message to parent.
[in,out] | reporter | If non-null, the reporter. |
reporterId | Identifier for the reporter. | |
messageId | Identifier for the message. | |
[in,out] | messageParameter | If non-null, the message parameter. |
Reimplemented from SallyAPI::GUI::CAppBase.
Reimplemented in SallyAPI::GUI::CGameWindow.
bool CApplicationWindow::SpecialKeyPressed | ( | int | key | ) | [virtual] |
Special key pressed.
key | The key. |
void CApplicationWindow::UnloadPicture | ( | int | id | ) | [protected] |
Unload picture.
id | The identifier. |
void CApplicationWindow::UnMuteSound | ( | ) | [protected, virtual] |
Un mute sound.
bool CApplicationWindow::VoiceCommand | ( | const std::string & | command | ) | [virtual] |
Voice command.
command | The command. |
bool CApplicationWindow::VoiceCommandActive | ( | const std::string & | command | ) | [virtual] |
Voice command active.
command | The command. |
bool CApplicationWindow::VoiceCommandFocus | ( | const std::string & | command | ) | [virtual] |
Voice command focus.
command | The command. |
std::string SallyAPI::GUI::CApplicationWindow::m_strAppName [protected] |
std::string SallyAPI::GUI::CApplicationWindow::m_strAuthor [protected] |
std::string SallyAPI::GUI::CApplicationWindow::m_strPluginPath [protected] |
std::string SallyAPI::GUI::CApplicationWindow::m_strVersion [protected] |