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

#include <GUIDialogSettingsBase.h>

Inheritance diagram for CGUIDialogSettingsBase:
CGUIDialog CSettingControlCreator ILocalizer ITimerCallback ISettingCallback CGUIWindow ISettingControlCreator CGUIControlGroup CGUIControlLookup CGUIControl CGUIDialogSettingsManagerBase CGUIDialogAddonSettings CGUIDialogSettingsManualBase CGUIWindowSettingsCategory CGUIDialogAudioSettings CGUIDialogCMSSettings CGUIDialogContentSettings CGUIDialogInfoProviderSettings CGUIDialogLibExportSettings CGUIDialogLockSettings CGUIDialogMediaFilter CGUIDialogNetworkSetup CGUIDialogProfileSettings CGUIDialogSubtitleSettings CGUIDialogVideoSettings PERIPHERALS::CGUIDialogPeripheralSettings PVR::CGUIDialogPVRClientPriorities PVR::CGUIDialogPVRRecordingSettings PVR::CGUIDialogPVRTimerSettings

Public Member Functions

 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
 
- Public Member Functions inherited from CGUIDialog
 CGUIDialog (int id, const std::string &xmlFile, DialogModalityType modalityType=DialogModalityType::MODAL)
 
 ~CGUIDialog (void) override
 
void Render () override
 
void Open (const std::string &param="")
 
void Open (bool bProcessRenderLoop, const std::string &param="")
 
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
 
- Public Member Functions inherited from CGUIWindow
 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_INFOGetCoordsRes () 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
 
- Public Member Functions inherited from CGUIControlGroup
 CGUIControlGroup ()
 
 CGUIControlGroup (int parentID, int controlID, float posX, float posY, float width, float height)
 
 CGUIControlGroup (const CGUIControlGroup &from)
 
 ~CGUIControlGroup (void) override
 
CGUIControlGroupClone () 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
 
CGUIControlGetFocusedControl () const
 
virtual CGUIControlGetFirstFocusableControl (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
 
- Public Member Functions inherited from CGUIControlLookup
 CGUIControlLookup ()=default
 
 CGUIControlLookup (int parentID, int controlID, float posX, float posY, float width, float height)
 
 CGUIControlLookup (const CGUIControlLookup &from)
 
 ~CGUIControlLookup (void) override=default
 
CGUIControlGetControl (int id, std::vector< CGUIControl * > *idCollector=nullptr) override
 
- Public Member Functions inherited from CGUIControl
 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 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 CRectGetRenderRegion () 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
 
CAnimationGetAnimation (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)
 
CGUIControlGetParentControl (void) const
 
void SetControlStats (GUICONTROLSTATS *controlStats)
 
GUICONTROLTYPES GetControlType () const
 
bool IsControlRenderable ()
 Test whether the control is "drawable" (not a group or similar)
 
- Public Member Functions inherited from CSettingControlCreator
std::shared_ptr< ISettingControlCreateControl (const std::string &controlType) const override
 Creates a new setting control of the given custom setting control type.
 
- Public Member Functions inherited from ISettingControlCreator
virtual ~ISettingControlCreator ()=default
 
- Public Member Functions inherited from ILocalizer
virtual ~ILocalizer ()=default
 

Protected Member Functions

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 bool AllowResettingSettings () const
 
virtual int GetSettingLevel () const
 
virtual std::shared_ptr< CSettingSectionGetSection ()=0
 
virtual std::shared_ptr< CSettingGetSetting (const std::string &settingId)=0
 
virtual std::chrono::milliseconds GetDelayMs () const
 
virtual std::string GetLocalizedString (uint32_t labelId) const
 
virtual bool OnOkay ()
 
virtual void OnCancel ()
 
virtual void SetupView ()
 
virtual std::set< std::string > CreateSettings ()
 
virtual void UpdateSettings ()
 
virtual std::string GetSettingsLabel (const std::shared_ptr< ISetting > &pSetting)
 Get the name for the setting entry.
 
virtual CGUIControlAddSetting (const std::shared_ptr< CSetting > &pSetting, float width, int &iControlID)
 
virtual CGUIControlAddSettingControl (CGUIControl *pControl, BaseSettingControlPtr pSettingControl, float width, int &iControlID)
 
virtual void SetupControls (bool createSettings=true)
 
virtual void FreeControls ()
 
virtual void DeleteControls ()
 
virtual void FreeSettingsControls ()
 
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)
 
CGUIControlAddSeparator (float width, int &iControlID)
 
CGUIControlAddGroupLabel (const std::shared_ptr< CSettingGroup > &group, float width, int &iControlID)
 
- Protected Member Functions inherited from CGUIDialog
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 &param="")
 
void OnDeinitWindow (int nextWindowID) override
 
void ProcessRenderLoop (bool renderOnly=false)
 
- Protected Member Functions inherited from CGUIWindow
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.
 
- Protected Member Functions inherited from CGUIControlLookup
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 LookupMapGetLookup () const
 
void ClearLookup ()
 
- Protected Member Functions inherited from CGUIControl
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
 
- Protected Member Functions inherited from CSettingControlCreator
 CSettingControlCreator ()=default
 
 ~CSettingControlCreator () override=default
 
- Protected Member Functions inherited from ILocalizer
 ILocalizer ()=default
 
- Protected Member Functions inherited from ITimerCallback
virtual ~ITimerCallback ()=default
 
- Protected Member Functions inherited from ISettingCallback
virtual ~ISettingCallback ()=default
 
virtual bool OnSettingChanging (const std::shared_ptr< const CSetting > &setting)
 The value of the given setting is being changed.
 
virtual void OnSettingAction (const std::shared_ptr< const CSetting > &setting)
 The given setting has been activated.
 
virtual bool OnSettingUpdate (const std::shared_ptr< CSetting > &setting, const char *oldSettingId, const TiXmlNode *oldSettingNode)
 The given setting needs to be updated.
 

Protected Attributes

std::vector< std::shared_ptr< CSettingCategory > > m_categories
 
std::vector< BaseSettingControlPtrm_settingControls
 
int m_iSetting = 0
 
int m_iCategory = 0
 
std::shared_ptr< CSettingActionm_resetSetting
 
std::shared_ptr< CSettingCategorym_dummyCategory
 
CGUISpinControlExm_pOriginalSpin
 
CGUISettingsSliderControlm_pOriginalSlider
 
CGUIRadioButtonControlm_pOriginalRadioButton
 
CGUIColorButtonControlm_pOriginalColorButton = nullptr
 
CGUIButtonControlm_pOriginalCategoryButton
 
CGUIButtonControlm_pOriginalButton
 
CGUIEditControlm_pOriginalEdit
 
CGUIImagem_pOriginalImage
 
CGUILabelControlm_pOriginalGroupTitle
 
bool m_newOriginalEdit = false
 
BaseSettingControlPtr m_delayedSetting
 Current delayed setting.
 
CTimer m_delayedTimer
 Delayed setting timer.
 
bool m_confirmed = false
 
int m_focusedControl = 0
 
int m_fadedControl = 0
 
- Protected Attributes inherited from CGUIDialog
bool m_wasRunning
 true if we were running during the last DoProcess()
 
bool m_autoClosing
 
bool m_enableSound
 
unsigned int m_showStartTime
 
unsigned int m_showDuration
 
bool m_bAutoClosed
 
DialogModalityType m_modalityType
 
- Protected Attributes inherited from CGUIWindow
std::vector< intm_idRange
 
RESOLUTION_INFO m_coordsRes
 
bool m_needsScaling
 
bool m_windowLoaded
 
LOAD_TYPE m_loadType
 
bool m_dynamicResourceAlloc
 
bool m_closing
 
bool m_active
 
KODI::GUILIB::GUIINFO::CGUIInfoColor m_clearBackground
 
int m_renderOrder
 
std::vector< COriginm_origins
 
int m_lastControlID
 
std::vector< CControlStatem_controlStates
 
int m_previousWindow
 
bool m_animationsEnabled
 
CGUIAction m_loadActions
 
CGUIAction m_unloadActions
 
std::unique_ptr< TiXmlElement > m_windowXMLRootElement
 window root xml definition after resolving any skin includes. Stored to avoid parsing the XML every time the window is loaded.
 
bool m_manualRunActions
 
int m_exclusiveMouseControl
 id of child control that wishes to receive all mouse events
 
int m_menuControlID
 
int m_menuLastFocusedControlID
 
bool m_custom
 
- Protected Attributes inherited from CGUIControlGroup
std::vector< CGUIControl * > m_children
 
int m_defaultControl
 
bool m_defaultAlways
 
int m_focusedControl
 
bool m_renderFocusedLast
 
- Protected Attributes inherited from CGUIControl
ActionMap m_actions
 
float m_posX
 
float m_posY
 
float m_height
 
float m_width
 
CRect m_hitRect
 
UTILS::COLOR::Color m_hitColor = 0xffffffff
 
KODI::GUILIB::GUIINFO::CGUIInfoColor m_diffuseColor
 
int m_controlID
 
int m_parentID
 
bool m_bHasFocus
 
bool m_bInvalidated
 
bool m_bAllocated
 
bool m_pulseOnSelect
 
GUICONTROLTYPES ControlType
 
GUICONTROLSTATSm_controlStats
 
CGUIControlm_parentControl
 
INFO::InfoPtr m_visibleCondition
 
GUIVISIBLE m_visible
 
bool m_visibleFromSkinCondition
 
bool m_forceHidden
 
KODI::GUILIB::GUIINFO::CGUIInfoBool m_allowHiddenFocus
 
bool m_hasProcessed
 
INFO::InfoPtr m_enableCondition
 
bool m_enabled
 
bool m_pushedUpdates
 
std::vector< CAnimationm_animations
 
CPoint m_camera
 
bool m_hasCamera
 
float m_stereo
 
TransformMatrix m_transform
 
TransformMatrix m_cachedTransform
 
bool m_isCulled {true}
 
unsigned int m_controlDirtyState
 
CRect m_renderRegion
 

Additional Inherited Members

- Public Types inherited from CGUIWindow
enum  LOAD_TYPE { LOAD_EVERY_TIME , LOAD_ON_GUI_INIT , KEEP_IN_MEMORY }
 
- Public Types inherited from CGUIControl
enum  GUICONTROLTYPES {
  GUICONTROL_UNKNOWN , GUICONTAINER_EPGGRID , GUICONTAINER_FIXEDLIST , GUICONTAINER_LIST ,
  GUICONTAINER_PANEL , GUICONTAINER_WRAPLIST , GUICONTROL_BORDEREDIMAGE , GUICONTROL_BUTTON ,
  GUICONTROL_COLORBUTTON , GUICONTROL_EDIT , GUICONTROL_FADELABEL , GUICONTROL_GAME ,
  GUICONTROL_GAMECONTROLLER , GUICONTROL_GAMECONTROLLERLIST , GUICONTROL_GROUP , GUICONTROL_GROUPLIST ,
  GUICONTROL_IMAGE , GUICONTROL_LABEL , GUICONTROL_LISTGROUP , GUICONTROL_LISTLABEL ,
  GUICONTROL_MOVER , GUICONTROL_MULTI_IMAGE , GUICONTROL_PROGRESS , GUICONTROL_RADIO ,
  GUICONTROL_RANGES , GUICONTROL_RENDERADDON , GUICONTROL_RESIZE , GUICONTROL_RSS ,
  GUICONTROL_SCROLLBAR , GUICONTROL_SETTINGS_SLIDER , GUICONTROL_SLIDER , GUICONTROL_SPIN ,
  GUICONTROL_SPINEX , GUICONTROL_TEXTBOX , GUICONTROL_TOGGLEBUTTON , GUICONTROL_VIDEO ,
  GUICONTROL_VISUALISATION
}
 
enum  GUIVISIBLE { HIDDEN = 0 , DELAYED , VISIBLE }
 
enum  GUISCROLLVALUE { FOCUS = 0 , NEVER , ALWAYS }
 
typedef std::map< int, CGUIActionActionMap
 Set actions to perform on navigation.
 
- Protected Types inherited from CGUIControlGroup
typedef std::vector< CGUIControl * >::iterator iControls
 
typedef std::vector< CGUIControl * >::const_iterator ciControls
 
typedef std::vector< CGUIControl * >::reverse_iterator rControls
 
typedef std::vector< CGUIControl * >::const_reverse_iterator crControls
 
- Protected Types inherited from CGUIControlLookup
typedef std::multimap< int, CGUIControl * > LookupMap
 
- Static Protected Attributes inherited from CGUIControl
static const unsigned int DIRTY_STATE_CONTROL = 1
 
static const unsigned int DIRTY_STATE_CHILD = 2
 

Constructor & Destructor Documentation

◆ CGUIDialogSettingsBase()

CGUIDialogSettingsBase::CGUIDialogSettingsBase ( int windowId,
const std::string & xmlFile )

◆ ~CGUIDialogSettingsBase()

CGUIDialogSettingsBase::~CGUIDialogSettingsBase ( )
override

Member Function Documentation

◆ AddGroupLabel()

CGUIControl * CGUIDialogSettingsBase::AddGroupLabel ( const std::shared_ptr< CSettingGroup > & group,
float width,
int & iControlID )
protected

◆ AddSeparator()

CGUIControl * CGUIDialogSettingsBase::AddSeparator ( float width,
int & iControlID )
protected

◆ AddSetting()

CGUIControl * CGUIDialogSettingsBase::AddSetting ( const std::shared_ptr< CSetting > & pSetting,
float width,
int & iControlID )
protectedvirtual

◆ AddSettingControl()

CGUIControl * CGUIDialogSettingsBase::AddSettingControl ( CGUIControl * pControl,
BaseSettingControlPtr pSettingControl,
float width,
int & iControlID )
protectedvirtual

◆ AllowResettingSettings()

◆ CreateSettings()

std::set< std::string > CGUIDialogSettingsBase::CreateSettings ( )
protectedvirtual

Reimplemented in CGUIDialogSettingsManagerBase.

◆ DeleteControls()

void CGUIDialogSettingsBase::DeleteControls ( )
protectedvirtual

◆ DoProcess()

void CGUIDialogSettingsBase::DoProcess ( unsigned int currentTime,
CDirtyRegionList & dirtyregions )
overridevirtual

Reimplemented from CGUIDialog.

◆ FreeControls()

void CGUIDialogSettingsBase::FreeControls ( )
protectedvirtual

◆ FreeSettingsControls()

void CGUIDialogSettingsBase::FreeSettingsControls ( )
protectedvirtual

Reimplemented in CGUIDialogSettingsManagerBase.

◆ GetDelayMs()

virtual std::chrono::milliseconds CGUIDialogSettingsBase::GetDelayMs ( ) const
inlineprotectedvirtual

Reimplemented in CGUIDialogMediaFilter.

◆ GetLocalizedString()

std::string CGUIDialogSettingsBase::GetLocalizedString ( uint32_t labelId) const
protectedvirtual

Reimplemented in CGUIDialogAddonSettings.

◆ GetSection()

virtual std::shared_ptr< CSettingSection > CGUIDialogSettingsBase::GetSection ( )
protectedpure virtual

◆ GetSetting()

virtual std::shared_ptr< CSetting > CGUIDialogSettingsBase::GetSetting ( const std::string & settingId)
protectedpure virtual

◆ GetSettingControl() [1/2]

BaseSettingControlPtr CGUIDialogSettingsBase::GetSettingControl ( const std::string & setting)
protected

◆ GetSettingControl() [2/2]

BaseSettingControlPtr CGUIDialogSettingsBase::GetSettingControl ( int controlId)
protected

◆ GetSettingLevel()

virtual int CGUIDialogSettingsBase::GetSettingLevel ( ) const
inlineprotectedvirtual

◆ GetSettingsLabel()

std::string CGUIDialogSettingsBase::GetSettingsLabel ( const std::shared_ptr< ISetting > & pSetting)
protectedvirtual

Get the name for the setting entry.

Used as virtual to allow related settings dialog to give a std::string name of the setting. If not used on own dialog class it handle the string from int CSetting::GetLabel(), This must also be used if on related dialog no special entry is wanted.

Parameters
pSettingBase settings class which need the name
Returns
Name used on settings dialog

Reimplemented in CGUIDialogAddonSettings, and PVR::CGUIDialogPVRClientPriorities.

◆ IsConfirmed()

virtual bool CGUIDialogSettingsBase::IsConfirmed ( ) const
inlinevirtual

Reimplemented in CGUIDialogNetworkSetup.

◆ Localize()

std::string CGUIDialogSettingsBase::Localize ( std::uint32_t code) const
inlineoverridevirtual

Implements ILocalizer.

◆ OnAction()

bool CGUIDialogSettingsBase::OnAction ( const CAction & action)
overridevirtual

Reimplemented from CGUIDialog.

Reimplemented in CGUIWindowSettingsCategory.

◆ OnBack()

bool CGUIDialogSettingsBase::OnBack ( int actionID)
overridevirtual

Reimplemented from CGUIDialog.

Reimplemented in CGUIWindowSettingsCategory.

◆ OnCancel()

virtual void CGUIDialogSettingsBase::OnCancel ( )
inlineprotectedvirtual

◆ OnClick()

void CGUIDialogSettingsBase::OnClick ( const BaseSettingControlPtr & pSettingControl)
protectedvirtual

A setting control has been interacted with by the user.

This method is called when the user manually interacts (clicks, edits) with a setting control. It contains handling for both delayed and undelayed settings and either starts the delay timer or triggers the setting change which, on success, results in a callback to OnSettingChanged().

Parameters
pSettingControlSetting control that has been interacted with

◆ OnInitWindow()

void CGUIDialogSettingsBase::OnInitWindow ( void )
overrideprotectedvirtual

Called on window open.

  • Restores the control state(s)
  • Sets initial visibility of controls
  • Queue WindowOpen animation
  • Set overlay state Override this function and do any window-specific initialisation such as filling control contents and setting control focus before calling the base method.

Reimplemented from CGUIWindow.

◆ OnMessage()

bool CGUIDialogSettingsBase::OnMessage ( CGUIMessage & message)
overridevirtual

Reimplemented from CGUIDialog.

Reimplemented in CGUIDialogSubtitleSettings, and CGUIWindowSettingsCategory.

◆ OnOkay()

virtual bool CGUIDialogSettingsBase::OnOkay ( )
inlineprotectedvirtual

Reimplemented in CGUIDialogSettingsManagerBase.

◆ OnResetSettings()

void CGUIDialogSettingsBase::OnResetSettings ( )
protectedvirtual

◆ OnSettingChanged()

void CGUIDialogSettingsBase::OnSettingChanged ( const std::shared_ptr< const CSetting > & setting)
overrideprotectedvirtual

The value of the given setting has changed.

This callback is triggered whenever the value of a setting has been successfully changed (i.e. none of the OnSettingChanging() handlers) has reverted the change.

Parameters
settingThe setting whose value has been changed

Reimplemented from ISettingCallback.

Reimplemented in CGUIDialogSubtitleSettings, and CGUIDialogVideoSettings.

◆ OnSettingPropertyChanged()

void CGUIDialogSettingsBase::OnSettingPropertyChanged ( const std::shared_ptr< const CSetting > & setting,
const char * propertyName )
overrideprotectedvirtual

The given property of the given setting has changed.

This callback is triggered when a property (e.g. enabled or the list of dynamic options) has changed.

Parameters
settingThe setting which has a changed property
propertyNameThe string representation of the changed property

Reimplemented from ISettingCallback.

◆ OnTimeout()

void CGUIDialogSettingsBase::OnTimeout ( )
overrideprotectedvirtual

Implements ITimerCallback.

◆ SetControlLabel()

void CGUIDialogSettingsBase::SetControlLabel ( int controlId,
const CVariant & label )
protected

◆ SetDescription()

void CGUIDialogSettingsBase::SetDescription ( const CVariant & label)
protectedvirtual

◆ SetHeading()

void CGUIDialogSettingsBase::SetHeading ( const CVariant & label)
protectedvirtual

◆ SetupControls()

void CGUIDialogSettingsBase::SetupControls ( bool createSettings = true)
protectedvirtual

◆ SetupView()

◆ UpdateSettingControl() [1/2]

void CGUIDialogSettingsBase::UpdateSettingControl ( const BaseSettingControlPtr & pSettingControl,
bool updateDisplayOnly = false )
protected

◆ UpdateSettingControl() [2/2]

void CGUIDialogSettingsBase::UpdateSettingControl ( const std::string & settingId,
bool updateDisplayOnly = false )
protected

◆ UpdateSettings()

void CGUIDialogSettingsBase::UpdateSettings ( )
protectedvirtual

Member Data Documentation

◆ m_categories

std::vector<std::shared_ptr<CSettingCategory> > CGUIDialogSettingsBase::m_categories
protected

◆ m_confirmed

bool CGUIDialogSettingsBase::m_confirmed = false
protected

◆ m_delayedSetting

BaseSettingControlPtr CGUIDialogSettingsBase::m_delayedSetting
protected

Current delayed setting.

See also
CBaseSettingControl::SetDelayed()

◆ m_delayedTimer

CTimer CGUIDialogSettingsBase::m_delayedTimer
protected

Delayed setting timer.

◆ m_dummyCategory

std::shared_ptr<CSettingCategory> CGUIDialogSettingsBase::m_dummyCategory
protected

◆ m_fadedControl

int CGUIDialogSettingsBase::m_fadedControl = 0
protected

◆ m_focusedControl

int CGUIDialogSettingsBase::m_focusedControl = 0
protected

◆ m_iCategory

int CGUIDialogSettingsBase::m_iCategory = 0
protected

◆ m_iSetting

int CGUIDialogSettingsBase::m_iSetting = 0
protected

◆ m_newOriginalEdit

bool CGUIDialogSettingsBase::m_newOriginalEdit = false
protected

◆ m_pOriginalButton

CGUIButtonControl* CGUIDialogSettingsBase::m_pOriginalButton
protected

◆ m_pOriginalCategoryButton

CGUIButtonControl* CGUIDialogSettingsBase::m_pOriginalCategoryButton
protected

◆ m_pOriginalColorButton

CGUIColorButtonControl* CGUIDialogSettingsBase::m_pOriginalColorButton = nullptr
protected

◆ m_pOriginalEdit

CGUIEditControl* CGUIDialogSettingsBase::m_pOriginalEdit
protected

◆ m_pOriginalGroupTitle

CGUILabelControl* CGUIDialogSettingsBase::m_pOriginalGroupTitle
protected

◆ m_pOriginalImage

CGUIImage* CGUIDialogSettingsBase::m_pOriginalImage
protected

◆ m_pOriginalRadioButton

CGUIRadioButtonControl* CGUIDialogSettingsBase::m_pOriginalRadioButton
protected

◆ m_pOriginalSlider

CGUISettingsSliderControl* CGUIDialogSettingsBase::m_pOriginalSlider
protected

◆ m_pOriginalSpin

CGUISpinControlEx* CGUIDialogSettingsBase::m_pOriginalSpin
protected

◆ m_resetSetting

std::shared_ptr<CSettingAction> CGUIDialogSettingsBase::m_resetSetting
protected

◆ m_settingControls

std::vector<BaseSettingControlPtr> CGUIDialogSettingsBase::m_settingControls
protected

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