xbmc/addons/gui/GUIHelpers.h

   1 /*
   2  *  Copyright (C) 2005-2020 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #pragma once
  10
  11 #include <memory>
  12
  13 namespace ADDON
  14 {
  15
  16 class IAddon;
  17
  18 namespace GUI
  19 {
  20
  21 class CHelpers
  22 {
  23 public:
  24   /*!
  25    * @brief This shows an Yes/No dialog with information about the add-on if it is
  26    * not in the normal status.
  27    *
  28    * This asks the user whether he really wants to use the add-on and informs with
  29    * text why the other status is.
  30    *
  31    * @note The dialog is currently displayed for @ref AddonLifecycleState::BROKEN
  32    * and @ref AddonLifecycleState::DEPRECATED.
  33    *
  34    * @param[in] addon Class of the add-on to be checked
  35    * @return True if user activation is desired, false if not
  36    */
  37   static bool DialogAddonLifecycleUseAsk(const std::shared_ptr<const IAddon>& addon);
  38 };
  39
  40 } /* namespace GUI */
  41 } /* namespace ADDON */