File: IAddonSupportCheck.h

package info (click to toggle)
kodi 2%3A21.2%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 143,076 kB
  • sloc: cpp: 694,471; xml: 52,618; ansic: 38,300; python: 7,161; sh: 4,289; javascript: 2,325; makefile: 1,791; perl: 969; java: 513; cs: 390; objc: 340
file content (46 lines) | stat: -rw-r--r-- 1,182 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
/*
 *  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 <string>

namespace KODI
{
namespace ADDONS
{

/*!
 * @brief Parent class to ask addons for support.
 *
 * This one can be used as a parent on the respective Kodi-sided addon class,
 * this makes it easier to query for the desired support without using the
 * class's own function definition.
 */
class IAddonSupportCheck
{
public:
  IAddonSupportCheck() = default;
  virtual ~IAddonSupportCheck() = default;

  /*!
   * @brief Function to query the respective add-ons used for the support of
   * the desired file.
   *
   * @param[in] filename File which is queried for addon support
   * @return True if addon supports the desired file, false if not
   *
   * @note Is set here with true as default and not with "= 0" in order to have
   * class expandable and perhaps to be able to insert other query functions in
   * the future.
   */
  virtual bool SupportsFile(const std::string& filename) { return true; }
};

} /* namespace ADDONS */
} /* namespace KODI */