![]() |
Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
|
#include <GUIWindowManager.h>
Public Member Functions | |
CGUIWindowManager () | |
~CGUIWindowManager () override | |
bool | SendMessage (CGUIMessage &message) |
bool | SendMessage (int message, int senderID, int destID, int param1=0, int param2=0) |
bool | SendMessage (CGUIMessage &message, int window) |
void | Initialize () |
void | Add (CGUIWindow *pWindow) |
void | AddUniqueInstance (CGUIWindow *window) |
void | AddCustomWindow (CGUIWindow *pWindow) |
void | Remove (int id) |
void | Delete (int id) |
void | ActivateWindow (int iWindowID, const std::string &strPath="") |
void | ForceActivateWindow (int iWindowID, const std::string &strPath="") |
void | ChangeActiveWindow (int iNewID, const std::string &strPath="") |
void | ActivateWindow (int iWindowID, const std::vector< std::string > ¶ms, bool swappingWindows=false, bool force=false) |
void | PreviousWindow () |
bool | SwitchToFullScreen (bool force=false) |
Switch window to fullscreen. | |
void | CloseDialogs (bool forceClose=false) const |
void | CloseInternalModalDialogs (bool forceClose=false) const |
void | OnApplicationMessage (KODI::MESSAGING::ThreadMessage *pMsg) override |
This gets called whenever a message matching the registered message mask is processed. | |
int | GetMessageMask () override |
Should return the message mask that it wishes to receive messages for. | |
bool | OnAction (const CAction &action) const |
void | Process (unsigned int currentTime) |
Process active controls allowing them to animate before rendering. | |
void | MarkDirty () |
Mark the screen as dirty, forcing a redraw at the next Render() | |
void | MarkDirty (const CRect &rect) |
Mark a region as dirty, forcing a redraw at the next Render() | |
bool | Render () |
Rendering of the current window and any dialogs Render is called every frame to draw the current window and any dialogs. It should only be called from the application thread. Returns true only if it has rendered something. | |
void | RenderEx () const |
void | AfterRender () |
Do any post render activities. | |
void | FrameMove () |
Per-frame updating of the current window and any dialogs FrameMove is called every frame to update the current window and any dialogs on screen. It should only be called from the application thread. | |
bool | Initialized () const |
Return whether the window manager is initialized. The window manager is initialized on skin load - if the skin isn't yet loaded, no windows should be able to be initialized. | |
void | CreateWindows () |
Create and initialize all windows and dialogs. | |
bool | DestroyWindows () |
Destroy and remove all windows and dialogs. | |
void | DestroyWindow (int id) |
Destroy and remove the window or dialog with the given id. | |
![]() | |
virtual | ~IMessageTarget ()=default |
CGUIWindowManager::CGUIWindowManager | ( | ) |
|
overridedefault |
void CGUIWindowManager::ActivateWindow | ( | int | iWindowID, |
const std::vector< std::string > & | params, | ||
bool | swappingWindows = false, | ||
bool | force = false ) |
void CGUIWindowManager::Add | ( | CGUIWindow * | pWindow | ) |
void CGUIWindowManager::AddCustomWindow | ( | CGUIWindow * | pWindow | ) |
void CGUIWindowManager::AddUniqueInstance | ( | CGUIWindow * | window | ) |
void CGUIWindowManager::AfterRender | ( | ) |
Do any post render activities.
void CGUIWindowManager::CreateWindows | ( | ) |
Create and initialize all windows and dialogs.
Destroy and remove the window or dialog with the given id.
id | the window id |
bool CGUIWindowManager::DestroyWindows | ( | ) |
Destroy and remove all windows and dialogs.
void CGUIWindowManager::FrameMove | ( | ) |
Per-frame updating of the current window and any dialogs FrameMove is called every frame to update the current window and any dialogs on screen. It should only be called from the application thread.
|
overridevirtual |
Should return the message mask that it wishes to receive messages for.
The message mask is defined in "messaging/ApplicationMessenger.h" pick the next one available when creating a new
Implements KODI::MESSAGING::IMessageTarget.
void CGUIWindowManager::Initialize | ( | ) |
|
inline |
Return whether the window manager is initialized. The window manager is initialized on skin load - if the skin isn't yet loaded, no windows should be able to be initialized.
void CGUIWindowManager::MarkDirty | ( | ) |
Mark the screen as dirty, forcing a redraw at the next Render()
Mark a region as dirty, forcing a redraw at the next Render()
|
overridevirtual |
This gets called whenever a message matching the registered message mask is processed.
There are no ordering guarantees here so implementations should never rely on a certain ordering of messages.
Cleaning up any pointers stored in the message payload is not specified and is decided by the implementer of the message. In general prefer to delete any data in this method to keep the callsites cleaner and simpler but if data is to be passed back it's perfectly valid to handle it any way that fits the situation as long as it's documented along with the message.
To return a simple value the result parameter of
Implements KODI::MESSAGING::IMessageTarget.
void CGUIWindowManager::PreviousWindow | ( | ) |
Process active controls allowing them to animate before rendering.
bool CGUIWindowManager::Render | ( | ) |
Rendering of the current window and any dialogs Render is called every frame to draw the current window and any dialogs. It should only be called from the application thread. Returns true only if it has rendered something.
void CGUIWindowManager::RenderEx | ( | ) | const |
bool CGUIWindowManager::SendMessage | ( | CGUIMessage & | message | ) |
bool CGUIWindowManager::SendMessage | ( | CGUIMessage & | message, |
int | window ) |
bool CGUIWindowManager::SendMessage | ( | int | message, |
int | senderID, | ||
int | destID, | ||
int | param1 = 0, | ||
int | param2 = 0 ) |
Switch window to fullscreen.
force | enforce fullscreen switch |