summaryrefslogtreecommitdiffstats
path: root/xbmc/addons/kodi-addon-dev-kit/include/kodi/gui/controls/RadioButton.h
blob: 305195d46b2924a4ca081d742e7f1950238629f8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
/*
 *  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

#include "../../AddonBase.h"
#include "../Window.h"

namespace kodi
{
namespace gui
{
namespace controls
{

//============================================================================
///
/// \defgroup cpp_kodi_gui_controls_CRadioButton Control Radio Button
/// \ingroup cpp_kodi_gui
/// @brief \cpp_class{ kodi::gui::controls::CRadioButton }
/// **Window control for a radio button (as used for on/off settings)**
///
/// The radio  button control is used for creating push button on/off settings
/// in Kodi. You can choose the position,  size,  and look of the button. When
/// the user clicks on the radio button,  the state will change,  toggling the
/// extra  textures  (textureradioon and textureradiooff).  Used  for settings
/// controls.
///
/// It has the header \ref RadioButton.h "#include <kodi/gui/controls/RadioButton.h>"
/// be included to enjoy it.
///
/// Here you find the needed skin part for a \ref Radio_button_control "radio button control"
///
/// @note The  call  of the  control is  only possible  from the corresponding
/// window as its class and identification number is required.
///
class ATTRIBUTE_HIDDEN CRadioButton : public CAddonGUIControlBase
{
public:
  //==========================================================================
  ///
  /// \ingroup cpp_kodi_gui_controls_CRadioButton
  /// @brief Construct a new control
  ///
  /// @param[in] window     related window control class
  /// @param[in] controlId  Used skin xml control id
  ///
  CRadioButton(CWindow* window, int controlId) : CAddonGUIControlBase(window)
  {
    m_controlHandle = m_interface->kodi_gui->window->get_control_radio_button(
        m_interface->kodiBase, m_Window->GetControlHandle(), controlId);
    if (!m_controlHandle)
      kodi::Log(ADDON_LOG_FATAL,
                "kodi::gui::controls::CRadioButton can't create control class from Kodi !!!");
  }
  //--------------------------------------------------------------------------

  //==========================================================================
  ///
  /// \ingroup cpp_kodi_gui_controls_CRadioButton
  /// @brief Destructor
  ///
  ~CRadioButton() override = default;
  //--------------------------------------------------------------------------

  //==========================================================================
  ///
  /// \ingroup cpp_kodi_gui_controls_CRadioButton
  /// @brief Set the control on window to visible
  ///
  /// @param[in] visible    If true visible, otherwise hidden
  ///
  void SetVisible(bool visible)
  {
    m_interface->kodi_gui->control_radio_button->set_visible(m_interface->kodiBase, m_controlHandle,
                                                             visible);
  }
  //--------------------------------------------------------------------------

  //==========================================================================
  ///
  /// \ingroup cpp_kodi_gui_controls_CRadioButton
  /// @brief Set's the control's enabled/disabled state
  ///
  /// @param[in] enabled    If true enabled, otherwise disabled
  ///
  void SetEnabled(bool enabled)
  {
    m_interface->kodi_gui->control_radio_button->set_enabled(m_interface->kodiBase, m_controlHandle,
                                                             enabled);
  }
  //--------------------------------------------------------------------------

  //==========================================================================
  ///
  /// \ingroup cpp_kodi_gui_controls_CRadioButton
  /// @brief To set the text string on radio button
  ///
  /// @param[in] label      Text to show
  ///
  void SetLabel(const std::string& label)
  {
    m_interface->kodi_gui->control_radio_button->set_label(m_interface->kodiBase, m_controlHandle,
                                                           label.c_str());
  }
  //--------------------------------------------------------------------------

  //==========================================================================
  ///
  /// \ingroup cpp_kodi_gui_controls_CRadioButton
  /// @brief Get the used text from control
  ///
  /// @return               Text shown
  ///
  std::string GetLabel() const
  {
    std::string label;
    char* ret = m_interface->kodi_gui->control_radio_button->get_label(m_interface->kodiBase,
                                                                       m_controlHandle);
    if (ret != nullptr)
    {
      if (std::strlen(ret))
        label = ret;
      m_interface->free_string(m_interface->kodiBase, ret);
    }
    return label;
  }
  //--------------------------------------------------------------------------

  //==========================================================================
  ///
  /// \ingroup cpp_kodi_gui_controls_CRadioButton
  /// @brief To set radio button condition to on or off
  ///
  /// @param[in] selected   true set radio button to  selection on,  otherwise
  ///                       off
  ///
  void SetSelected(bool selected)
  {
    m_interface->kodi_gui->control_radio_button->set_selected(m_interface->kodiBase,
                                                              m_controlHandle, selected);
  }
  //--------------------------------------------------------------------------

  //==========================================================================
  ///
  /// \ingroup cpp_kodi_gui_controls_CRadioButton
  /// @brief Get the current selected condition of radio button
  ///
  /// @return               Selected condition
  ///
  bool IsSelected() const
  {
    return m_interface->kodi_gui->control_radio_button->is_selected(m_interface->kodiBase,
                                                                    m_controlHandle);
  }
  //--------------------------------------------------------------------------
};

} /* namespace controls */
} /* namespace gui */
} /* namespace kodi */