|
| CGUIDialogAddonSettings () |
|
| ~CGUIDialogAddonSettings () override=default |
|
bool | OnMessage (CGUIMessage &message) override |
|
bool | OnAction (const CAction &action) override |
|
std::string | GetCurrentAddonID () const |
|
| CGUIDialogSettingsManagerBase (int windowId, const std::string &xmlFile) |
|
| ~CGUIDialogSettingsManagerBase () override |
|
| CGUIDialogSettingsBase (int windowId, const std::string &xmlFile) |
|
| ~CGUIDialogSettingsBase () override |
|
bool | OnMessage (CGUIMessage &message) override |
|
bool | OnAction (const CAction &action) override |
|
bool | OnBack (int actionID) override |
|
void | DoProcess (unsigned int currentTime, CDirtyRegionList &dirtyregions) override |
|
virtual bool | IsConfirmed () const |
|
std::string | Localize (std::uint32_t code) const override |
|
| CGUIDialog (int id, const std::string &xmlFile, DialogModalityType modalityType=DialogModalityType::MODAL) |
|
| ~CGUIDialog (void) override |
|
void | Render () override |
|
void | Open (const std::string ¶m="") |
|
void | Open (bool bProcessRenderLoop, const std::string ¶m="") |
|
bool | IsDialogRunning () const override |
|
bool | IsDialog () const override |
|
bool | IsModalDialog () const override |
|
virtual DialogModalityType | GetModalityType () const |
|
void | SetAutoClose (unsigned int timeoutMs) |
|
void | ResetAutoClose (void) |
|
void | CancelAutoClose (void) |
|
bool | IsAutoClosed (void) const |
|
void | SetSound (bool OnOff) |
|
bool | IsSoundEnabled () const override |
|
| CGUIWindow (int id, const std::string &xmlFile) |
|
| ~CGUIWindow (void) override |
|
bool | Initialize () |
|
bool | Load (const std::string &strFileName, bool bContainsPath=false) |
|
void | CenterWindow () |
|
void | DoProcess (unsigned int currentTime, CDirtyRegionList &dirtyregions) override |
|
void | DoRender () override |
| Main render function, called every frame. Window classes should override this only if they need to alter how something is rendered. General updating on a per-frame basis should be handled in FrameMove instead, as DoRender is not necessarily re-entrant.
|
|
void | AfterRender () |
| Do any post render activities. Check if window closing animation is finished and finalize window closing.
|
|
virtual void | FrameMove () |
| Main update function, called every frame prior to rendering Any window that requires updating on a frame by frame basis (such as to maintain timers and the like) should override this function.
|
|
void | Close (bool forceClose=false, int nextWindowID=0, bool enableSound=true, bool bWait=true) |
|
bool | OnAction (const CAction &action) override |
|
virtual bool | OnInfo (int actionID) |
|
virtual void | ClearBackground () |
| Clear the background (if necessary) prior to rendering the window.
|
|
bool | OnMove (int fromControl, int moveAction) |
|
bool | OnMessage (CGUIMessage &message) override |
|
bool | ControlGroupHasFocus (int groupID, int controlID) |
|
void | SetID (int id) override |
|
virtual bool | HasID (int controlID) const |
|
const std::vector< int > & | GetIDRange () const |
|
int | GetPreviousWindow () |
|
CRect | GetScaledBounds () const |
|
void | ClearAll () override |
|
virtual void | AllocResources (bool forceLoad=false) |
|
void | FreeResources (bool forceUnLoad=false) override |
|
void | DynamicResourceAlloc (bool bOnOff) override |
|
virtual bool | IsMediaWindow () const |
|
virtual bool | HasListItems () const |
|
virtual CFileItemPtr | GetCurrentListItem (int offset=0) |
|
virtual int | GetViewContainerID () const |
|
virtual int | GetViewCount () const |
|
virtual bool | CanBeActivated () const |
|
virtual bool | IsActive () const |
|
void | SetCoordsRes (const RESOLUTION_INFO &res) |
|
const RESOLUTION_INFO & | GetCoordsRes () const |
|
void | SetLoadType (LOAD_TYPE loadType) |
|
LOAD_TYPE | GetLoadType () |
|
int | GetRenderOrder () |
|
void | SetInitialVisibility () override |
|
bool | IsVisible () const override |
|
virtual bool | HasVisibleControls () |
|
bool | IsAnimating (ANIMATION_TYPE animType) override |
|
bool | IsCustom () const |
| Return if the window is a custom window.
|
|
void | SetCustom (bool custom) |
| Mark this window as custom window.
|
|
void | DisableAnimations () |
|
virtual void | ResetControlStates () |
|
void | UpdateControlStats () override |
|
void | SetRunActionsManually () |
|
void | RunLoadActions () const |
|
void | RunUnloadActions () const |
|
void | SetProperty (const std::string &key, const CVariant &value) |
| Set a property Sets the value of a property referenced by a key.
|
|
CVariant | GetProperty (const std::string &key) const |
| Retrieve a property.
|
|
void | ClearProperties () |
| Clear a all the window's properties.
|
|
bool | HasSaveLastControl () const |
|
void | AllocResources () override |
|
| CGUIControlGroup () |
|
| CGUIControlGroup (int parentID, int controlID, float posX, float posY, float width, float height) |
|
| CGUIControlGroup (const CGUIControlGroup &from) |
|
| ~CGUIControlGroup (void) override |
|
CGUIControlGroup * | Clone () const override |
|
void | Process (unsigned int currentTime, CDirtyRegionList &dirtyregions) override |
|
void | RenderEx () override |
|
virtual bool | SendControlMessage (CGUIMessage &message) |
|
bool | HasFocus () const override |
|
bool | CanFocus () const override |
|
void | AssignDepth () override |
|
EVENT_RESULT | SendMouseEvent (const CPoint &point, const KODI::MOUSE::CMouseEvent &event) override |
| React to a mouse event.
|
|
void | UnfocusFromPoint (const CPoint &point) override |
| Unfocus the control if the given point on screen is not within it's boundary.
|
|
bool | HasAnimation (ANIMATION_TYPE anim) override |
|
void | QueueAnimation (ANIMATION_TYPE anim) override |
|
void | ResetAnimation (ANIMATION_TYPE anim) override |
|
void | ResetAnimations () override |
|
int | GetFocusedControlID () const |
|
CGUIControl * | GetFocusedControl () const |
|
virtual CGUIControl * | GetFirstFocusableControl (int id) |
|
virtual void | AddControl (CGUIControl *control, int position=-1) |
|
bool | InsertControl (CGUIControl *control, const CGUIControl *insertPoint) |
|
virtual bool | RemoveControl (const CGUIControl *control) |
|
void | SetDefaultControl (int id, bool always) |
|
void | SetRenderFocusedLast (bool renderLast) |
|
void | SaveStates (std::vector< CControlState > &states) override |
|
bool | IsGroup () const override |
|
| CGUIControlLookup ()=default |
|
| CGUIControlLookup (int parentID, int controlID, float posX, float posY, float width, float height) |
|
| CGUIControlLookup (const CGUIControlLookup &from) |
|
| ~CGUIControlLookup (void) override=default |
|
CGUIControl * | GetControl (int id, std::vector< CGUIControl * > *idCollector=nullptr) override |
|
| CGUIControl () |
|
| CGUIControl (int parentID, int controlID, float posX, float posY, float width, float height) |
|
| CGUIControl (const CGUIControl &) |
|
virtual | ~CGUIControl (void) |
|
bool | HasProcessed () const |
| Returns whether or not we have processed.
|
|
virtual void | OnUp () |
|
virtual void | OnDown () |
|
virtual void | OnLeft () |
|
virtual void | OnRight () |
|
virtual bool | OnBack () |
|
virtual bool | OnInfo () |
|
virtual void | OnNextControl () |
|
virtual void | OnPrevControl () |
|
virtual void | OnFocus () |
|
virtual void | OnUnFocus () |
|
virtual bool | HitTest (const CPoint &point) const |
| Used to test whether the point is inside a control.
|
|
virtual int | GetID (void) const |
|
int | GetParentID () const |
|
virtual bool | IsDynamicallyAllocated () |
|
bool | IsVisibleFromSkin () const |
|
virtual bool | IsDisabled () const |
|
virtual void | SetPosition (float posX, float posY) |
|
virtual void | SetHitRect (const CRect &rect, const KODI::UTILS::COLOR::Color &color) |
|
virtual void | SetCamera (const CPoint &camera) |
|
virtual void | SetStereoFactor (const float &factor) |
|
bool | SetColorDiffuse (const KODI::GUILIB::GUIINFO::CGUIInfoColor &color) |
|
CPoint | GetRenderPosition () const |
|
virtual float | GetXPosition () const |
|
virtual float | GetYPosition () const |
|
virtual float | GetWidth () const |
|
virtual float | GetHeight () const |
|
void | MarkDirtyRegion (const unsigned int dirtyState=DIRTY_STATE_CONTROL) |
|
bool | IsControlDirty () const |
|
const CRect & | GetRenderRegion () const |
| return the render region in screen coordinates of this control
|
|
virtual CRect | CalcRenderRegion () const |
| calculate the render region in parentcontrol coordinates of this control Called during process to update m_renderRegion
|
|
void | SetActions (const ActionMap &actions) |
|
void | SetAction (int actionID, const CGUIAction &action, bool replace=true) |
| Set actions to perform on navigation Navigations are set if replace is true or if there is no previously set action.
|
|
CGUIAction | GetAction (int actionID) const |
| Get an action the control can be perform.
|
|
bool | Navigate (int direction) const |
| Start navigating in given direction.
|
|
virtual void | SetFocus (bool focus) |
|
virtual void | SetWidth (float width) |
|
virtual void | SetHeight (float height) |
|
virtual void | SetVisible (bool bVisible, bool setVisState=false) |
|
void | SetVisibleCondition (const std::string &expression, const std::string &allowHiddenFocus="") |
|
bool | HasVisibleCondition () const |
|
void | SetEnableCondition (const std::string &expression) |
|
virtual void | UpdateVisibility (const CGUIListItem *item) |
|
virtual void | SetEnabled (bool bEnable) |
|
virtual void | SetInvalid () |
|
virtual void | SetPulseOnSelect (bool pulse) |
|
virtual std::string | GetDescription () const |
|
virtual std::string | GetDescriptionByIndex (int index) const |
|
void | SetAnimations (const std::vector< CAnimation > &animations) |
|
const std::vector< CAnimation > & | GetAnimations () const |
|
CAnimation * | GetAnimation (ANIMATION_TYPE type, bool checkConditions=true) |
|
virtual void | UpdateInfo (const CGUIListItem *item=NULL) |
|
virtual void | SetPushUpdates (bool pushUpdates) |
|
virtual bool | IsContainer () const |
|
virtual bool | GetCondition (int condition, int data) const |
|
void | SetParentControl (CGUIControl *control) |
|
CGUIControl * | GetParentControl (void) const |
|
void | SetControlStats (GUICONTROLSTATS *controlStats) |
|
GUICONTROLTYPES | GetControlType () const |
|
bool | IsControlRenderable () |
| Test whether the control is "drawable" (not a group or similar)
|
|
std::shared_ptr< ISettingControl > | CreateControl (const std::string &controlType) const override |
| Creates a new setting control of the given custom setting control type.
|
|
virtual | ~ISettingControlCreator ()=default |
|
virtual | ~ILocalizer ()=default |
|
|
void | SetupView () override |
|
std::string | GetLocalizedString (uint32_t labelId) const override |
|
std::string | GetSettingsLabel (const std::shared_ptr< ISetting > &setting) override |
| Get the name for the setting entry.
|
|
int | GetSettingLevel () const override |
|
std::shared_ptr< CSettingSection > | GetSection () override |
|
bool | AllowResettingSettings () const override |
|
bool | Save () override |
|
CSettingsManager * | GetSettingsManager () const override |
|
void | OnSettingAction (const std::shared_ptr< const CSetting > &setting) override |
| The given setting has been activated.
|
|
std::shared_ptr< CSetting > | GetSetting (const std::string &settingId) override |
|
bool | OnOkay () override |
|
std::set< std::string > | CreateSettings () override |
|
void | FreeSettingsControls () override |
|
std::shared_ptr< ISettingControl > | CreateControl (const std::string &controlType) const override |
| Creates a new setting control of the given custom setting control type.
|
|
void | OnInitWindow () override |
| Called on window open.
|
|
void | OnTimeout () override |
|
void | OnSettingChanged (const std::shared_ptr< const CSetting > &setting) override |
| The value of the given setting has changed.
|
|
void | OnSettingPropertyChanged (const std::shared_ptr< const CSetting > &setting, const char *propertyName) override |
| The given property of the given setting has changed.
|
|
virtual std::chrono::milliseconds | GetDelayMs () const |
|
virtual void | OnCancel () |
|
virtual void | UpdateSettings () |
|
virtual CGUIControl * | AddSetting (const std::shared_ptr< CSetting > &pSetting, float width, int &iControlID) |
|
virtual CGUIControl * | AddSettingControl (CGUIControl *pControl, BaseSettingControlPtr pSettingControl, float width, int &iControlID) |
|
virtual void | SetupControls (bool createSettings=true) |
|
virtual void | FreeControls () |
|
virtual void | DeleteControls () |
|
virtual void | SetHeading (const CVariant &label) |
|
virtual void | SetDescription (const CVariant &label) |
|
virtual void | OnResetSettings () |
|
virtual void | OnClick (const BaseSettingControlPtr &pSettingControl) |
| A setting control has been interacted with by the user.
|
|
void | UpdateSettingControl (const std::string &settingId, bool updateDisplayOnly=false) |
|
void | UpdateSettingControl (const BaseSettingControlPtr &pSettingControl, bool updateDisplayOnly=false) |
|
void | SetControlLabel (int controlId, const CVariant &label) |
|
BaseSettingControlPtr | GetSettingControl (const std::string &setting) |
|
BaseSettingControlPtr | GetSettingControl (int controlId) |
|
CGUIControl * | AddSeparator (float width, int &iControlID) |
|
CGUIControl * | AddGroupLabel (const std::shared_ptr< CSettingGroup > &group, float width, int &iControlID) |
|
bool | Load (TiXmlElement *pRootElement) override |
| Loads the window from the given XML element.
|
|
void | SetDefaults () override |
|
void | OnWindowLoaded () override |
|
virtual void | UpdateVisibility () |
|
virtual void | Open_Internal (bool bProcessRenderLoop, const std::string ¶m="") |
|
void | OnDeinitWindow (int nextWindowID) override |
|
void | ProcessRenderLoop (bool renderOnly=false) |
|
EVENT_RESULT | OnMouseEvent (const CPoint &point, const KODI::MOUSE::CMouseEvent &event) override |
| Perform a mouse action.
|
|
virtual bool | LoadXML (const std::string &strPath, const std::string &strLowerPath) |
| Load the window XML from the given path.
|
|
virtual std::unique_ptr< TiXmlElement > | Prepare (const std::unique_ptr< TiXmlElement > &rootElement) |
| Prepare the XML for load.
|
|
bool | NeedLoad () const |
| Check if window needs a (re)load. The window need to be (re)loaded when window is not loaded or include conditions values were changed.
|
|
virtual void | OnWindowUnload () |
|
void | Close_Internal (bool forceClose=false, int nextWindowID=0, bool enableSound=true) |
|
EVENT_RESULT | OnMouseAction (const CAction &action) |
|
bool | Animate (unsigned int currentTime) override |
|
bool | CheckAnimation (ANIMATION_TYPE animType) override |
|
virtual void | SaveControlStates () |
|
virtual void | RestoreControlStates () |
|
void | OnEditChanged (int id, std::string &text) |
|
bool | SendMessage (int message, int id, int param1=0, int param2=0) |
|
void | LoadControl (TiXmlElement *pControl, CGUIControlGroup *pGroup, const CRect &rect) |
|
CPoint | GetPosition () const override |
| Grabs the window's top,left position in skin coordinates The window origin may change based on <origin> tag conditions in the skin.
|
|
bool | IsValidControl (const CGUIControl *control) const |
| Check whether a given control is valid Runs through controls and returns whether this control is valid. Only functional for controls with non-zero id.
|
|
std::pair< LookupMap::const_iterator, LookupMap::const_iterator > | GetLookupControls (int controlId) const |
|
void | AddLookup (CGUIControl *control) |
|
void | RemoveLookup (CGUIControl *control) |
|
void | RemoveLookup () |
|
const LookupMap & | GetLookup () const |
|
void | ClearLookup () |
|
virtual bool | OnMouseOver (const CPoint &point) |
| Called when the mouse is over the control. Default implementation selects the control.
|
|
virtual bool | CanFocusFromPoint (const CPoint &point) const |
| Test whether we can focus a control from a point on screen.
|
|
virtual bool | UpdateColors (const CGUIListItem *item) |
|
void | UpdateStates (ANIMATION_TYPE type, ANIMATION_PROCESS currentProcess, ANIMATION_STATE currentState) |
|
bool | SendWindowMessage (CGUIMessage &message) const |
|
| CSettingControlCreator ()=default |
|
| ~CSettingControlCreator () override=default |
|
| ILocalizer ()=default |
|
virtual | ~ITimerCallback ()=default |
|
virtual | ~ISettingCallback ()=default |
|
virtual bool | OnSettingChanging (const std::shared_ptr< const CSetting > &setting) |
| The value of the given setting is being changed.
|
|
virtual bool | OnSettingUpdate (const std::shared_ptr< CSetting > &setting, const char *oldSettingId, const TiXmlNode *oldSettingNode) |
| The given setting needs to be updated.
|
|