File: Plugin.sip

package info (click to toggle)
tulip 4.8.0dfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 179,264 kB
  • ctags: 64,517
  • sloc: cpp: 600,444; ansic: 36,311; makefile: 22,136; python: 1,304; sh: 946; yacc: 522; xml: 337; pascal: 157; php: 66; lex: 55
file content (142 lines) | stat: -rw-r--r-- 2,996 bytes parent folder | download | duplicates (2)
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/**
 *
 * This file is part of Tulip (www.tulip-software.org)
 *
 * Authors: David Auber and the Tulip development Team
 * from LaBRI, University of Bordeaux 1 and Inria Bordeaux - Sud Ouest
 *
 * Tulip is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * Tulip 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.
 *
 */

// +-------------------------------------------------------------------------+
// | Tulip Python Bindings                                                   |
// | inspired from bindings by the Booggie project development team          |
// | (http://booggie.org/)                                                   |
// +-------------------------------------------------------------------------+

namespace tlp {
class Plugin : tlp::WithParameter, tlp::WithDependency {
%TypeHeaderCode
#include <tulip/Plugin.h>
%End

%Docstring
Bases: :class:`tlp.WithParameter`

This is the base class for all Tulip plugins.
%End

public:
        virtual ~Plugin();

        virtual std::string category() const=0;
%Docstring
tlp.Plugin.category()

Returns the category of the plugin.

:rtype: string
%End

        virtual std::string name() const=0;
%Docstring
tlp.Plugin.name()

Returns the name of the plugin.

:rtype: string
%End

        virtual std::string group() const=0;
%Docstring
tlp.Plugin.group()

Returns the group of the plugin.

:rtype: string
%End
        virtual std::string author() const=0;
%Docstring
tlp.Plugin.author()

Returns the author of the plugin.

:rtype: string
%End

        virtual std::string date() const=0;
%Docstring
tlp.Plugin.category()

Returns the creation date of the plugin.

:rtype: string
%End

        virtual std::string info() const=0;
%Docstring
tlp.Plugin.category()

Returns some information about the plugin.

:rtype: string
%End

        virtual std::string release() const=0;
%Docstring
tlp.Plugin.category()

Returns the release number of the plugin.

:rtype: string
%End

        virtual std::string tulipRelease() const=0;
%Docstring
tlp.Plugin.category()

Returns the Tulip release number.

:rtype: string
%End

        virtual std::string major() const;

        virtual std::string minor() const;

        virtual std::string tulipMajor() const;

        virtual std::string tulipMinor() const;

        virtual int id() const;

        virtual std::string programmingLanguage() const;


};

class FactoryInterface {
%TypeHeaderCode
#include <tulip/Plugin.h>
%End
public:

  virtual tlp::Plugin* createPluginObject(tlp::PluginContext* context) = 0 /Factory/;

  void registerPlugin();
%MethodCode
    tlp::PluginLister::registerPlugin(sipCpp);
%End

};

};