1 <?xml version="1.0" encoding="UTF-8" ?>
2 <!--
3 * These are some of the proposed functions for the document interface.
4 *
5 * It is only used in generating documentation.
6 *
7 * None of these methods are implemented. If someone does code one of
8 * these methods, remove it from here and add it to document-interface.xml.
9 *
10 * Authors:
11 * Soren Berg <Glimmer07@gmail.com>
12 *
13 * Copyright (C) 2009 Soren Berg
14 *
15 * Released under GNU GPL, read the file 'COPYING' for more information
16 -->
17 <node name="/org/inkscape/proposed"
18 xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd"
19 >
20 <interface name="org.inkscape.proposed">
22 <signal name="Signals_Proposal">
23 <doc:doc>
24 <doc:description>
25 <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>
26 </doc:description>
27 </doc:doc>
28 </signal>
30 <signal name="ObjectResized">
31 <arg name="object_name" type="s">
32 <doc:doc>
33 <doc:summary>The id of the object.</doc:summary>
34 </doc:doc>
35 </arg>
36 <doc:doc>
37 <doc:description>
38 <doc:para>Emitted when an object has been resized.</doc:para>
39 </doc:description>
40 </doc:doc>
41 </signal>
43 <signal name="ObjectMoved">
44 <arg name="object_name" type="s">
45 <doc:doc>
46 <doc:summary>The id of the object.</doc:summary>
47 </doc:doc>
48 </arg>
49 <doc:doc>
50 <doc:description>
51 <doc:para>Emitted when an object has been moved.</doc:para>
52 </doc:description>
53 </doc:doc>
54 </signal>
56 <signal name="ObjectStyleModified">
57 <arg name="object_name" type="s">
58 <doc:doc>
59 <doc:summary>The id of the object.</doc:summary>
60 </doc:doc>
61 </arg>
62 <doc:doc>
63 <doc:description>
64 <doc:para>Emitted when the style of an object has been changed.</doc:para>
65 </doc:description>
66 </doc:doc>
67 </signal>
69 <signal name="ObjectCreated">
70 <arg name="object_name" type="s">
71 <doc:doc>
72 <doc:summary>The id of the object.</doc:summary>
73 </doc:doc>
74 </arg>
75 <doc:doc>
76 <doc:description>
77 <doc:para>Emitted when an object has been created. Possibly useful for working in conjunction with a live user.</doc:para>
78 </doc:description>
79 </doc:doc>
80 </signal>
82 <signal name="ObjectAddedToSelection">
83 <arg name="object_name" type="s">
84 <doc:doc>
85 <doc:summary>The id of the object.</doc:summary>
86 </doc:doc>
87 </arg>
88 <doc:doc>
89 <doc:description>
90 <doc:para>Emitted when an object has been added to the selection. Possibly useful for working in conjunction with a live user.</doc:para>
91 </doc:description>
92 </doc:doc>
93 </signal>
95 <method name="path_new" >
96 <arg type="d" name="x" direction="in" >
97 <doc:doc>
98 <doc:summary>The x value to begin the path.</doc:summary>
99 </doc:doc>
100 </arg>
101 <arg type="d" name="y" direction="in" >
102 <doc:doc>
103 <doc:summary>The y value to begin the path.</doc:summary>
104 </doc:doc>
105 </arg>
106 <doc:doc>
107 <doc:description>
108 <doc:para>Begins a new path, extra nodes can be added with path_append().</doc:para>
109 </doc:description>
110 </doc:doc>
111 </method>
113 <method name="path_append" >
114 <arg type="s" name="path" direction="in" >
115 <doc:doc>
116 <doc:summary>The name of the path to append to.</doc:summary>
117 </doc:doc>
118 </arg>
119 <arg type="s" name="type" direction="in" >
120 <doc:doc>
121 <doc:summary>A single letter denoting what type of node is beeing appended.</doc:summary>
122 </doc:doc>
123 </arg>
124 <arg type="ad" name="arguments" direction="in" >
125 <doc:doc>
126 <doc:summary>An array of numbers that describe the position and attributes of the path node.</doc:summary>
127 </doc:doc>
128 </arg>
129 <doc:doc>
130 <doc:description>
131 <doc:para>Adds to an existing path. Close the path by sending "z" and no arguments.</doc:para>
132 <doc:para>You can no longer append to a path if it is closed.</doc:para>
133 </doc:description>
134 </doc:doc>
135 </method>
138 <!-- USE document-subset.h FILES -->
139 <method name="get_parent" >
140 <arg type="s" name="type" direction="in" >
141 <doc:doc>
142 <doc:summary>Any node with an "id" attribute.</doc:summary>
143 </doc:doc>
144 </arg>
145 <arg type="s" name="parentid" direction="out" >
146 <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value="error"/>
147 <doc:doc>
148 <doc:summary>The id of this nodes parent, NULL if toplevel.</doc:summary>
149 </doc:doc>
150 </arg>
151 <doc:doc>
152 <doc:description>
153 <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>
154 </doc:description>
155 </doc:doc>
156 </method>
158 <method name="get_children" >
159 <arg type="s" name="type" direction="in" >
160 <doc:doc>
161 <doc:summary>Any node with an "id" attribute.</doc:summary>
162 </doc:doc>
163 </arg>
164 <arg type="as" name="parentid" direction="out" >
165 <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value="error"/>
166 <doc:doc>
167 <doc:summary>The ids of this nodes children, NULL if bottom level.</doc:summary>
168 </doc:doc>
169 </arg>
170 <doc:doc>
171 <doc:description>
172 <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>
173 </doc:description>
174 </doc:doc>
175 </method>
177 <method name="selection_remove">
178 <arg type="s" name="name" direction="in" >
179 <doc:doc>
180 <doc:summary>A object to remove from the selection.</doc:summary>
181 </doc:doc>
182 </arg>
183 <doc:doc>
184 <doc:description>
185 <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>
186 </doc:description>
187 </doc:doc>
188 </method>
190 </interface>
191 </node>