xbmc
ModuleXbmcplugin.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 "AddonString.h"
12 #include "ListItem.h"
13 #include "Tuple.h"
14 #include "swighelper.h"
15 
16 #include <vector>
17 
18 #ifndef DOXYGEN_SHOULD_SKIP_THIS
19 namespace XBMCAddon
20 {
21  namespace xbmcplugin
22  {
23 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
24 
25  //
34  //
35 
36 #ifdef DOXYGEN_SHOULD_USE_THIS
37  addDirectoryItem(...);
68 #else
69  bool addDirectoryItem(int handle, const String& url, const XBMCAddon::xbmcgui::ListItem* listitem,
70  bool isFolder = false, int totalItems = 0);
71 #endif
72 
73 #ifdef DOXYGEN_SHOULD_USE_THIS
74  addDirectoryItems(...);
101 #else
102  bool addDirectoryItems(int handle,
103  const std::vector<Tuple<String,const XBMCAddon::xbmcgui::ListItem*,bool> >& items,
104  int totalItems = 0);
105 #endif
106 
107 #ifdef DOXYGEN_SHOULD_USE_THIS
108  endOfDirectory(...);
136 #else
137  void endOfDirectory(int handle, bool succeeded = true, bool updateListing = false,
138  bool cacheToDisc = true);
139 #endif
140 
141 #ifdef DOXYGEN_SHOULD_USE_THIS
142  setResolvedUrl(...);
166 #else
167  void setResolvedUrl(int handle, bool succeeded, const XBMCAddon::xbmcgui::ListItem* listitem);
168 #endif
169 
170 #ifdef DOXYGEN_SHOULD_USE_THIS
171  addSortMethod(...);
265 #else
266  void addSortMethod(int handle, int sortMethod, const String& labelMask = emptyString, const String& label2Mask = emptyString);
267 #endif
268 
269 #ifdef DOXYGEN_SHOULD_USE_THIS
270  getSetting(...);
294 #else
295  String getSetting(int handle, const char* id);
296 #endif
297 
298 #ifdef DOXYGEN_SHOULD_USE_THIS
299  setSetting(...);
319 #else
320  void setSetting(int handle, const String& id, const String& value);
321 #endif
322 
323 #ifdef DOXYGEN_SHOULD_USE_THIS
324  setContent(...);
355 #else
356  void setContent(int handle, const char* content);
357 #endif
358 
359 #ifdef DOXYGEN_SHOULD_USE_THIS
360  setPluginCategory(...);
379 #else
380  void setPluginCategory(int handle, const String& category);
381 #endif
382 
383 #ifdef DOXYGEN_SHOULD_USE_THIS
384  setPluginFanart(...);
406 #else
407  void setPluginFanart(int handle, const char* image = NULL,
408  const char* color1 = NULL,
409  const char* color2 = NULL,
410  const char* color3 = NULL);
411 #endif
412 
413 #ifdef DOXYGEN_SHOULD_USE_THIS
414  setProperty(...);
437 #else
438  void setProperty(int handle, const char* key, const String& value);
439 #endif
440 
441 #ifndef DOXYGEN_SHOULD_SKIP_THIS
442  SWIG_CONSTANT(int, SORT_METHOD_NONE);
443  SWIG_CONSTANT(int, SORT_METHOD_LABEL);
444  SWIG_CONSTANT(int, SORT_METHOD_LABEL_IGNORE_THE);
445  SWIG_CONSTANT(int, SORT_METHOD_DATE);
446  SWIG_CONSTANT(int, SORT_METHOD_SIZE);
447  SWIG_CONSTANT(int, SORT_METHOD_FILE);
448  SWIG_CONSTANT(int, SORT_METHOD_DRIVE_TYPE);
449  SWIG_CONSTANT(int, SORT_METHOD_TRACKNUM);
450  SWIG_CONSTANT(int, SORT_METHOD_DURATION);
451  SWIG_CONSTANT(int, SORT_METHOD_TITLE);
452  SWIG_CONSTANT(int, SORT_METHOD_TITLE_IGNORE_THE);
453  SWIG_CONSTANT(int, SORT_METHOD_ARTIST);
454  SWIG_CONSTANT(int, SORT_METHOD_ARTIST_IGNORE_THE);
455  SWIG_CONSTANT(int, SORT_METHOD_ALBUM);
456  SWIG_CONSTANT(int, SORT_METHOD_ALBUM_IGNORE_THE);
457  SWIG_CONSTANT(int, SORT_METHOD_GENRE);
458  SWIG_CONSTANT2(int, SORT_METHOD_VIDEO_YEAR,SORT_METHOD_YEAR);
459  SWIG_CONSTANT(int, SORT_METHOD_VIDEO_RATING);
460  SWIG_CONSTANT(int, SORT_METHOD_PROGRAM_COUNT);
461  SWIG_CONSTANT(int, SORT_METHOD_PLAYLIST_ORDER);
462  SWIG_CONSTANT(int, SORT_METHOD_EPISODE);
463  SWIG_CONSTANT(int, SORT_METHOD_VIDEO_TITLE);
464  SWIG_CONSTANT(int, SORT_METHOD_VIDEO_SORT_TITLE);
465  SWIG_CONSTANT(int, SORT_METHOD_VIDEO_SORT_TITLE_IGNORE_THE);
466  SWIG_CONSTANT(int, SORT_METHOD_VIDEO_ORIGINAL_TITLE);
467  SWIG_CONSTANT(int, SORT_METHOD_VIDEO_ORIGINAL_TITLE_IGNORE_THE);
468  SWIG_CONSTANT(int, SORT_METHOD_PRODUCTIONCODE);
469  SWIG_CONSTANT(int, SORT_METHOD_SONG_RATING);
470  SWIG_CONSTANT(int, SORT_METHOD_MPAA_RATING);
471  SWIG_CONSTANT(int, SORT_METHOD_VIDEO_RUNTIME);
472  SWIG_CONSTANT(int, SORT_METHOD_STUDIO);
473  SWIG_CONSTANT(int, SORT_METHOD_STUDIO_IGNORE_THE);
474  SWIG_CONSTANT(int, SORT_METHOD_UNSORTED);
475  SWIG_CONSTANT(int, SORT_METHOD_BITRATE);
476  SWIG_CONSTANT(int, SORT_METHOD_LISTENERS);
477  SWIG_CONSTANT(int, SORT_METHOD_COUNTRY);
478  SWIG_CONSTANT(int, SORT_METHOD_DATEADDED);
479  SWIG_CONSTANT(int, SORT_METHOD_FULLPATH);
480  SWIG_CONSTANT(int, SORT_METHOD_LABEL_IGNORE_FOLDERS);
481  SWIG_CONSTANT(int, SORT_METHOD_LASTPLAYED);
482  SWIG_CONSTANT(int, SORT_METHOD_PLAYCOUNT);
483  SWIG_CONSTANT(int, SORT_METHOD_CHANNEL);
484  SWIG_CONSTANT(int, SORT_METHOD_DATE_TAKEN);
485  SWIG_CONSTANT(int, SORT_METHOD_VIDEO_USER_RATING);
486  SWIG_CONSTANT(int, SORT_METHOD_SONG_USER_RATING);
487  }
488 }
489 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
Defining LOG_LIFECYCLE_EVENTS will log all instantiations, deletions and also reference countings (in...
Definition: Addon.cpp:25
Definition: ListItem.h:52