summaryrefslogtreecommitdiffstats
path: root/xbmc/guilib/GUISliderControl.h
diff options
context:
space:
mode:
Diffstat (limited to 'xbmc/guilib/GUISliderControl.h')
-rw-r--r--xbmc/guilib/GUISliderControl.h129
1 files changed, 129 insertions, 0 deletions
diff --git a/xbmc/guilib/GUISliderControl.h b/xbmc/guilib/GUISliderControl.h
new file mode 100644
index 0000000..196adb2
--- /dev/null
+++ b/xbmc/guilib/GUISliderControl.h
@@ -0,0 +1,129 @@
+/*
+ * Copyright (C) 2005-2018 Team Kodi
+ * This file is part of Kodi - https://kodi.tv
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ * See LICENSES/README.md for more information.
+ */
+
+#pragma once
+
+/*!
+\file GUISliderControl.h
+\brief
+*/
+
+#include "GUIControl.h"
+#include "GUITexture.h"
+
+#include <array>
+
+#define SLIDER_CONTROL_TYPE_INT 1
+#define SLIDER_CONTROL_TYPE_FLOAT 2
+#define SLIDER_CONTROL_TYPE_PERCENTAGE 3
+
+typedef struct
+{
+ const char *action;
+ const char *formatString;
+ int infoCode;
+ bool fireOnDrag;
+} SliderAction;
+
+/*!
+ \ingroup controls
+ \brief
+ */
+class CGUISliderControl :
+ public CGUIControl
+{
+public:
+ typedef enum {
+ RangeSelectorLower = 0,
+ RangeSelectorUpper = 1
+ } RangeSelector;
+
+ CGUISliderControl(int parentID, int controlID, float posX, float posY, float width, float height, const CTextureInfo& backGroundTexture, const CTextureInfo& mibTexture, const CTextureInfo& nibTextureFocus, int iType, ORIENTATION orientation);
+ ~CGUISliderControl() override = default;
+ CGUISliderControl* Clone() const override { return new CGUISliderControl(*this); }
+
+ void Process(unsigned int currentTime, CDirtyRegionList &dirtyregions) override;
+ void Render() override;
+ bool OnAction(const CAction &action) override;
+ virtual bool IsActive() const { return true; }
+ void AllocResources() override;
+ void FreeResources(bool immediately = false) override;
+ void DynamicResourceAlloc(bool bOnOff) override;
+ void SetInvalid() override;
+ virtual void SetRange(int iStart, int iEnd);
+ virtual void SetFloatRange(float fStart, float fEnd);
+ bool OnMessage(CGUIMessage& message) override;
+ bool ProcessSelector(CGUITexture* nib,
+ unsigned int currentTime,
+ float fScale,
+ RangeSelector selector);
+ void SetRangeSelection(bool rangeSelection);
+ bool GetRangeSelection() const { return m_rangeSelection; }
+ void SetRangeSelector(RangeSelector selector);
+ void SwitchRangeSelector();
+ void SetInfo(int iInfo);
+ void SetPercentage(float iPercent, RangeSelector selector = RangeSelectorLower, bool updateCurrent = false);
+ float GetPercentage(RangeSelector selector = RangeSelectorLower) const;
+ void SetIntValue(int iValue, RangeSelector selector = RangeSelectorLower, bool updateCurrent = false);
+ int GetIntValue(RangeSelector selector = RangeSelectorLower) const;
+ void SetFloatValue(float fValue, RangeSelector selector = RangeSelectorLower, bool updateCurrent = false);
+ float GetFloatValue(RangeSelector selector = RangeSelectorLower) const;
+ void SetIntInterval(int iInterval);
+ void SetFloatInterval(float fInterval);
+ void SetType(int iType) { m_iType = iType; }
+ int GetType() const { return m_iType; }
+ std::string GetDescription() const override;
+ void SetTextValue(const std::string& textValue) { m_textValue = textValue; }
+ void SetAction(const std::string &action);
+
+protected:
+ CGUISliderControl(const CGUISliderControl& control);
+
+ bool HitTest(const CPoint &point) const override;
+ EVENT_RESULT OnMouseEvent(const CPoint &point, const CMouseEvent &event) override;
+ bool UpdateColors(const CGUIListItem* item) override;
+ virtual void Move(int iNumSteps);
+ virtual void SetFromPosition(const CPoint &point, bool guessSelector = false);
+ /*! \brief Get the current position of the slider as a proportion
+ \return slider position in the range [0,1]
+ */
+ float GetProportion(RangeSelector selector = RangeSelectorLower) const;
+
+ /*! \brief Send a click message (and/or action) to the app in response to a slider move
+ */
+ void SendClick();
+
+ std::unique_ptr<CGUITexture> m_guiBackground;
+ std::unique_ptr<CGUITexture> m_guiSelectorLower;
+ std::unique_ptr<CGUITexture> m_guiSelectorUpper;
+ std::unique_ptr<CGUITexture> m_guiSelectorLowerFocus;
+ std::unique_ptr<CGUITexture> m_guiSelectorUpperFocus;
+ int m_iType;
+
+ bool m_rangeSelection;
+ RangeSelector m_currentSelector;
+
+ std::array<float, 2> m_percentValues;
+
+ std::array<int, 2> m_intValues;
+ int m_iStart;
+ int m_iInterval;
+ int m_iEnd;
+
+ std::array<float, 2> m_floatValues;
+ float m_fStart;
+ float m_fInterval;
+ float m_fEnd;
+
+ int m_iInfoCode;
+ std::string m_textValue; ///< Allows overriding of the text value to be displayed (parent must update when the slider updates)
+ const SliderAction *m_action; ///< Allows the skin to configure the action of a click on the slider \sa SendClick
+ bool m_dragging; ///< Whether we're in a (mouse/touch) drag operation or not - some actions are sent only on release.
+ ORIENTATION m_orientation;
+};
+