File: FileBrowser.h

package info (click to toggle)
kodi 2%3A20.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 143,820 kB
  • sloc: cpp: 664,925; xml: 68,398; ansic: 37,223; python: 6,903; sh: 4,209; javascript: 2,325; makefile: 1,754; perl: 969; java: 513; cs: 390; objc: 340
file content (116 lines) | stat: -rw-r--r-- 4,370 bytes parent folder | download | duplicates (3)
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
/*
 *  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 "addons/kodi-dev-kit/include/kodi/c-api/gui/dialogs/filebrowser.h"

#include <string>
#include <vector>

class CMediaSource;

typedef std::vector<CMediaSource> VECSOURCES;

extern "C"
{

  struct AddonGlobalInterface;

  namespace ADDON
  {

  /*!
   * @brief Global gui Add-on to Kodi callback functions
   *
   * To hold functions not related to a instance type and usable for
   * every add-on type.
   *
   * Related add-on header is "./xbmc/addons/kodi-dev-kit/include/kodi/gui/dialogs/FileBrowser.h"
   */
  struct Interface_GUIDialogFileBrowser
  {
    static void Init(AddonGlobalInterface* addonInterface);
    static void DeInit(AddonGlobalInterface* addonInterface);

    /*!
     * @brief callback functions from add-on to kodi
     *
     * @note To add a new function use the "_" style to directly identify an
     * add-on callback function. Everything with CamelCase is only to be used
     * in Kodi.
     *
     * The parameter `kodiBase` is used to become the pointer for a `CAddonDll`
     * class.
     */
    //@{
    static bool show_and_get_directory(KODI_HANDLE kodiBase,
                                       const char* shares,
                                       const char* heading,
                                       const char* path_in,
                                       char** path_out,
                                       bool write_only);

    static bool show_and_get_file(KODI_HANDLE kodiBase,
                                  const char* shares,
                                  const char* mask,
                                  const char* heading,
                                  const char* path_in,
                                  char** path_out,
                                  bool use_thumbs,
                                  bool use_file_directories);

    static bool show_and_get_file_from_dir(KODI_HANDLE kodiBase,
                                           const char* directory,
                                           const char* mask,
                                           const char* heading,
                                           const char* path_in,
                                           char** path_out,
                                           bool use_thumbs,
                                           bool use_file_directories,
                                           bool singleList);

    static bool show_and_get_file_list(KODI_HANDLE kodiBase,
                                       const char* shares,
                                       const char* mask,
                                       const char* heading,
                                       char*** file_list,
                                       unsigned int* entries,
                                       bool use_thumbs,
                                       bool use_file_directories);

    static bool show_and_get_source(KODI_HANDLE kodiBase,
                                    const char* path_in,
                                    char** path_out,
                                    bool allow_network_shares,
                                    const char* additional_share,
                                    const char* type);

    static bool show_and_get_image(KODI_HANDLE kodiBase,
                                   const char* shares,
                                   const char* heading,
                                   const char* path_in,
                                   char** path_out);

    static bool show_and_get_image_list(KODI_HANDLE kodiBase,
                                        const char* shares,
                                        const char* heading,
                                        char*** file_list,
                                        unsigned int* entries);

    static void clear_file_list(KODI_HANDLE kodiBase, char*** file_list, unsigned int entries);
    //@}

  private:
    static void GetVECShares(VECSOURCES& vecShares,
                             const std::string& strShares,
                             const std::string& strPath);
  };

  } /* namespace ADDON */
} /* extern "C" */