sync with upstreamHEADmaster

1 files changed, 116 insertions, 111 deletions

diff --git a/xbmc/addons/kodi-addon-dev-kit/include/kodi/gui/controls/FadeLabel.h b/xbmc/addons/kodi-addon-dev-kit/include/kodi/gui/controls/FadeLabel.h
index aab8929..02c843f 100644
--- a/xbmc/addons/kodi-addon-dev-kit/include/kodi/gui/controls/FadeLabel.h
+++ b/xbmc/addons/kodi-addon-dev-kit/include/kodi/gui/controls/FadeLabel.h
@@ -18,130 +18,135 @@ 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 ATTRIBUTE_HIDDEN CFadeLabel : public CAddonGUIControlBase
+{
+public:
+  //==========================================================================
   ///
-  /// \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**
+  /// \ingroup cpp_kodi_gui_controls_CFadeLabel
+  /// @brief Construct a new control.
   ///
-  /// 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.
+  /// @param[in] window     related window control class
+  /// @param[in] controlId  Used skin xml control id
   ///
-  /// It has the header \ref FadeLabel.h "#include <kodi/gui/controls/FadeLabel.h>"
-  /// be included to enjoy it.
+  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 !!!");
+  }
+  //--------------------------------------------------------------------------
+
+  //==========================================================================
   ///
-  /// Here you find the needed skin part for a \ref Fade_Label_Control "fade label control"
+  /// \ingroup cpp_kodi_gui_controls_CFadeLabel
+  /// @brief Destructor.
+  ///
+  ~CFadeLabel() override = default;
+  //--------------------------------------------------------------------------
+
+  //==========================================================================
   ///
-  /// @note The  call of the  control is only  possible from  the  corresponding
-  /// window as its class and identification number is required.
+  /// \ingroup cpp_kodi_gui_controls_CFadeLabel
+  /// @brief Set the control on window to visible.
   ///
-  class CFadeLabel : public CAddonGUIControlBase
+  /// @param[in] visible    If true visible, otherwise hidden
+  ///
+  void SetVisible(bool visible)
   {
-  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;
-    //--------------------------------------------------------------------------
+    m_interface->kodi_gui->control_fade_label->set_visible(m_interface->kodiBase, m_controlHandle,
+                                                           visible);
+  }
+  //--------------------------------------------------------------------------
 
-    //==========================================================================
-    ///
-    /// \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 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
+  //==========================================================================
+  ///
+  /// \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)
     {
-      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;
+      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 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);
-    }
-    //--------------------------------------------------------------------------
-  };
+  //==========================================================================
+  ///
+  /// \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 */