summaryrefslogtreecommitdiff
path: root/kpimutils/supertrait.h
blob: 13bacc4b15579a1b7b1440025ae5be0cb1e6083c (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
/*
    Copyright (c) 2009 Volker Krause <vkrause@kde.org>

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public License as published by
    the Free Software Foundation; either version 2 of the License, or (at your
    option) any later version.

    This library 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 Library General Public
    License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to the
    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301, USA.
*/

#ifndef KPIMUTILS_SUPERTRAIT_H
#define KPIMUTILS_SUPERTRAIT_H

namespace KPIMUtils
{
  /**
    @internal
    @see super_class
  */
  template <typename Super>
  struct SuperClassTrait
  {
    typedef Super Type;
  };

  /**
    Type trait to provide information about a base class for a given class.
    Used eg. for the Akonadi payload mechanism.

    To provide base class introspection for own types, extend this trait as follows:
    @code
    namespace KPIMUtils
    {
      template <> struct SuperClass<MyClass> : public SuperClassTrait<MyBaseClass>{};
    }
    @endcode
  */
  template <typename Class> struct SuperClass : public SuperClassTrait<Class>{};
}

#endif