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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
/*
* Copyright (C) 2005-2013 Team XBMC
* http://xbmc.org
*
* 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 XBMC; see the file COPYING. If not, see
* <http://www.gnu.org/licenses/>.
*
*/
#pragma once
#include "addons/IAddon.h"
#include "AddonString.h"
#include "AddonClass.h"
#include "Exception.h"
namespace XBMCAddon
{
namespace xbmcaddon
{
XBMCCOMMONS_STANDARD_EXCEPTION(AddonException);
///
/// \addtogroup python_xbmcaddon
/// @{
/// @brief **Kodi's addon class.**
///
/// Offers classes and functions that manipulate the add-on settings,
/// information and localization.
///
///-------------------------------------------------------------------------
///
/// \python_class{ xbmcaddon.Addon([id]) }
///
/// Creates a new AddOn class.
///
/// @param id [opt] string - id of the addon as
/// specified in [addon.xml](http://kodi.wiki/view/Addon.xml)
///
/// @note Specifying the addon id is not needed.\n
/// Important however is that the addon folder has the same name as the AddOn
/// id provided in [addon.xml](http://kodi.wiki/view/Addon.xml).\n
/// You can optionally specify the addon id from another installed addon to
/// retrieve settings from it.
///
///
///-------------------------------------------------------------------------
/// @python_v13
/// **id** is optional as it will be auto detected for this add-on instance.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// self.Addon = xbmcaddon.Addon()
/// self.Addon = xbmcaddon.Addon('script.foo.bar')
/// ..
/// ~~~~~~~~~~~~~
///
class Addon : public AddonClass
{
ADDON::AddonPtr pAddon;
String getDefaultId();
String getAddonVersion();
public:
Addon(const char* id = NULL);
virtual ~Addon();
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcaddon
/// @brief \python_func{ xbmcaddon.Addon([id]).getLocalizedString(id) }
///-----------------------------------------------------------------------
/// Returns an addon's localized 'unicode string'.
///
/// @param id integer - id# for string you want to
/// localize.
/// @return Localized 'unicode string'
///
///
///-----------------------------------------------------------------------
/// @python_v13
/// **id** is optional as it will be auto detected for this add-on instance.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// locstr = self.Addon.getLocalizedString(32000)
/// ..
/// ~~~~~~~~~~~~~
///
getLocalizedString(...);
#else
String getLocalizedString(int id);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcaddon
/// @brief \python_func{ xbmcaddon.Addon([id]).getSetting(id) }
///-----------------------------------------------------------------------
/// Returns the value of a setting as a unicode string.
///
/// @param id string - id of the setting that the module
/// needs to access.
/// @return Setting as a unicode string
///
///
///-----------------------------------------------------------------------
/// @python_v13
/// **id** is optional as it will be auto detected for this add-on instance.
///
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// apikey = self.Addon.getSetting('apikey')
/// ..
/// ~~~~~~~~~~~~~
///
getSetting(...);
#else
String getSetting(const char* id);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcaddon
/// @brief \python_func{ xbmcaddon.Addon([id]).setSetting(id, value) }
///-----------------------------------------------------------------------
/// Sets a script setting.
///
/// @param id string - id of the setting that the module needs to access.
/// @param value string or unicode - value of the setting.
///
///
/// @note You can use the above as keywords for arguments.
///
///
///-----------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// self.Addon.setSetting(id='username', value='teamkodi')
/// ..
/// ~~~~~~~~~~~~~
///
setSetting(...);
#else
void setSetting(const char* id, const String& value);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcaddon
/// @brief \python_func{ xbmcaddon.Addon([id]).openSettings() }
///-----------------------------------------------------------------------
/// Opens this scripts settings dialog.
///
///-----------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// self.Addon.openSettings()
/// ..
/// ~~~~~~~~~~~~~
///
openSettings();
#else
void openSettings();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_xbmcaddon
/// \anchor python_xbmcaddon_Addon
/// @brief \python_func{ xbmcaddon.Addon([id]).getAddonInfo(id) }
///-----------------------------------------------------------------------
/// Returns the value of an addon property as a string.
///
/// @param id string - id of the property that the
/// module needs to access.
/// @par Choices for the property are
/// | | | | |
/// |:-----------:|:-----------:|:-----------:|:-----------:|
/// | author | changelog | description | disclaimer |
/// | fanart | icon | id | name |
/// | path | profile | stars | summary |
/// | type | version | | |
/// @return AddOn property as a string
///
///
///
///-----------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// version = self.Addon.getAddonInfo('version')
/// ..
/// ~~~~~~~~~~~~~
///
getAddonInfo(...);
#else
String getAddonInfo(const char* id);
#endif
};
//@}
}
}
|
