blob: c281aff965484db7f8e5b8fbec461c1d7b8459db (
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
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
179
180
181
182
183
184
185
186
187
188
189
190
191
|
<?xml version="1.0" encoding="UTF-8" ?>
<!--
* These are some of the proposed functions for the document interface.
*
* It is only used in generating documentation.
*
* None of these methods are implemented. If someone does code one of
* these methods, remove it from here and add it to document-interface.xml.
*
* Authors:
* Soren Berg <Glimmer07@gmail.com>
*
* Copyright (C) 2009 Soren Berg
*
* Released under GNU GPL, read the file 'COPYING' for more information
-->
<node name="/org/inkscape/proposed"
xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd"
>
<interface name="org.inkscape.proposed">
<signal name="Signals_Proposal">
<doc:doc>
<doc:description>
<doc:para>Signals would undoubtedly be a useful thing to have in many circumstances. They are in proposed for two reasons: One, they complicate things for script writers and may conflict with the proposed C wrapper library. Two, I'm not sure how much coding it would take to implement them because I am familiar with neither Dbus signals or Inkscape events. Until I have done more experimenting I don't want to promise anything I'm not sure can be implemented in a timely fashion.</doc:para>
</doc:description>
</doc:doc>
</signal>
<signal name="ObjectResized">
<arg name="object_name" type="s">
<doc:doc>
<doc:summary>The id of the object.</doc:summary>
</doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>Emitted when an object has been resized.</doc:para>
</doc:description>
</doc:doc>
</signal>
<signal name="ObjectMoved">
<arg name="object_name" type="s">
<doc:doc>
<doc:summary>The id of the object.</doc:summary>
</doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>Emitted when an object has been moved.</doc:para>
</doc:description>
</doc:doc>
</signal>
<signal name="ObjectStyleModified">
<arg name="object_name" type="s">
<doc:doc>
<doc:summary>The id of the object.</doc:summary>
</doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>Emitted when the style of an object has been changed.</doc:para>
</doc:description>
</doc:doc>
</signal>
<signal name="ObjectCreated">
<arg name="object_name" type="s">
<doc:doc>
<doc:summary>The id of the object.</doc:summary>
</doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>Emitted when an object has been created. Possibly useful for working in conjunction with a live user.</doc:para>
</doc:description>
</doc:doc>
</signal>
<signal name="ObjectAddedToSelection">
<arg name="object_name" type="s">
<doc:doc>
<doc:summary>The id of the object.</doc:summary>
</doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>Emitted when an object has been added to the selection. Possibly useful for working in conjunction with a live user.</doc:para>
</doc:description>
</doc:doc>
</signal>
<method name="path_new" >
<arg type="d" name="x" direction="in" >
<doc:doc>
<doc:summary>The x value to begin the path.</doc:summary>
</doc:doc>
</arg>
<arg type="d" name="y" direction="in" >
<doc:doc>
<doc:summary>The y value to begin the path.</doc:summary>
</doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>Begins a new path, extra nodes can be added with path_append().</doc:para>
</doc:description>
</doc:doc>
</method>
<method name="path_append" >
<arg type="s" name="path" direction="in" >
<doc:doc>
<doc:summary>The name of the path to append to.</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="type" direction="in" >
<doc:doc>
<doc:summary>A single letter denoting what type of node is beeing appended.</doc:summary>
</doc:doc>
</arg>
<arg type="ad" name="arguments" direction="in" >
<doc:doc>
<doc:summary>An array of numbers that describe the position and attributes of the path node.</doc:summary>
</doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>Adds to an existing path. Close the path by sending "z" and no arguments.</doc:para>
<doc:para>You can no longer append to a path if it is closed.</doc:para>
</doc:description>
</doc:doc>
</method>
<!-- USE document-subset.h FILES -->
<method name="get_parent" >
<arg type="s" name="type" direction="in" >
<doc:doc>
<doc:summary>Any node with an "id" attribute.</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="parentid" direction="out" >
<annotation name="org.freedesktop.DBus.GLib.ReturnVal" value="error"/>
<doc:doc>
<doc:summary>The id of this nodes parent, NULL if toplevel.</doc:summary>
</doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>Returns the parent of any node. This function along with <doc:ref type="method" to="proposed.get_children">get_children()</doc:ref> can be used to navigate the XML tree. In proposed because I think it might confuse users who don't know about the SVG tree structure. In the main API I have de-emphasized nodes and required no knowledge of internal representation.</doc:para>
</doc:description>
</doc:doc>
</method>
<method name="get_children" >
<arg type="s" name="type" direction="in" >
<doc:doc>
<doc:summary>Any node with an "id" attribute.</doc:summary>
</doc:doc>
</arg>
<arg type="as" name="parentid" direction="out" >
<annotation name="org.freedesktop.DBus.GLib.ReturnVal" value="error"/>
<doc:doc>
<doc:summary>The ids of this nodes children, NULL if bottom level.</doc:summary>
</doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>Returns the children of any node. This function along with <doc:ref type="method" to="proposed.get_parent">get_parent()</doc:ref> can be used to navigate the XML tree. In proposed because I think it might confuse users who don't know about the SVG tree structure. In the main API I have de-emphasized nodes and required no knowledge of internal representation.</doc:para>
</doc:description>
</doc:doc>
</method>
<method name="selection_remove">
<arg type="s" name="name" direction="in" >
<doc:doc>
<doc:summary>A object to remove from the selection.</doc:summary>
</doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>Removes a single object from the selection. In proposed because I already have a ton of selection functions and am not sure people would need this.</doc:para>
</doc:description>
</doc:doc>
</method>
</interface>
</node>
|
