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
168
169
170
171
|
/*
* 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_CButton Control Button
/// \ingroup cpp_kodi_gui
/// @brief \cpp_class{ kodi::gui::controls::CButton }
/// **Standard push button control for window**
///
/// The button control is used for creating push buttons in Kodi. You can
/// choose the position, size, and look of the button, as well as choosing
/// what action(s) should be performed when pushed.
///
/// It has the header \ref Button.h "#include <kodi/gui/controls/Button.h>"
/// be included to enjoy it.
///
/// Here you find the needed skin part for a \ref skin_Button_control "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 CButton : public CAddonGUIControlBase
{
public:
//==========================================================================
///
/// @ingroup cpp_kodi_gui_control_CButton
/// @brief Construct a new control
///
/// @param[in] window related window control class
/// @param[in] controlId Used skin xml control id
///
CButton(CWindow* window, int controlId) : CAddonGUIControlBase(window)
{
m_controlHandle = m_interface->kodi_gui->window->get_control_button(
m_interface->kodiBase, m_Window->GetControlHandle(), controlId);
if (!m_controlHandle)
kodi::Log(ADDON_LOG_FATAL, "kodi::gui::CButton can't create control class from Kodi !!!");
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// @ingroup cpp_kodi_gui_control_CButton
/// @brief Destructor
///
~CButton() override = default;
//--------------------------------------------------------------------------
//==========================================================================
///
/// @ingroup cpp_kodi_gui_control_CButton
/// @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_button->set_visible(m_interface->kodiBase, m_controlHandle,
visible);
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// @ingroup cpp_kodi_gui_control_CButton
/// @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_button->set_enabled(m_interface->kodiBase, m_controlHandle,
enabled);
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// @ingroup cpp_kodi_gui_control_CButton
/// @brief To set the text string on button
///
/// @param[in] label Text to show
///
void SetLabel(const std::string& label)
{
m_interface->kodi_gui->control_button->set_label(m_interface->kodiBase, m_controlHandle,
label.c_str());
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// @ingroup cpp_kodi_gui_control_CButton
/// @brief Get the used text from button
///
/// @return Text shown
///
std::string GetLabel() const
{
std::string label;
char* ret =
m_interface->kodi_gui->control_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_control_CButton
/// @brief If two labels are used for button becomes it set with them
///
/// @param[in] label Text for second label
///
void SetLabel2(const std::string& label)
{
m_interface->kodi_gui->control_button->set_label2(m_interface->kodiBase, m_controlHandle,
label.c_str());
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// @ingroup cpp_kodi_gui_control_CButton
/// @brief Get the second label if present
///
/// @return Second label
///
std::string GetLabel2() const
{
std::string label;
char* ret =
m_interface->kodi_gui->control_button->get_label2(m_interface->kodiBase, m_controlHandle);
if (ret != nullptr)
{
if (std::strlen(ret))
label = ret;
m_interface->free_string(m_interface->kodiBase, ret);
}
return label;
}
//--------------------------------------------------------------------------
};
} /* namespace controls */
} /* namespace gui */
} /* namespace kodi */
|
