Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
kodi::gui::controls::CSettingsSlider Class Reference

#include <SettingsSlider.h>

Inheritance diagram for kodi::gui::controls::CSettingsSlider:
kodi::gui::CAddonGUIControlBase

Public Member Functions

 CSettingsSlider (CWindow *window, int controlId)
 Construct a new control.
 
 ~CSettingsSlider () override=default
 Destructor.
 
void SetVisible (bool visible)
 Set the control on window to visible.
 
void SetEnabled (bool enabled)
 Set's the control's enabled/disabled state.
 
void SetText (const std::string &text)
 To set the text string on settings slider.
 
void Reset ()
 To reset slider on defaults.
 
void SetIntRange (int start, int end)
 To set the the range as integer of slider, e.g. -10 is the slider start and e.g. +10 is the from here defined position where it reach the end.
 
void SetIntValue (int value)
 Set the slider position with the given integer value. The Range must be defined with a call from SetIntRange before.
 
int GetIntValue () const
 To get the current position as integer value.
 
void SetIntInterval (int interval)
 To set the interval steps of slider, as default is it 1. If it becomes changed with this function will a step of the user with the value fixed here be executed.
 
void SetPercentage (float percent)
 Sets the percent of the slider.
 
float GetPercentage () const
 Returns a float of the percent of the slider.
 
void SetFloatRange (float start, float end)
 To set the the range as float of slider, e.g. -25.0 is the slider start and e.g. +25.0 is the from here defined position where it reach the end.
 
void SetFloatValue (float value)
 Set the slider position with the given float value. The Range can be defined with a call from SetIntRange before, as default it is 0.0 to 1.0.
 
float GetFloatValue () const
 To get the current position as float value.
 
void SetFloatInterval (float interval)
 To set the interval steps of slider, as default is it 0.1 If it becomes changed with this function will a step of the user with the value fixed here be executed.
 
- Public Member Functions inherited from kodi::gui::CAddonGUIControlBase
KODI_GUI_LISTITEM_HANDLE GetControlHandle () const
 

Additional Inherited Members

- Protected Member Functions inherited from kodi::gui::CAddonGUIControlBase
 CAddonGUIControlBase (CAddonGUIControlBase *window)
 
virtual ~CAddonGUIControlBase ()=default
 
- Protected Attributes inherited from kodi::gui::CAddonGUIControlBase
KODI_GUI_LISTITEM_HANDLE m_controlHandle
 
AddonToKodiFuncTable_Addonm_interface
 
CAddonGUIControlBasem_Window
 

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