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

#include <Spin.h>

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

Public Member Functions

 CSpin (CWindow *window, int controlId)
 Construct a new control.
 
 ~CSpin () 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 spin control.
 
void Reset ()
 To reset spin control to defaults.
 
void SetType (AddonGUISpinControlType type)
 To set the with SpinControlType defined types of spin.
 
void AddLabel (const std::string &label, const std::string &value)
 To add a label entry in spin defined with a value as string.
 
void AddLabel (const std::string &label, int value)
 To add a label entry in spin defined with a value as integer.
 
void SetStringValue (const std::string &value)
 To change the spin to position with them string as value.
 
std::string GetStringValue () const
 To get the current spin control position with text string value.
 
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 SetFloatRange (float start, float end)
 To set the the range as float of spin, e.g. -25.0 is the spin start and e.g. +25.0 is the from here defined position where it reach the end.
 
void SetFloatValue (float value)
 Set the spin 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 spin, 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: