summaryrefslogtreecommitdiffstats
path: root/xbmc/interfaces/legacy/ModuleXbmcgui.h
blob: d2d955862051eff9beff23201b891a76c77389e4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
/*
 *  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 "guilib/GUIEditControl.h"
#include "swighelper.h"

#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace XBMCAddon
{
  namespace xbmcgui
  {
#endif /* DOXYGEN_SHOULD_SKIP_THIS */

    //
    /// \defgroup python_xbmcgui Library - xbmcgui
    /// @{
    /// @brief **GUI functions on Kodi.**
    ///
    /// Offers classes and functions that manipulate the Graphical User
    /// Interface through windows, dialogs, and various control widgets.
    //

#ifdef DOXYGEN_SHOULD_USE_THIS
    ///
    /// \ingroup python_xbmcgui
    /// @brief \python_func{ xbmcgui.getCurrentWindowId() }
    /// Returns the id for the current 'active' window as an integer.
    ///
    /// @return                        The currently active window Id
    ///
    ///
    ///--------------------------------------------------------------------------
    ///
    /// **Example:**
    /// ~~~~~~~~~~~~~{.py}
    /// ..
    /// wid = xbmcgui.getCurrentWindowId()
    /// ..
    /// ~~~~~~~~~~~~~
    ///
    getCurrentWindowId();
#else
    long getCurrentWindowId();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
    ///
    /// \ingroup python_xbmcgui
    /// @brief \python_func{ xbmcgui.getCurrentWindowDialogId() }
    /// Returns the id for the current 'active' dialog as an integer.
    ///
    /// @return                        The currently active dialog Id
    ///
    ///
    ///--------------------------------------------------------------------------
    ///
    /// **Example:**
    /// ~~~~~~~~~~~~~{.py}
    /// ..
    /// wid = xbmcgui.getCurrentWindowDialogId()
    /// ..
    /// ~~~~~~~~~~~~~
    ///
    getCurrentWindowDialogId();
#else
    long getCurrentWindowDialogId();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
    ///
    /// \ingroup python_xbmcgui
    /// @brief \python_func{ getScreenHeight() }
    /// Returns the height of this screen.
    ///
    /// @return                       Screen height
    ///
    ///
    ///-------------------------------------------------------------------------
    /// @python_v18 New function added.
    ///
    getScreenHeight();
#else
    long getScreenHeight();
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
    ///
    /// \ingroup python_xbmcgui
    /// @brief \python_func{ getScreenWidth() }
    /// Returns the width of this screen.
    ///
    /// @return                       Screen width
    ///
    ///
    ///-------------------------------------------------------------------------
    /// @python_v18 New function added.
    ///
    getScreenWidth();
#else
    long getScreenWidth();
#endif
    ///@}

#ifndef DOXYGEN_SHOULD_SKIP_THIS
    SWIG_CONSTANT2(int, ICON_OVERLAY_NONE, CGUIListItem::ICON_OVERLAY_NONE);
    SWIG_CONSTANT2(int, ICON_OVERLAY_RAR, CGUIListItem::ICON_OVERLAY_RAR);
    SWIG_CONSTANT2(int, ICON_OVERLAY_ZIP, CGUIListItem::ICON_OVERLAY_ZIP);
    SWIG_CONSTANT2(int, ICON_OVERLAY_LOCKED, CGUIListItem::ICON_OVERLAY_LOCKED);
    SWIG_CONSTANT2(int, ICON_OVERLAY_UNWATCHED, CGUIListItem::ICON_OVERLAY_UNWATCHED);
    SWIG_CONSTANT2(int, ICON_OVERLAY_WATCHED, CGUIListItem::ICON_OVERLAY_WATCHED);
    SWIG_CONSTANT2(int, ICON_OVERLAY_HD, CGUIListItem::ICON_OVERLAY_HD);

    SWIG_CONSTANT2(int, INPUT_TYPE_TEXT, CGUIEditControl::INPUT_TYPE_TEXT);
    SWIG_CONSTANT2(int, INPUT_TYPE_NUMBER, CGUIEditControl::INPUT_TYPE_NUMBER);
    SWIG_CONSTANT2(int, INPUT_TYPE_DATE, CGUIEditControl::INPUT_TYPE_DATE);
    SWIG_CONSTANT2(int, INPUT_TYPE_TIME, CGUIEditControl::INPUT_TYPE_TIME);
    SWIG_CONSTANT2(int, INPUT_TYPE_IPADDRESS, CGUIEditControl::INPUT_TYPE_IPADDRESS);
    SWIG_CONSTANT2(int, INPUT_TYPE_PASSWORD, CGUIEditControl::INPUT_TYPE_PASSWORD);
    SWIG_CONSTANT2(int, INPUT_TYPE_PASSWORD_MD5, CGUIEditControl::INPUT_TYPE_PASSWORD_MD5);
    SWIG_CONSTANT2(int, INPUT_TYPE_SECONDS, CGUIEditControl::INPUT_TYPE_SECONDS);
    SWIG_CONSTANT2(int, INPUT_TYPE_PASSWORD_NUMBER_VERIFY_NEW, CGUIEditControl::INPUT_TYPE_PASSWORD_NUMBER_VERIFY_NEW);

    SWIG_CONSTANT_FROM_GETTER(const char*, NOTIFICATION_INFO);
    SWIG_CONSTANT_FROM_GETTER(const char*, NOTIFICATION_WARNING);
    SWIG_CONSTANT_FROM_GETTER(const char*, NOTIFICATION_ERROR);

    SWIG_CONSTANT(int, INPUT_ALPHANUM);
    SWIG_CONSTANT(int, INPUT_NUMERIC);
    SWIG_CONSTANT(int, INPUT_DATE);
    SWIG_CONSTANT(int, INPUT_TIME);
    SWIG_CONSTANT(int, INPUT_IPADDRESS);
    SWIG_CONSTANT(int, INPUT_PASSWORD);

    SWIG_CONSTANT(int, HORIZONTAL);
    SWIG_CONSTANT(int, VERTICAL);

    SWIG_CONSTANT(int, PASSWORD_VERIFY);
    SWIG_CONSTANT(int, ALPHANUM_HIDE_INPUT);

  }
}
#endif /* DOXYGEN_SHOULD_SKIP_THIS */