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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
#ifndef __INKSCAPE_IDL__
#define __INKSCAPE_IDL__
/**
* Inkscape API Description
*
* This is a place where people can discuss and modify their ideas
* of what an Inkscape exported API should look like.
*
* This IDL file should be considered to be somewhat of a Wish List,
* and people should feel free to add their ideas to it.
*
* Authors:
* Inkscape members
*
* Copyright (C) 2007 Inkscape.org
*
* This library 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 2.1 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
module inkscape
{
module api
{
/**
* This will actually be defined as a Glib::ustring
* but people should use the word 'String'
*/
valuetype String sequence<unsigned short>;
/**
* Forward declarations
*/
interface Env;
interface Application;
interface Document;
interface Desktop;
interface DialogManager;
exception Exception {
unsigned short code;
};
/**
* ExceptionCodes
* These muse be constants, since languages handle enums
* differently.
*/
const unsigned short INKER = 1;
const unsigned short INKERR_NOT_FOUND = 2;
const unsigned short INKERR_NOT_SUPPORTED = 3;
/**
* This is the top-level root of all Inkscape interfaces.
* It is the single point of contact from which all other
* interfaces can be accessed. Anything top-level or
* global should be parented here.
*
* This allows an entire set of interfaces to be exported
* to a shared object with only a single symbol. This symbol
* can be accessed something like:
*
* typedef (Env *)(EnvCreateFunc)();
* EnvCreateFunc createEnvironment =
* (EnvCreateFunc) dlsym("createEnvironment");
* Env *ink = createEnvironment();
*
*
* This allows shared object linking to be much easier, and
* allows binding to other languages to be performed however
* is best for each.
*
*/
interface Env {
/**
* This is the main application, which
*/
Application *getApplication();
};
/**
*
* Top-level Inkscape application
*
*/
interface Application {
/**
* Return the currently-focused desktop
*/
Desktop *getActiveDesktop();
/**
* Return the document in the currently-focused desktop
*/
Document *getActiveDocument();
};
/**
*
* This is a main editing window, with all of its chrome.
*
*/
interface Desktop {
/**
* Return the dialog manager for this desktop
*/
DialogManager *getDialogManager();
};
/**
* An Inkscape Document, which is SPObject + XML
*
*/
interface Document {
/**
* Copy the document's XML into a DOM tree and
* return a pointer to it.
*/
org::w3c::dom::Document *getDOM();
/**
* Set the Document's repr tree to the specified
* DOM document
*/
bool setDOM(org::w3c::dom::Document *doc);
};
/**
* The interface that controls Inkscape's dialogs
*
*/
interface DialogManager {
/**
*
*/
//some method
};
}; // module api
}; // module inkscape
#endif // __INKSCAPE_IDL__
|
