Dialog.h

/*
 *  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 "AddonClass.h"
#include "AddonString.h"
#include "Alternative.h"
#include "ListItem.h"
#include "dialogs/GUIDialogBoxBase.h"
#include "dialogs/GUIDialogExtendedProgressBar.h"
#include "dialogs/GUIDialogProgress.h"
#include "swighelper.h"
 
#include <string>
#include <vector>
 
namespace XBMCAddon
{
namespace xbmcgui
{
#ifndef SWIG
// These constants are exposed to Python via SWIG_CONSTANT in ModuleXbmcgui.h.
// Excluded from SWIG processing here to avoid Warning 302 redefinition.
constexpr int INPUT_ALPHANUM{0};
constexpr int INPUT_NUMERIC{1};
constexpr int INPUT_DATE{2};
constexpr int INPUT_TIME{3};
constexpr int INPUT_IPADDRESS{4};
constexpr int INPUT_PASSWORD{5};
 
constexpr int PASSWORD_VERIFY{1};
constexpr int ALPHANUM_HIDE_INPUT{2};
#endif
 
    class Dialog : public AddonClass
    {
    public:
 
      inline Dialog() = default;
      ~Dialog() override;
 
#ifdef DOXYGEN_SHOULD_USE_THIS
      yesno(...);
#else
      bool yesno(const String& heading,
                 const String& message,
                 const String& nolabel = emptyString,
                 const String& yeslabel = emptyString,
                 int autoclose = 0,
                 int defaultbutton = CONTROL_NO_BUTTON);
#endif
 
#ifdef DOXYGEN_SHOULD_USE_THIS
      yesnocustom(...);
#else
      int yesnocustom(const String& heading,
                      const String& message,
                      const String& customlabel,
                      const String& nolabel = emptyString,
                      const String& yeslabel = emptyString,
                      int autoclose = 0,
                      int defaultbutton = CONTROL_NO_BUTTON);
#endif
 
#ifdef DOXYGEN_SHOULD_USE_THIS
      info(...);
#else
      bool info(const ListItem* item);
#endif
 
#ifdef DOXYGEN_SHOULD_USE_THIS
      select(...);
#else
      int select(const String& heading, const std::vector<Alternative<String, const ListItem* > > & list, int autoclose=0, int preselect=-1, bool useDetails=false);
#endif
 
#ifdef DOXYGEN_SHOULD_USE_THIS
      contextmenu(...);
#else
      int contextmenu(const std::vector<String>& list);
#endif
 
#ifdef DOXYGEN_SHOULD_USE_THIS
      multiselect(...);
#else
      std::unique_ptr<std::vector<int> > multiselect(const String& heading, const std::vector<Alternative<String, const ListItem* > > & options, int autoclose=0, const std::vector<int>& preselect = std::vector<int>(), bool useDetails=false);
#endif
 
#ifdef DOXYGEN_SHOULD_USE_THIS
      ok(...);
#else
      bool ok(const String& heading, const String& message);
#endif
 
#ifdef DOXYGEN_SHOULD_USE_THIS
      textviewer(...);
#else
      void textviewer(const String& heading, const String& text, bool usemono = false);
#endif
 
#ifdef DOXYGEN_SHOULD_USE_THIS
      browse(...);
#else
      Alternative<String, std::vector<String> > browse(int type, const String& heading, const String& shares,
                          const String& mask = emptyString, bool useThumbs = false,
                          bool treatAsFolder = false, const String& defaultt = emptyString,
                          bool enableMultiple = false);
#endif
 
#ifdef DOXYGEN_SHOULD_USE_THIS
      browseSingle(...);
#else
      String browseSingle(int type, const String& heading, const String& shares,
                          const String& mask = emptyString, bool useThumbs = false,
                          bool treatAsFolder = false,
                          const String& defaultt = emptyString );
#endif
 
#ifdef DOXYGEN_SHOULD_USE_THIS
      browseMultiple(...);
#else
      std::vector<String> browseMultiple(int type, const String& heading, const String& shares,
                                         const String& mask = emptyString, bool useThumbs = false,
                                         bool treatAsFolder = false,
                                         const String& defaultt = emptyString );
#endif
 
#ifdef DOXYGEN_SHOULD_USE_THIS
      numeric(...);
#else
      String numeric(int type, const String& heading, const String& defaultt = emptyString, bool bHiddenInput = false);
#endif
 
#ifdef DOXYGEN_SHOULD_USE_THIS
      notification(...);
#else
      void notification(const String& heading, const String& message, const String& icon = emptyString, int time = 0, bool sound = true);
#endif
 
#ifdef DOXYGEN_SHOULD_USE_THIS
      input(...);
#else
      String input(const String& heading,
                   const String& defaultt = emptyString,
                   int type = INPUT_ALPHANUM,
                   int option = 0,
                   int autoclose = 0);
#endif
 
#ifdef DOXYGEN_SHOULD_USE_THIS
      colorpicker(...);
#else
      String colorpicker(
          const String& heading,
          const String& selectedcolor = emptyString,
          const String& colorfile = emptyString,
          const std::vector<const ListItem*>& colorlist = std::vector<const ListItem*>());
#endif
 
    private:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
      // used by both yesno() and yesnocustom()
      int yesNoCustomInternal(const String& heading,
                              const String& message,
                              const String& nolabel,
                              const String& yeslabel,
                              const String& customlabel,
                              int autoclose,
                              int defaultbutton);
#endif
    };
 
    class DialogProgress : public AddonClass
    {
      CGUIDialogProgress* dlg = nullptr;
      bool                open = false;
 
    protected:
      void deallocating() override;
 
    public:
 
      DialogProgress() = default;
      ~DialogProgress() override;
 
#ifdef DOXYGEN_SHOULD_USE_THIS
      create(...);
#else
      void create(const String& heading, const String& message = emptyString);
#endif
 
#ifdef DOXYGEN_SHOULD_USE_THIS
      update(...);
#else
      void update(int percent, const String& message = emptyString);
#endif
 
#ifdef DOXYGEN_SHOULD_USE_THIS
      close(...);
#else
      void close();
#endif
 
#ifdef DOXYGEN_SHOULD_USE_THIS
      iscanceled(...);
#else
      bool iscanceled();
#endif
    };
 
 
    class DialogProgressBG : public AddonClass
    {
      CGUIDialogExtendedProgressBar* dlg = nullptr;
      CGUIDialogProgressBarHandle* handle = nullptr;
      bool open = false;
 
    protected:
      void deallocating() override;
 
    public:
 
      DialogProgressBG() = default;
      ~DialogProgressBG() override;
 
#ifdef DOXYGEN_SHOULD_USE_THIS
      create(...);
#else
      void create(const String& heading, const String& message = emptyString);
#endif
 
#ifdef DOXYGEN_SHOULD_USE_THIS
      update(...);
#else
      void update(int percent = 0, const String& heading = emptyString, const String& message = emptyString);
#endif
 
#ifdef DOXYGEN_SHOULD_USE_THIS
      close(...);
#else
      void close();
#endif
 
#ifdef DOXYGEN_SHOULD_USE_THIS
      isFinished(...);
#else
      bool isFinished();
#endif
    };
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    SWIG_CONSTANT2(int, DLG_YESNO_NO_BTN, CONTROL_NO_BUTTON);
    SWIG_CONSTANT2(int, DLG_YESNO_YES_BTN, CONTROL_YES_BUTTON);
    SWIG_CONSTANT2(int, DLG_YESNO_CUSTOM_BTN, CONTROL_CUSTOM_BUTTON);
#endif
} // namespace xbmcgui
} // namespace XBMCAddon