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

#include <WindowTranslator.h>

Static Public Member Functions

static void GetWindows (std::vector< std::string > &windowList)
 Get a list of all known window names.
 
static int TranslateWindow (const std::string &window)
 Translate between a window name and its ID.
 
static std::string TranslateWindow (int windowId)
 Translate between a window id and it's name.
 
static int GetFallbackWindow (int windowId)
 Get the window ID that should be used as fallback for keymap input.
 
static int GetVirtualWindow (int windowId)
 Get the special window ID if conditions met.
 

Member Function Documentation

◆ GetFallbackWindow()

int CWindowTranslator::GetFallbackWindow ( int windowId)
static

Get the window ID that should be used as fallback for keymap input.

Returns
The fallback window, or -1 for no fallback window

◆ GetVirtualWindow()

int CWindowTranslator::GetVirtualWindow ( int windowId)
static

Get the special window ID if conditions met.

Returns
The special window ID or the given window ID

◆ GetWindows()

void CWindowTranslator::GetWindows ( std::vector< std::string > & windowList)
static

Get a list of all known window names.

◆ TranslateWindow() [1/2]

int CWindowTranslator::TranslateWindow ( const std::string & window)
static

Translate between a window name and its ID.

Parameters
windowThe name of the window
Returns
ID of the window, or WINDOW_INVALID if not found

◆ TranslateWindow() [2/2]

std::string CWindowTranslator::TranslateWindow ( int windowId)
static

Translate between a window id and it's name.

Parameters
windowid of the window
Returns
name of the window, or an empty string if not found

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