summaryrefslogtreecommitdiffstats
path: root/xbmc/addons/ContextItemAddon.h
blob: 628fdcd9ceeb0adfbacbaed35f48e697ee2cf60f (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
#pragma once
/*
 *      Copyright (C) 2013-2015 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/>.
 *
 */

#include <list>
#include <memory>
#include "Addon.h"

class CFileItem;
typedef std::shared_ptr<CFileItem> CFileItemPtr;

namespace INFO
{
  class InfoBool;
  typedef std::shared_ptr<InfoBool> InfoPtr;
}

namespace ADDON
{
  class CContextItemAddon : public CAddon
  {
  public:
    CContextItemAddon(const cp_extension_t *ext);
    CContextItemAddon(const AddonProps &props);
    virtual ~CContextItemAddon();

    const std::string& GetLabel() const { return m_label; }

    /*!
     * \brief Get the parent category of this context item.
     *
     * \details Returns empty string if at root level or
     * CONTEXT_MENU_GROUP_MANAGE when it should be in the 'manage' submenu.
     */
    const std::string& GetParent() const { return m_parent; }

    /*!
     * \brief Returns true if this contex menu should be visible for given item.
     */
    bool IsVisible(const CFileItemPtr& item) const;

    virtual bool OnPreInstall();
    virtual void OnPostInstall(bool restart, bool update);
    virtual void OnPreUnInstall();
    virtual void OnDisabled();
    virtual void OnEnabled();

  private:
    std::string m_label;
    std::string m_parent;
    INFO::InfoPtr m_visCondition;
  };

  typedef std::shared_ptr<CContextItemAddon> ContextItemAddonPtr;
}