Added proposed interface file.

Fixed other xml files to have xml file declaration before comments.

diff --git a/src/extension/dbus/application-interface.xml b/src/extension/dbus/application-interface.xml
index e942117d634759fd84f21c2c1df1580308505557..ee2c4837bf2244525664bbd1d65ac9f7b3ec1af0 100644 (file)
--- a/src/extension/dbus/application-interface.xml
+++ b/src/extension/dbus/application-interface.xml
@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="UTF-8" ?>
 <!--
  * This is the master description of the DBus application interface.
  * The interface is mostly just for creating new document instances.
@@ -16,8 +17,6 @@
  *
  * Released under GNU GPL, read the file 'COPYING' for more information
 -->
-
-<?xml version="1.0" encoding="UTF-8" ?>
 <node name="/org/inkscape/application"
   xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd"
 >

diff --git a/src/extension/dbus/document-interface.xml b/src/extension/dbus/document-interface.xml
index 2f154948827aaf01d016e80b29a29ab694fd0263..8b0252765f197f4f153d941c087daa164cbd5f1e 100644 (file)
--- a/src/extension/dbus/document-interface.xml
+++ b/src/extension/dbus/document-interface.xml
@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="UTF-8" ?>
 <!--
  * This is the master description of the DBus document interface.
  *
@@ -16,7 +17,7 @@
  * Released under GNU GPL, read the file 'COPYING' for more information
 -->
  
-<?xml version="1.0" encoding="UTF-8" ?>
+ 
 <node name="/org/inkscape/document"
   xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd"
 >

diff --git a/src/extension/dbus/proposed-interface.xml b/src/extension/dbus/proposed-interface.xml
new file mode 100644 (file)
index 0000000..e82e433
--- /dev/null
+++ b/src/extension/dbus/proposed-interface.xml
@@ -0,0 +1,176 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<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>