sync with upstream

1 files changed, 105 insertions, 0 deletions

diff --git a/xbmc/addons/kodi-addon-dev-kit/include/kodi/gui/dialogs/Select.h b/xbmc/addons/kodi-addon-dev-kit/include/kodi/gui/dialogs/Select.h
new file mode 100644
index 0000000..963c84c
--- /dev/null
+++ b/xbmc/addons/kodi-addon-dev-kit/include/kodi/gui/dialogs/Select.h
@@ -0,0 +1,105 @@
+#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 "../definitions.h"
+#include "../../AddonBase.h"
+
+namespace kodi
+{
+namespace gui
+{
+namespace dialogs
+{
+
+  //============================================================================
+  ///
+  /// \defgroup cpp_kodi_gui_dialogs_Select Dialog Select
+  /// \ingroup cpp_kodi_gui
+  /// @{
+  /// @brief \cpp_namespace{ kodi::gui::dialogs::Select }
+  /// **Selection dialog**
+  ///
+  /// The function listed below permits the call of a dialogue to select of an
+  /// entry as a key
+  ///
+  /// It has the header \ref Select.h "#include <kodi/gui/dialogs/Select.h>"
+  /// be included to enjoy it.
+  ///
+  ///
+  namespace Select
+  {
+    //==========================================================================
+    ///
+    /// \ingroup cpp_kodi_gui_dialogs_Select
+    /// @brief Show a selection dialog about given parts.
+    ///
+    /// @param[in] heading      Dialog heading name
+    /// @param[in] entries      String list about entries
+    /// @param[in] selected     [opt] Predefined selection (default is
+    ///                         <tt>-1</tt> for the first)
+    /// @param[in] autoclose    [opt] To close dialog automatic after the given
+    ///                         time in ms. As '0' it stays open.
+    /// @return                 The selected entry, if return <tt>-1</tt> was
+    ///                         nothing selected or canceled
+    ///
+    ///
+    ///-------------------------------------------------------------------------
+    ///
+    /// **Example:**
+    /// ~~~~~~~~~~~~~{.cpp}
+    /// #include <kodi/gui/dialogs/Select.h>
+    ///
+    /// const std::vector<std::string> entries
+    /// {
+    ///   "Test 1",
+    ///   "Test 2",
+    ///   "Test 3",
+    ///   "Test 4",
+    ///   "Test 5"
+    /// };
+    ///
+    /// int selected = kodi::gui::dialogs::Select::Show("Test selection", entries, -1);
+    /// if (selected < 0)
+    ///   fprintf(stderr, "Item selection canceled\n");
+    /// else
+    ///   fprintf(stderr, "Selected item is: %i\n", selected);
+    /// ~~~~~~~~~~~~~
+    ///
+    inline int Show(const std::string& heading, const std::vector<std::string>& entries, int selected = -1, unsigned int autoclose = 0)
+    {
+      using namespace ::kodi::addon;
+      unsigned int size = entries.size();
+      const char** cEntries = (const char**)malloc(size*sizeof(const char**));
+      for (unsigned int i = 0; i < size; ++i)
+      {
+        cEntries[i] = entries[i].c_str();
+      }
+      int ret = CAddonBase::m_interface->toKodi->kodi_gui->dialogSelect->open(CAddonBase::m_interface->toKodi->kodiBase, heading.c_str(), cEntries, size, selected, autoclose);
+      free(cEntries);
+      return ret;
+    }
+    //--------------------------------------------------------------------------
+  };
+  /// @}
+
+} /* namespace dialogs */
+} /* namespace gui */
+} /* namespace kodi */