xbmc/interfaces/legacy/ModuleXbmcgui.h

   1 /*
   2  *  Copyright (C) 2005-2018 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 "guilib/GUIEditControl.h"
  12 #include "swighelper.h"
  13
  14 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  15 namespace XBMCAddon
  16 {
  17   namespace xbmcgui
  18   {
  19 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
  20
  21     //
  22     /// \defgroup python_xbmcgui Library - xbmcgui
  23     /// @{
  24     /// @brief **GUI functions on Kodi.**
  25     ///
  26     /// Offers classes and functions that manipulate the Graphical User
  27     /// Interface through windows, dialogs, and various control widgets.
  28     //
  29
  30 #ifdef DOXYGEN_SHOULD_USE_THIS
  31     ///
  32     /// \ingroup python_xbmcgui
  33     /// @brief \python_func{ xbmcgui.getCurrentWindowId() }
  34     /// Returns the id for the current 'active' window as an integer.
  35     ///
  36     /// @return                        The currently active window Id
  37     ///
  38     ///
  39     ///--------------------------------------------------------------------------
  40     ///
  41     /// **Example:**
  42     /// ~~~~~~~~~~~~~{.py}
  43     /// ..
  44     /// wid = xbmcgui.getCurrentWindowId()
  45     /// ..
  46     /// ~~~~~~~~~~~~~
  47     ///
  48     getCurrentWindowId();
  49 #else
  50     long getCurrentWindowId();
  51 #endif
  52
  53 #ifdef DOXYGEN_SHOULD_USE_THIS
  54     ///
  55     /// \ingroup python_xbmcgui
  56     /// @brief \python_func{ xbmcgui.getCurrentWindowDialogId() }
  57     /// Returns the id for the current 'active' dialog as an integer.
  58     ///
  59     /// @return                        The currently active dialog Id
  60     ///
  61     ///
  62     ///--------------------------------------------------------------------------
  63     ///
  64     /// **Example:**
  65     /// ~~~~~~~~~~~~~{.py}
  66     /// ..
  67     /// wid = xbmcgui.getCurrentWindowDialogId()
  68     /// ..
  69     /// ~~~~~~~~~~~~~
  70     ///
  71     getCurrentWindowDialogId();
  72 #else
  73     long getCurrentWindowDialogId();
  74 #endif
  75
  76 #ifdef DOXYGEN_SHOULD_USE_THIS
  77     ///
  78     /// \ingroup python_xbmcgui
  79     /// @brief \python_func{ getScreenHeight() }
  80     /// Returns the height of this screen.
  81     ///
  82     /// @return                       Screen height
  83     ///
  84     ///
  85     ///-------------------------------------------------------------------------
  86     /// @python_v18 New function added.
  87     ///
  88     getScreenHeight();
  89 #else
  90     long getScreenHeight();
  91 #endif
  92
  93 #ifdef DOXYGEN_SHOULD_USE_THIS
  94     ///
  95     /// \ingroup python_xbmcgui
  96     /// @brief \python_func{ getScreenWidth() }
  97     /// Returns the width of this screen.
  98     ///
  99     /// @return                       Screen width
 100     ///
 101     ///
 102     ///-------------------------------------------------------------------------
 103     /// @python_v18 New function added.
 104     ///
 105     getScreenWidth();
 106 #else
 107     long getScreenWidth();
 108 #endif
 109     ///@}
 110
 111 #ifndef DOXYGEN_SHOULD_SKIP_THIS
 112     SWIG_CONSTANT2(int, ICON_OVERLAY_NONE, CGUIListItem::ICON_OVERLAY_NONE);
 113     SWIG_CONSTANT2(int, ICON_OVERLAY_RAR, CGUIListItem::ICON_OVERLAY_RAR);
 114     SWIG_CONSTANT2(int, ICON_OVERLAY_ZIP, CGUIListItem::ICON_OVERLAY_ZIP);
 115     SWIG_CONSTANT2(int, ICON_OVERLAY_LOCKED, CGUIListItem::ICON_OVERLAY_LOCKED);
 116     SWIG_CONSTANT2(int, ICON_OVERLAY_UNWATCHED, CGUIListItem::ICON_OVERLAY_UNWATCHED);
 117     SWIG_CONSTANT2(int, ICON_OVERLAY_WATCHED, CGUIListItem::ICON_OVERLAY_WATCHED);
 118     SWIG_CONSTANT2(int, ICON_OVERLAY_HD, CGUIListItem::ICON_OVERLAY_HD);
 119
 120     SWIG_CONSTANT2(int, INPUT_TYPE_TEXT, CGUIEditControl::INPUT_TYPE_TEXT);
 121     SWIG_CONSTANT2(int, INPUT_TYPE_NUMBER, CGUIEditControl::INPUT_TYPE_NUMBER);
 122     SWIG_CONSTANT2(int, INPUT_TYPE_DATE, CGUIEditControl::INPUT_TYPE_DATE);
 123     SWIG_CONSTANT2(int, INPUT_TYPE_TIME, CGUIEditControl::INPUT_TYPE_TIME);
 124     SWIG_CONSTANT2(int, INPUT_TYPE_IPADDRESS, CGUIEditControl::INPUT_TYPE_IPADDRESS);
 125     SWIG_CONSTANT2(int, INPUT_TYPE_PASSWORD, CGUIEditControl::INPUT_TYPE_PASSWORD);
 126     SWIG_CONSTANT2(int, INPUT_TYPE_PASSWORD_MD5, CGUIEditControl::INPUT_TYPE_PASSWORD_MD5);
 127     SWIG_CONSTANT2(int, INPUT_TYPE_SECONDS, CGUIEditControl::INPUT_TYPE_SECONDS);
 128     SWIG_CONSTANT2(int, INPUT_TYPE_PASSWORD_NUMBER_VERIFY_NEW, CGUIEditControl::INPUT_TYPE_PASSWORD_NUMBER_VERIFY_NEW);
 129
 130     SWIG_CONSTANT_FROM_GETTER(const char*, NOTIFICATION_INFO);
 131     SWIG_CONSTANT_FROM_GETTER(const char*, NOTIFICATION_WARNING);
 132     SWIG_CONSTANT_FROM_GETTER(const char*, NOTIFICATION_ERROR);
 133
 134     SWIG_CONSTANT(int, INPUT_ALPHANUM);
 135     SWIG_CONSTANT(int, INPUT_NUMERIC);
 136     SWIG_CONSTANT(int, INPUT_DATE);
 137     SWIG_CONSTANT(int, INPUT_TIME);
 138     SWIG_CONSTANT(int, INPUT_IPADDRESS);
 139     SWIG_CONSTANT(int, INPUT_PASSWORD);
 140
 141     SWIG_CONSTANT(int, HORIZONTAL);
 142     SWIG_CONSTANT(int, VERTICAL);
 143
 144     SWIG_CONSTANT(int, PASSWORD_VERIFY);
 145     SWIG_CONSTANT(int, ALPHANUM_HIDE_INPUT);
 146
 147   }
 148 }
 149 #endif /* DOXYGEN_SHOULD_SKIP_THIS */