sync with upstream

1 files changed, 112 insertions, 0 deletions

diff --git a/xbmc/addons/kodi-dev-kit/include/kodi/gui/controls/Image.h b/xbmc/addons/kodi-dev-kit/include/kodi/gui/controls/Image.h
new file mode 100644
index 0000000..9dc493e
--- /dev/null
+++ b/xbmc/addons/kodi-dev-kit/include/kodi/gui/controls/Image.h
@@ -0,0 +1,112 @@
+/*
+ *  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 "../../c-api/gui/controls/image.h"
+#include "../Window.h"
+
+#ifdef __cplusplus
+
+namespace kodi
+{
+namespace gui
+{
+namespace controls
+{
+
+//============================================================================
+/// @defgroup cpp_kodi_gui_windows_controls_CImage Control Image
+/// @ingroup cpp_kodi_gui_windows_controls
+/// @brief @cpp_class{ kodi::gui::controls::CImage }
+/// **Window control used to show an image.**\n
+/// The image control is used for displaying images in Kodi. You can choose
+/// the position, size, transparency and contents of the image to be displayed.
+///
+/// It has the header @ref Image.h "#include <kodi/gui/controls/Image.h>"
+/// be included to enjoy it.
+///
+/// Here you find the needed skin part for a @ref Image_Control "image 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 CImage : public CAddonGUIControlBase
+{
+public:
+  //==========================================================================
+  /// @ingroup cpp_kodi_gui_windows_controls_CImage
+  /// @brief Construct a new control.
+  ///
+  /// @param[in] window Related window control class
+  /// @param[in] controlId Used skin xml control id
+  ///
+  CImage(CWindow* window, int controlId) : CAddonGUIControlBase(window)
+  {
+    m_controlHandle = m_interface->kodi_gui->window->get_control_image(
+        m_interface->kodiBase, m_Window->GetControlHandle(), controlId);
+    if (!m_controlHandle)
+      kodi::Log(ADDON_LOG_FATAL,
+                "kodi::gui::controls::CImage can't create control class from Kodi !!!");
+  }
+  //--------------------------------------------------------------------------
+
+  //==========================================================================
+  /// @ingroup cpp_kodi_gui_windows_controls_CImage
+  /// @brief Destructor.
+  ///
+  ~CImage() override = default;
+  //--------------------------------------------------------------------------
+
+  //==========================================================================
+  /// @ingroup cpp_kodi_gui_windows_controls_CImage
+  /// @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_image->set_visible(m_interface->kodiBase, m_controlHandle,
+                                                      visible);
+  }
+  //--------------------------------------------------------------------------
+
+  //==========================================================================
+  /// @ingroup cpp_kodi_gui_windows_controls_CImage
+  /// @brief To set the filename used on image control.
+  ///
+  /// @param[in] filename Image file to use
+  /// @param[in] useCache To define storage of image, default is in cache, if
+  ///                     false becomes it loaded always on changes again
+  ///
+  void SetFileName(const std::string& filename, bool useCache = true)
+  {
+    m_interface->kodi_gui->control_image->set_filename(m_interface->kodiBase, m_controlHandle,
+                                                       filename.c_str(), useCache);
+  }
+  //--------------------------------------------------------------------------
+
+  //==========================================================================
+  /// @ingroup cpp_kodi_gui_windows_controls_CImage
+  /// @brief To set set the diffuse color on image.
+  ///
+  /// @param[in] colorDiffuse Color to use for diffuse
+  ///
+  void SetColorDiffuse(uint32_t colorDiffuse)
+  {
+    m_interface->kodi_gui->control_image->set_color_diffuse(m_interface->kodiBase, m_controlHandle,
+                                                            colorDiffuse);
+  }
+  //--------------------------------------------------------------------------
+};
+
+} /* namespace controls */
+} /* namespace gui */
+} /* namespace kodi */
+
+#endif /* __cplusplus */