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
|
#pragma once
/*
* Copyright (C) 2005-2017 Team KODI
* http://kodi.tv
*
* This Program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
*
* This Program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with KODI; see the file COPYING. If not, see
* <http://www.gnu.org/licenses/>.
*
*/
#include "../../AddonBase.h"
#include "../Window.h"
namespace kodi
{
namespace gui
{
namespace controls
{
//============================================================================
///
/// \defgroup cpp_kodi_gui_controls_CFadeLabel Control Fade Label
/// \ingroup cpp_kodi_gui
/// @brief \cpp_class{ kodi::gui::controls::CFadeLabel }
/// **Window control used to show multiple pieces of text in the same position,
/// by fading from one to the other**
///
/// The fade label control is used for displaying multiple pieces of text in
/// the same space in Kodi. You can choose the font, size, colour, location
/// and contents of the text to be displayed. The first piece of information
/// to display fades in over 50 frames, then scrolls off to the left. Once it
/// is finished scrolling off screen, the second piece of information fades
/// in and the process repeats. A fade label control is not supported in a
/// list container.
///
/// It has the header \ref FadeLabel.h "#include <kodi/gui/controls/FadeLabel.h>"
/// be included to enjoy it.
///
/// Here you find the needed skin part for a \ref Fade_Label_Control "fade label control"
///
/// @note The call of the control is only possible from the corresponding
/// window as its class and identification number is required.
///
class CFadeLabel : public CAddonGUIControlBase
{
public:
//==========================================================================
///
/// \ingroup cpp_kodi_gui_controls_CFadeLabel
/// @brief Construct a new control.
///
/// @param[in] window related window control class
/// @param[in] controlId Used skin xml control id
///
CFadeLabel(CWindow* window, int controlId)
: CAddonGUIControlBase(window)
{
m_controlHandle = m_interface->kodi_gui->window->get_control_fade_label(m_interface->kodiBase, m_Window->GetControlHandle(), controlId);
if (!m_controlHandle)
kodi::Log(ADDON_LOG_FATAL, "kodi::gui::controls::CFadeLabel can't create control class from Kodi !!!");
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_controls_CFadeLabel
/// @brief Destructor.
///
~CFadeLabel() override = default;
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_controls_CFadeLabel
/// @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_fade_label->set_visible(m_interface->kodiBase, m_controlHandle, visible);
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_controls_CFadeLabel
/// @brief To add additional text string on fade label.
///
/// @param[in] label Text to show
///
void AddLabel(const std::string& label)
{
m_interface->kodi_gui->control_fade_label->add_label(m_interface->kodiBase, m_controlHandle, label.c_str());
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_controls_CFadeLabel
/// @brief Get the used text from button
///
/// @return Text shown
///
std::string GetLabel() const
{
std::string label;
char* ret = m_interface->kodi_gui->control_fade_label->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_CFadeLabel
/// @brief To enable or disable scrolling on fade label
///
/// @param[in] scroll To enable scrolling set to true, otherwise is
/// disabled
///
void SetScrolling(bool scroll)
{
m_interface->kodi_gui->control_fade_label->set_scrolling(m_interface->kodiBase, m_controlHandle, scroll);
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_controls_CFadeLabel
/// @brief To reset al inserted labels.
///
void Reset()
{
m_interface->kodi_gui->control_fade_label->reset(m_interface->kodiBase, m_controlHandle);
}
//--------------------------------------------------------------------------
};
} /* namespace controls */
} /* namespace gui */
} /* namespace kodi */
|
