src/extension/dbus/document-interface.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <node name="/org/inkscape/document"
   3   xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd"
   4 >
   5
   6   <interface name="org.inkscape.document">
   7
   8     <!-- MISC FUNCTIONS -->
   9
  10     <method name="delete_all" >
  11     </method>
  12
  13     <method name="call_verb">
  14       <arg type="s" name="verbid" direction="in">
  15         <doc:doc>
  16           <doc:summary>The string id of a verb.  For example: "EditSelectAll".</doc:summary>
  17         </doc:doc>
  18       </arg>
  19       <doc:doc>
  20         <doc:description>
  21           <doc:para>This method allows you to call any Inkscape verb using it's associated string.  Every button and menu item has an associated verb, so this allows access to some extra functionality if one is willing to do the prerequisite research.  The list of verbs can be found at:</doc:para>
  22         </doc:description>
  23       </doc:doc>
  24     </method>
  25
  26     <!-- CREATION FUNCTIONS -->
  27
  28     <method name="rectangle">
  29       <arg type="i" name="x" direction="in" >
  30         <doc:doc>
  31           <doc:summary>X coordinate for the top left corner of the rectangle.</doc:summary>
  32         </doc:doc>
  33       </arg>
  34       <arg type="i" name="y" direction="in" >
  35         <doc:doc>
  36           <doc:summary>Y coordinate for the top left corner of the rectangle.</doc:summary>
  37         </doc:doc>
  38       </arg>
  39       <arg type="i" name="width" direction="in" >
  40         <doc:doc>
  41           <doc:summary>Width of the rectangle.</doc:summary>
  42         </doc:doc>
  43       </arg>
  44       <arg type="i" name="height" direction="in" >
  45         <doc:doc>
  46           <doc:summary>Height of the rectangle.</doc:summary>
  47         </doc:doc>
  48       </arg>
  49       <arg type="s" name="object_name" direction="out" >
  50         <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value="error"/>
  51         <doc:doc>
  52           <doc:summary>The name of the new rectangle.</doc:summary>
  53         </doc:doc>
  54       </arg>
  55       <doc:doc>
  56         <doc:description>
  57           <doc:para>This method creates a rectangle in the current layer using the current document style.</doc:para>
  58           <doc:para>It is recommended that you save the return value if you will want to modify this particular shape later.</doc:para>
  59           <doc:para>Additional variables include:</doc:para>
  60           <doc:para>cx and cy: set these anywhere from zero to half the width or height respectively of the rectangle to give it rounded corners.</doc:para>
  61         </doc:description>
  62         <doc:seealso><doc:ref type="interface" to="Coordinate System">Coordinate System</doc:ref></doc:seealso>
  63       </doc:doc>
  64     </method>
  65
  66     <method name="ellipse">
  67       <arg type="i" name="x" direction="in" >
  68         <doc:doc>
  69           <doc:summary>X coordinate for the top left corner of the ellipse.</doc:summary>
  70         </doc:doc>
  71       </arg>
  72       <arg type="i" name="y" direction="in" >
  73         <doc:doc>
  74           <doc:summary>Y coordinate for the top left corner of the ellipse.</doc:summary>
  75         </doc:doc>
  76       </arg>
  77       <arg type="i" name="width" direction="in" >
  78         <doc:doc>
  79           <doc:summary>Width of the ellipse.</doc:summary>
  80         </doc:doc>
  81       </arg>
  82       <arg type="i" name="height" direction="in" >
  83         <doc:doc>
  84           <doc:summary>Height of the ellipse.</doc:summary>
  85         </doc:doc>
  86       </arg>
  87       <arg type="s" name="object_name" direction="out" >
  88         <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value="error"/>
  89         <doc:doc>
  90           <doc:summary>The name of the new ellipse.</doc:summary>
  91         </doc:doc>
  92       </arg>
  93       <doc:doc>
  94         <doc:description>
  95           <doc:para>This method creates a ellipse in the current layer using the current document style.</doc:para>
  96           <doc:para>It is recommended that you save the return value if you will want to modify this particular shape later.</doc:para>
  97           <doc:para>Additional variables include:</doc:para>
  98           <doc:para>"sodipodi:start" and "sodipodi:end": set these between 0 and Pi to create wedges or Pacman like shapes.</doc:para>
  99         </doc:description>
 100         <doc:seealso><doc:ref type="interface" to="Coordinate System">Coordinate System</doc:ref></doc:seealso>
 101       </doc:doc>
 102     </method>
 103
 104     <method name="polygon">
 105       <arg type="i" name="cx" direction="in" >
 106         <doc:doc>
 107           <doc:summary>X coordinate for the center of the polygon.</doc:summary>
 108         </doc:doc>
 109       </arg>
 110       <arg type="i" name="cy" direction="in" >
 111         <doc:doc>
 112           <doc:summary>Y coordinate for the center of the polygon.</doc:summary>
 113         </doc:doc>
 114       </arg>
 115       <arg type="i" name="radius" direction="in" >
 116         <doc:doc>
 117           <doc:summary>Radius from the center to one of the points.</doc:summary>
 118         </doc:doc>
 119       </arg>
 120       <arg type="i" name="rotation" direction="in" >
 121         <doc:doc>
 122           <doc:summary>Angle in degrees to rotate.  0 will have the first point pointing straight up.</doc:summary>
 123         </doc:doc>
 124       </arg>
 125       <arg type="i" name="sides" direction="in" >
 126         <doc:doc>
 127           <doc:summary>Number of sides of the polygon.</doc:summary>
 128         </doc:doc>
 129       </arg>
 130       <arg type="s" name="object_name" direction="out" >
 131         <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value="error"/>
 132         <doc:doc>
 133           <doc:summary>The name of the new polygon.</doc:summary>
 134         </doc:doc>
 135       </arg>
 136       <doc:doc>
 137         <doc:description>
 138           <doc:para>This method creates a polygon in the current layer using the current document style.</doc:para>
 139           <doc:para>It is recommended that you save the return value if you will want to modify this particular shape later.</doc:para>
 140           <doc:para>Note: this is actually a <doc:ref type="method" to="document.star">star</doc:ref> with "sodipodi:flatsided" set to true, which causes it to ignore the arg2 and r2 values.</doc:para>
 141         </doc:description>
 142         <doc:seealso><doc:ref type="interface" to="Coordinate System">Coordinate System</doc:ref></doc:seealso>
 143       </doc:doc>
 144     </method>
 145
 146     <method name="star">
 147       <arg type="i" name="cx" direction="in" >
 148         <doc:doc>
 149           <doc:summary>X coordinate for the center of the star.</doc:summary>
 150         </doc:doc>
 151       </arg>
 152       <arg type="i" name="cy" direction="in" >
 153         <doc:doc>
 154           <doc:summary>Y coordinate for the center of the star.</doc:summary>
 155         </doc:doc>
 156       </arg>
 157       <arg type="i" name="r1" direction="in" >
 158         <doc:doc>
 159           <doc:summary>distance from the center for the first point.</doc:summary>
 160         </doc:doc>
 161       </arg>
 162       <arg type="i" name="r2" direction="in" >
 163         <doc:doc>
 164           <doc:summary>distance from the center for the second point.</doc:summary>
 165         </doc:doc>
 166       </arg>
 167       <arg type="d" name="arg1" direction="in" >
 168         <doc:doc>
 169           <doc:summary>Angle in radians for the first point.  0 is 90 degrees to the right of straight up.</doc:summary>
 170         </doc:doc>
 171       </arg>
 172       <arg type="d" name="arg2" direction="in" >
 173         <doc:doc>
 174           <doc:summary>Angle in radians for the second point. 0 is 90 degrees to the right of straight up.</doc:summary>
 175         </doc:doc>
 176       </arg>
 177       <arg type="i" name="sides" direction="in" >
 178         <doc:doc>
 179           <doc:summary>Number of times to repeat the points around the star.</doc:summary>
 180         </doc:doc>
 181       </arg>
 182       <arg type="d" name="rounded" direction="in" >
 183         <doc:doc>
 184           <doc:summary>How rounded to make the star.  0 to 1 recommended for moderate to medium curves.  10 for extreme curves.</doc:summary>
 185         </doc:doc>
 186       </arg>
 187       <arg type="s" name="object_name" direction="out" >
 188         <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value="error"/>
 189         <doc:doc>
 190           <doc:summary>The name of the new star.</doc:summary>
 191         </doc:doc>
 192       </arg>
 193       <doc:doc>
 194         <doc:description>
 195           <doc:para>This method creates a star in the current layer using the current document style.</doc:para>
 196           <doc:para>It is recommended that you save the return value if you will want to modify this particular shape later.</doc:para>
 197           <doc:para>Stars are quite complicated.  Here is how they are represented:  There are two points, represented by sodipodi:arg1 and sodipodi:arg2 for angle in radians and sodipodi:r1 and sodipodi:r2 for respective radius from the center point.  The further one is a point of the star, the shorter one one of the valleys.  This point and valley are repeated according to sodipodi:sides.  sodipodi:rounded controls their control handles.</doc:para>
 198         </doc:description>
 199         <doc:seealso><doc:ref type="interface" to="Coordinate System">Coordinate System</doc:ref></doc:seealso>
 200       </doc:doc>
 201     </method>
 202
 203     <method name="spiral">
 204       <arg type="i" name="cx" direction="in" >
 205         <doc:doc>
 206           <doc:summary>X coordinate for the center of the spiral.</doc:summary>
 207         </doc:doc>
 208       </arg>
 209       <arg type="i" name="cy" direction="in" >
 210         <doc:doc>
 211           <doc:summary>Y coordinate for the center of the spiral.</doc:summary>
 212         </doc:doc>
 213       </arg>
 214       <arg type="i" name="r" direction="in" >
 215         <doc:doc>
 216           <doc:summary>Radius of the spiral.</doc:summary>
 217         </doc:doc>
 218       </arg>
 219       <arg type="i" name="revolutions" direction="in" >
 220         <doc:doc>
 221           <doc:summary>Number of revolutions.</doc:summary>
 222         </doc:doc>
 223       </arg>
 224       <arg type="s" name="object_name" direction="out" >
 225         <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value="error"/>
 226         <doc:doc>
 227           <doc:summary>The name of the new spiral.</doc:summary>
 228         </doc:doc>
 229       </arg>
 230       <doc:doc>
 231         <doc:description>
 232           <doc:para>This method creates a spiral in the current layer using the current document style.  However, fill is automatically set to "none".  Stroke is unmodified.</doc:para>
 233           <doc:para>It is recommended that you save the return value if you will want to modify this particular shape later.</doc:para>
 234           <doc:para>Additional variables include:</doc:para>
 235           <doc:para>"sodipodi:expansion": at 1 the spiral gets bigger at a constant rate.  Less than one and the loops get tighter and tighter as it goes.  More than one and they get looser and looser.  This affects the number of revolutions so that it might not actually match the "sodipodi:revolutions" argument.</doc:para>
 236           <doc:para>"sodipodi:t0": at 0 the entire spiral is drawn, at 0.5 it is only drawn %50 of the way (starting from the outside) etc.</doc:para>
 237           <doc:para>"sodipodi:argument": Rotates the spiral.  In radians.</doc:para>
 238         </doc:description>
 239         <doc:seealso><doc:ref type="interface" to="Coordinate System">Coordinate System</doc:ref></doc:seealso>
 240       </doc:doc>
 241     </method>
 242
 243     <method name="line">
 244       <arg type="i" name="x" direction="in" >
 245         <doc:doc>
 246           <doc:summary>X coordinate for the first point.</doc:summary>
 247         </doc:doc>
 248       </arg>
 249       <arg type="i" name="y" direction="in" >
 250         <doc:doc>
 251           <doc:summary>Y coordinate for the first point.</doc:summary>
 252         </doc:doc>
 253       </arg>
 254       <arg type="i" name="x2" direction="in" >
 255         <doc:doc>
 256           <doc:summary>X coordinate for the second point.</doc:summary>
 257         </doc:doc>
 258       </arg>
 259       <arg type="i" name="y2" direction="in" >
 260         <doc:doc>
 261           <doc:summary>Y coordinate for the second point.</doc:summary>
 262         </doc:doc>
 263       </arg>
 264       <arg type="s" name="object_name" direction="out" >
 265         <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value="error"/>
 266         <doc:doc>
 267           <doc:summary>The name of the new line.</doc:summary>
 268         </doc:doc>
 269       </arg>
 270       <doc:doc>
 271         <doc:description>
 272           <doc:para>This method creates a line in the current layer using the current document style.  It's a path, so the only attribute it will pay any attention to is "transform".</doc:para>
 273         </doc:description>
 274         <doc:seealso><doc:ref type="interface" to="Coordinate System">Coordinate System</doc:ref></doc:seealso>
 275       </doc:doc>
 276     </method>
 277
 278     <method name="text">
 279       <arg type="i" name="x" direction="in" >
 280         <doc:doc>
 281           <doc:summary>The x coordinate to put the text at.</doc:summary>
 282         </doc:doc>
 283       </arg>
 284       <arg type="i" name="y" direction="in" >
 285         <doc:doc>
 286           <doc:summary>The y coordinate to put the text at.</doc:summary>
 287         </doc:doc>
 288       </arg>
 289       <arg type="s" name="text" direction="in" >
 290         <doc:doc>
 291           <doc:summary>The text you want.</doc:summary>
 292         </doc:doc>
 293       </arg>
 294       <doc:doc>
 295         <doc:description>
 296           <doc:para>This method creates some text in the current layer.</doc:para>
 297         </doc:description>
 298       </doc:doc>
 299     </method>
 300
 301     <method name="node">
 302       <arg type="s" name="svgtype" direction="in" >
 303         <doc:doc>
 304           <doc:summary>The type of node, probably "svg:path"</doc:summary>
 305         </doc:doc>
 306       </arg>
 307       <arg type="s" name="node_name" direction="out" >
 308         <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value="error"/>
 309         <doc:doc>
 310           <doc:summary>The name of the new node.</doc:summary>
 311         </doc:doc>
 312       </arg>
 313       <doc:doc>
 314         <doc:description>
 315           <doc:para>Make any kind of node you want.  Mostly for making paths.  (May need to allow updateRepr to be called for it to show up.)</doc:para>
 316         </doc:description>
 317       </doc:doc>
 318     </method>
 319
 320     <!-- ENVIRONMENT FUNCTIONS -->
 321
 322     <method name="document_get_width">
 323       <arg type="d" name="val" direction="out" >
 324         <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value=""/>
 325         <doc:doc>
 326           <doc:summary>Document width.</doc:summary>
 327         </doc:doc>
 328       </arg>
 329       <doc:doc>
 330         <doc:description>
 331           <doc:para>Retrieve the width of the current document. anything outside the boundary will not be printed or exported but will be saved.</doc:para>
 332         </doc:description>
 333       </doc:doc>
 334     </method>
 335
 336     <method name="document_get_height">
 337       <arg type="d" name="val" direction="out" >
 338         <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value=""/>
 339         <doc:doc>
 340           <doc:summary>Document height.</doc:summary>
 341         </doc:doc>
 342       </arg>
 343       <doc:doc>
 344         <doc:description>
 345           <doc:para>Retrieve the height of the current document. anything outside the boundary will not be printed or exported but will be saved.</doc:para>
 346         </doc:description>
 347       </doc:doc>
 348     </method>
 349
 350     <method name="document_get_css">
 351       <arg type="s" name="css" direction="out" >
 352         <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value="error"/>
 353         <doc:doc>
 354           <doc:summary>CSS attribute string for the document.</doc:summary>
 355         </doc:doc>
 356       </arg>
 357       <doc:doc>
 358         <doc:description>
 359           <doc:para>Get the current style for the document.  All new shapes will use this style if it exists.</doc:para>
 360         </doc:description>
 361         <doc:seealso><doc:ref type="interface" to="Style Strings">Style Strings</doc:ref></doc:seealso>
 362       </doc:doc>
 363     </method>
 364
 365     <method name="document_set_css">
 366       <arg type="s" name="stylestring" direction="in" >
 367         <doc:doc>
 368           <doc:summary>A new CSS attribute string for the document.</doc:summary>
 369         </doc:doc>
 370       </arg>
 371       <doc:doc>
 372         <doc:description>
 373           <doc:para>Set the current style for the document.  All new shapes will use this style if it exists.</doc:para>
 374         </doc:description>
 375         <doc:seealso><doc:ref type="interface" to="Style Strings">Style Strings</doc:ref></doc:seealso>
 376       </doc:doc>
 377     </method>
 378
 379     <method name="document_merge_css">
 380       <arg type="s" name="stylestring" direction="in" >
 381         <doc:doc>
 382           <doc:summary>A new CSS attribute string for the document.</doc:summary>
 383         </doc:doc>
 384       </arg>
 385       <doc:doc>
 386         <doc:description>
 387           <doc:para>Merge this this string with the current style for the document.  All new shapes will use this style if it exists.</doc:para>
 388         </doc:description>
 389         <doc:seealso><doc:ref type="interface" to="Style Strings">Style Strings</doc:ref>, <doc:ref type="method" to="document.merge_css">merge_css()</doc:ref></doc:seealso>
 390       </doc:doc>
 391     </method>
 392
 393     <method name="document_resize_to_fit_selection">
 394       <doc:doc>
 395         <doc:description>
 396           <doc:para>Resize the document to contain all of the currently selected objects.</doc:para>
 397           <doc:para>This ensures that the image is not clipped when printing or exporting.</doc:para>
 398         </doc:description>
 399       </doc:doc>
 400     </method>
 401
 402     <!-- OBJECT FUNCTIONS -->
 403
 404     <method name="set_attribute">
 405       <arg type="s" name="shape" direction="in" >
 406         <doc:doc>
 407           <doc:summary>The id of an object.</doc:summary>
 408         </doc:doc>
 409       </arg>
 410       <arg type="s" name="attribute" direction="in" >
 411         <doc:doc>
 412           <doc:summary>The name of the attribute.</doc:summary>
 413         </doc:doc>
 414       </arg>
 415       <arg type="s" name="newval" direction="in" >
 416         <doc:doc>
 417           <doc:summary>The new value of the attribute.  This will overwrite anything already set.  To merge styles, see <doc:ref type="method" to="document.merge_css">merge_css()</doc:ref>. </doc:summary>
 418         </doc:doc>
 419       </arg>
 420       <doc:doc>
 421         <doc:description>
 422           <doc:para>Set any attribute, the available attributes depend on what kind of shape the object node represents.  See <doc:ref type="method" to="document.rectangle">shape creation functions</doc:ref> for more details.</doc:para>
 423         </doc:description>
 424       </doc:doc>
 425     </method>
 426
 427     <method name="set_int_attribute">
 428       <arg type="s" name="shape" direction="in" >
 429         <doc:doc>
 430           <doc:summary>The id of an object.</doc:summary>
 431         </doc:doc>
 432       </arg>
 433       <arg type="s" name="attribute" direction="in" >
 434         <doc:doc>
 435           <doc:summary>The name of the attribute.</doc:summary>
 436         </doc:doc>
 437       </arg>
 438       <arg type="i" name="newval" direction="in" >
 439         <doc:doc>
 440           <doc:summary>The new value of the attribute.  This will overwrite anything already set.</doc:summary>
 441         </doc:doc>
 442       </arg>
 443       <doc:doc>
 444         <doc:description>
 445           <doc:para>Set any attribute, the available attributes depend on what kind of shape the object node represents.  See <doc:ref type="method" to="document.rectangle">shape creation functions</doc:ref> for more details.</doc:para>
 446           <doc:para>This is a convenience function for <doc:ref type="method" to="document.set_attribute">set_attribute()</doc:ref>.</doc:para>
 447         </doc:description>
 448       </doc:doc>
 449     </method>
 450
 451     <method name="set_double_attribute">
 452       <arg type="s" name="shape" direction="in" >
 453         <doc:doc>
 454           <doc:summary>The id of an object.</doc:summary>
 455         </doc:doc>
 456       </arg>
 457       <arg type="s" name="attribute" direction="in" >
 458         <doc:doc>
 459           <doc:summary>The name of the attribute.</doc:summary>
 460         </doc:doc>
 461       </arg>
 462       <arg type="d" name="newval" direction="in" >
 463         <doc:doc>
 464           <doc:summary>The new value of the attribute.  This will overwrite anything already set.</doc:summary>
 465         </doc:doc>
 466       </arg>
 467       <doc:doc>
 468         <doc:description>
 469           <doc:para>Set any attribute, the available attributes depend on what kind of shape the node represents.  See <doc:ref type="method" to="document.rectangle">shape creation functions</doc:ref> for more details.</doc:para>
 470           <doc:para>This is a convenience function for <doc:ref type="method" to="document.set_attribute">set_attribute()</doc:ref>.</doc:para>
 471         </doc:description>
 472       </doc:doc>
 473     </method>
 474
 475     <method name="get_attribute">
 476       <arg type="s" name="shape" direction="in" >
 477         <doc:doc>
 478           <doc:summary>The id of an object.</doc:summary>
 479         </doc:doc>
 480       </arg>
 481       <arg type="s" name="attribute" direction="in" >
 482         <doc:doc>
 483           <doc:summary>The name of the attribute.</doc:summary>
 484         </doc:doc>
 485       </arg>
 486       <arg type="s" name="val" direction="out" >
 487         <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value="error"/>
 488         <doc:doc>
 489           <doc:summary>The current value of the attribute.  String is a copy and must be freed.</doc:summary>
 490         </doc:doc>
 491       </arg>
 492       <doc:doc>
 493         <doc:description>
 494           <doc:para>Get the value of any attribute.  Not all objects will have every attribute their type supports, some are optional.   See <doc:ref type="method" to="document.rectangle">shape creation functions</doc:ref> for more details.</doc:para>
 495         </doc:description>
 496       </doc:doc>
 497     </method>
 498
 499     <method name="move">
 500       <arg type="s" name="shape" direction="in" >
 501         <doc:doc>
 502           <doc:summary>The id of an object.</doc:summary>
 503         </doc:doc>
 504       </arg>
 505       <arg type="d" name="x" direction="in" >
 506         <doc:doc>
 507           <doc:summary>Distance to move along the x axis.</doc:summary>
 508         </doc:doc>
 509       </arg>
 510       <arg type="d" name="y" direction="in" >
 511         <doc:doc>
 512           <doc:summary>Distance to move along the y axis.</doc:summary>
 513         </doc:doc>
 514       </arg>
 515       <doc:doc>
 516         <doc:description>
 517           <doc:para>This will move a shape (or any object) relative to it's current location.</doc:para>
 518           <doc:para>This may be accomplished with transformation attributes or by changing x and y attributes depending on the state of the object.</doc:para>
 519         </doc:description>
 520         <doc:seealso><doc:ref type="interface" to="Coordinate System">Coordinate System</doc:ref></doc:seealso>
 521       </doc:doc>
 522     </method>
 523
 524     <method name="move_to">
 525       <arg type="s" name="shape" direction="in" >
 526         <doc:doc>
 527           <doc:summary>The id of an object.</doc:summary>
 528         </doc:doc>
 529       </arg>
 530       <arg type="d" name="x" direction="in" >
 531         <doc:doc>
 532           <doc:summary>the x coordinate of the desired location.</doc:summary>
 533         </doc:doc>
 534       </arg>
 535       <arg type="d" name="y" direction="in" >
 536         <doc:doc>
 537           <doc:summary>the y coordinate of the desired location.</doc:summary>
 538         </doc:doc>
 539       </arg>
 540       <doc:doc>
 541         <doc:description>
 542           <doc:para>This will move a shape (or any object) to an absolute location.  The point moved is the center of the bounding box, which is usually similar to the center of the shape.</doc:para>
 543           <doc:para>Note that creating a rectangle or ellipse at 100,100 and calling move_to to move it to 100,100 will not produce the same results.</doc:para>
 544           <doc:para>This may be accomplished with transformation attributes or by changing x and y attributes depending on the state of the object.</doc:para>
 545         </doc:description>
 546         <doc:seealso><doc:ref type="interface" to="Coordinate System">Coordinate System</doc:ref></doc:seealso>
 547       </doc:doc>
 548     </method>
 549
 550     <method name="object_to_path">
 551       <arg type="s" name="objectname" direction="in" >
 552         <doc:doc>
 553           <doc:summary>The id of an object.</doc:summary>
 554         </doc:doc>
 555       </arg>
 556       <doc:doc>
 557         <doc:description>
 558           <doc:para>Turns an object into a path.  Most objects contain paths (except rectangles) but are not paths themselves. </doc:para>
 559           <doc:para>This will remove every attribute except d (the path attribute) style and id.  id will not change.  The appearance will be the same as well, it essentially encodes all information about the shape into the path.</doc:para>
 560           <doc:para>After doing this you will no longer be able to modify the shape using shape specific attributes (cx, radius etc.) except transform</doc:para>
 561           <doc:para>Required for certain functions that work on paths (not yet present in this API.)</doc:para>
 562         </doc:description>
 563         <doc:seealso><doc:ref type="interface" to="Paths">Paths</doc:ref></doc:seealso>
 564       </doc:doc>
 565     </method>
 566
 567     <method name="get_path">
 568       <arg type="s" name="shape" direction="in" >
 569         <doc:doc>
 570           <doc:summary>The id of an object.</doc:summary>
 571         </doc:doc>
 572       </arg>
 573       <arg type="s" name="val" direction="out" >
 574         <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value="error"/>
 575         <doc:doc>
 576           <doc:summary>The path of the object.  NULL if the object has no path.</doc:summary>
 577         </doc:doc>
 578       </arg>
 579       <doc:doc>
 580         <doc:description>
 581           <doc:para>Get the path value of an object.  Equivilent to calling <doc:ref type="method" to="document.get_attribute">get_attribte()</doc:ref> with argument "d".  Will not turn object into a path if it is not already.</doc:para>
 582         </doc:description>
 583         <doc:seealso><doc:ref type="interface" to="Paths">Paths</doc:ref></doc:seealso>
 584       </doc:doc>
 585     </method>
 586
 587     <method name="transform">
 588       <arg type="s" name="shape" direction="in" >
 589         <doc:doc>
 590           <doc:summary>The id of any node or object.</doc:summary>
 591         </doc:doc>
 592       </arg>
 593       <arg type="s" name="transformstr" direction="in" >
 594         <doc:doc>
 595           <doc:summary>A string that represents a transformation.</doc:summary>
 596         </doc:doc>
 597       </arg>
 598       <doc:doc>
 599         <doc:description>
 600           <doc:para>Takes a transformation string ("matrix(0.96629885,0.25742286,-0.25742286,0.96629885,0,0)" or "rotate(45)") and applies it to any shape or path.</doc:para>
 601           <doc:para>Will merge with existing transformations.</doc:para>
 602         </doc:description>
 603       </doc:doc>
 604     </method>
 605
 606     <method name="get_css">
 607       <arg type="s" name="shape" direction="in" >
 608         <doc:doc>
 609           <doc:summary>Any object with a style attribute.</doc:summary>
 610         </doc:doc>
 611       </arg>
 612       <arg type="s" name="css" direction="out" >
 613         <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value="error"/>
 614         <doc:doc>
 615           <doc:summary>A CSS Style string</doc:summary>
 616         </doc:doc>
 617       </arg>
 618       <doc:doc>
 619         <doc:description>
 620           <doc:para>Retrieve the style of a object.  Equivalent to calling <doc:ref type="method" to="document.get_attribute">get_attribute()</doc:ref> for "style".</doc:para>
 621         </doc:description>
 622         <doc:seealso><doc:ref type="interface" to="Style Strings">Style Strings</doc:ref></doc:seealso>
 623       </doc:doc>
 624     </method>
 625
 626     <method name="modify_css">
 627       <arg type="s" name="shape" direction="in" >
 628         <doc:doc>
 629           <doc:summary>Any object with a style attribute.</doc:summary>
 630         </doc:doc>
 631       </arg>
 632       <arg type="s" name="cssattrib" direction="in" >
 633         <doc:doc>
 634           <doc:summary>An attribute such as "fill" or "stroke-width".</doc:summary>
 635         </doc:doc>
 636       </arg>
 637       <arg type="s" name="newval" direction="in" >
 638         <doc:doc>
 639           <doc:summary>The new value.</doc:summary>
 640         </doc:doc>
 641       </arg>
 642       <doc:doc>
 643         <doc:description>
 644           <doc:para>Set a particular attribute of a style string.  Overwrites just that part of the style.</doc:para>
 645         </doc:description>
 646         <doc:seealso><doc:ref type="interface" to="Style Strings">Style Strings</doc:ref></doc:seealso>
 647       </doc:doc>
 648     </method>
 649
 650     <method name="merge_css">
 651       <arg type="s" name="shape" direction="in" >
 652         <doc:doc>
 653           <doc:summary>Any object with a style attribute.</doc:summary>
 654         </doc:doc>
 655       </arg>
 656       <arg type="s" name="stylestring" direction="in" >
 657         <doc:doc>
 658           <doc:summary>A full or partial CSS Style string.</doc:summary>
 659         </doc:doc>
 660       </arg>
 661       <doc:doc>
 662         <doc:description>
 663           <doc:para>Takes a CSS Style string and merges it with the objects current style, overwriting only the elements present in stylestring.</doc:para>
 664         </doc:description>
 665         <doc:seealso><doc:ref type="interface" to="Style Strings">Style Strings</doc:ref></doc:seealso>
 666       </doc:doc>
 667     </method>
 668
 669     <method name="move_to_layer">
 670       <arg type="s" name="objectname" direction="in" >
 671         <doc:doc>
 672           <doc:summary>The id of an object.</doc:summary>
 673         </doc:doc>
 674       </arg>
 675       <arg type="s" name="layername" direction="in" >
 676         <doc:doc>
 677           <doc:summary>A layer name.</doc:summary>
 678         </doc:doc>
 679       </arg>
 680       <doc:doc>
 681         <doc:description>
 682           <doc:para>Moves an object to a different layer.</doc:para>
 683           <doc:para>Will error if layer does not exist.</doc:para>
 684         </doc:description>
 685         <doc:seealso><doc:ref type="interface" to="document.layer_new">layer_new()</doc:ref></doc:seealso>
 686       </doc:doc>
 687     </method>
 688
 689     <method name="get_node_coordinates">
 690       <arg type="s" name="shape" direction="in" >
 691         <doc:doc>
 692           <doc:summary>A object that contains a path ("d") attribute.</doc:summary>
 693         </doc:doc>
 694       </arg>
 695       <arg type="ai" name="points" direction="out" >
 696         <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value=""/>
 697         <doc:doc>
 698           <doc:summary>An array of points.</doc:summary>
 699         </doc:doc>
 700       </arg>
 701       <doc:doc>
 702         <doc:description>
 703           <doc:para>Returns an array of all of the X,Y coordinates of the points in the objects path.</doc:para>
 704           <doc:para>If the path is a closed loop the first point is repeated at the end.</doc:para>
 705         </doc:description>
 706       </doc:doc>
 707     </method>
 708
 709     <!-- FILE I/O FUNCTIONS -->
 710
 711     <method name="save" >
 712       <doc:doc>
 713         <doc:description>
 714           <doc:para>Saves the current document with current name or a default name if has not been saved before.</doc:para>
 715           <doc:para>Will overwrite without confirmation.</doc:para>
 716         </doc:description>
 717       </doc:doc>
 718     </method>
 719
 720     <method name="save_as">
 721       <arg type="s" name="pathname" direction="in" >
 722         <doc:doc>
 723           <doc:summary>The path for the file to be saved as.</doc:summary>
 724         </doc:doc>
 725       </arg>
 726       <doc:doc>
 727         <doc:description>
 728           <doc:para>Saves the current document as pathname.</doc:para>
 729           <doc:para>Will overwrite without confirmation.</doc:para>
 730         </doc:description>
 731       </doc:doc>
 732     </method>
 733
 734     <method name="load">
 735       <arg type="s" name="pathname" direction="in" >
 736         <doc:doc>
 737           <doc:summary>The path to a valid svg file.</doc:summary>
 738         </doc:doc>
 739       </arg>
 740       <doc:doc>
 741         <doc:description>
 742           <doc:para>Loads the file at pathname.</doc:para>
 743           <doc:para>Will lose all unsaved work in current document.</doc:para>
 744         </doc:description>
 745       </doc:doc>
 746     </method>
 747
 748     <method name="mark_as_unmodified" >
 749       <doc:doc>
 750         <doc:description>
 751           <doc:para>Marks the document as unmodified/saved.</doc:para>
 752           <doc:para>Will prevent save confirmation on close if called at end of script.</doc:para>
 753         </doc:description>
 754       </doc:doc>
 755     </method>
 756     <!--
 757     <method name="print_to_file" >
 758       <doc:doc>
 759         <doc:description>
 760           <doc:para>Prints the current document with default settings.</doc:para>
 761           <doc:para>Will only print things visible within the document boundaries.</doc:para>
 762         </doc:description>
 763         <doc:seealso><doc:ref type="interface" to="document.document_resize_to_fit_selection">document_resize_to_fit_selection()</doc:ref></doc:seealso>
 764       </doc:doc>
 765     </method>
 766     -->
 767
 768     <!-- PROGRAM CONTROL FUNCTIONS -->
 769
 770     <method name="close" >
 771       <doc:doc>
 772         <doc:description>
 773           <doc:para>Close this document.</doc:para>
 774           <doc:para>You will not be able to send any more commands on this interface.</doc:para>
 775         </doc:description>
 776       </doc:doc>
 777     </method>
 778
 779     <method name="exit" >
 780       <doc:doc>
 781         <doc:description>
 782           <doc:para>Exit Inkscape.</doc:para>
 783           <doc:para>You will not be able to send any more commands on any interface.</doc:para>
 784         </doc:description>
 785       </doc:doc>
 786     </method>
 787
 788     <method name="undo" >
 789       <doc:doc>
 790         <doc:description>
 791           <doc:para>Undo the last action.</doc:para>
 792         </doc:description>
 793       </doc:doc>
 794     </method>
 795
 796     <method name="redo" >
 797       <doc:doc>
 798         <doc:description>
 799           <doc:para>Redo the last undone action.</doc:para>
 800         </doc:description>
 801       </doc:doc>
 802     </method>
 803
 804     <!-- UPDATE FUNCTIONS -->
 805
 806     <method name="pause_updates" >
 807       <doc:doc>
 808         <doc:description>
 809           <doc:para>When updates are paused Inkscape will not draw every change as it is made.  Also you will not be able to undo individual actions made while updates were paused and will only be able to undo them in a group.  Inkscape may refresh the screen every couple of seconds even with updates off.</doc:para>
 810           <doc:para>The advantage is a 2-5x speed increase, depending on the type of functions being called.  This is most useful when creating large numbers of shapes.</doc:para>
 811         </doc:description>
 812       </doc:doc>
 813     </method>
 814
 815     <method name="resume_updates" >
 816       <doc:doc>
 817         <doc:description>
 818           <doc:para>Resume updates after they have been paused.  If undo is called at this point it will undo everything that happened since pause_updates() was called.</doc:para>
 819           <doc:para>This will update the display to show any changes that happened while updates were paused, a separate call to update() is not necessary.</doc:para>
 820         </doc:description>
 821       </doc:doc>
 822     </method>
 823
 824     <method name="update" >
 825       <doc:doc>
 826         <doc:description>
 827           <doc:para>This will update the document once if updates are paused but it will not resume updates.</doc:para>
 828           <doc:para>This could be used to check on the progress of a complex drawing function, or to add in undo steps at certain points in a render.</doc:para>
 829         </doc:description>
 830       </doc:doc>
 831     </method>
 832
 833     <!-- SELECTION FUNCTIONS -->
 834
 835     <method name="selection_get">
 836       <arg type="as" name="listy" direction="out" >
 837        <!-- <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value=""/> -->
 838         <doc:doc>
 839           <doc:summary>List of the ids of currently selected objects.</doc:summary>
 840         </doc:doc>
 841       </arg>
 842       <doc:doc>
 843         <doc:description>
 844           <doc:para>Returns the current selection in the form of a list of ids of selected objects.</doc:para>
 845           <doc:para>Manipulating this list will not affect the selection.</doc:para>
 846         </doc:description>
 847       </doc:doc>
 848     </method>
 849
 850     <method name="selection_add">
 851       <arg type="s" name="name" direction="in" >
 852         <doc:doc>
 853           <doc:summary>A object to add to the selection.</doc:summary>
 854         </doc:doc>
 855       </arg>
 856       <doc:doc>
 857         <doc:description>
 858           <doc:para>Adds a single object to the selection.</doc:para>
 859         </doc:description>
 860       </doc:doc>
 861     </method>
 862
 863     <method name="selection_add_list">
 864       <arg type="as" name="name" direction="in" >
 865         <doc:doc>
 866           <doc:summary>An array of object ids to add to the selection.</doc:summary>
 867         </doc:doc>
 868       </arg>
 869       <doc:doc>
 870         <doc:description>
 871           <doc:para>Adds a list of objects to the selection.</doc:para>
 872         </doc:description>
 873       </doc:doc>
 874     </method>
 875
 876     <method name="selection_set">
 877       <arg type="s" name="name" direction="in" >
 878         <doc:doc>
 879           <doc:summary>A object to select.</doc:summary>
 880         </doc:doc>
 881       </arg>
 882       <doc:doc>
 883         <doc:description>
 884           <doc:para>Replaces the selection with one containing just this object.</doc:para>
 885         </doc:description>
 886       </doc:doc>
 887     </method>
 888
 889     <method name="selection_set_list">
 890       <arg type="as" name="name" direction="in" >
 891         <doc:doc>
 892           <doc:summary>A list of objects to select.</doc:summary>
 893         </doc:doc>
 894       </arg>
 895       <doc:doc>
 896         <doc:description>
 897           <doc:para>Replaces the selection with one containing just these objects.</doc:para>
 898         </doc:description>
 899       </doc:doc>
 900     </method>
 901
 902     <method name="selection_rotate">
 903       <arg type="i" name="angle" direction="in" >
 904         <doc:doc>
 905           <doc:summary>Angle in degrees to rotate.</doc:summary>
 906         </doc:doc>
 907       </arg>
 908       <doc:doc>
 909         <doc:description>
 910           <doc:para>Rotates the selection around the center of it's bounding box.</doc:para>
 911         </doc:description>
 912       </doc:doc>
 913     </method>
 914
 915     <method name="selection_delete" >
 916       <doc:doc>
 917         <doc:description>
 918           <doc:para>Delete all objects in the selection.</doc:para>
 919         </doc:description>
 920       </doc:doc>
 921     </method>
 922
 923     <method name="selection_clear" >
 924       <doc:doc>
 925         <doc:description>
 926           <doc:para>Deselect everything.  Selection will be empty.</doc:para>
 927         </doc:description>
 928       </doc:doc>
 929     </method>
 930
 931     <method name="select_all" >
 932       <doc:doc>
 933         <doc:description>
 934           <doc:para>Select all objects in current layer.</doc:para>
 935         </doc:description>
 936       </doc:doc>
 937     </method>
 938
 939     <method name="select_all_in_all_layers" >
 940       <doc:doc>
 941         <doc:description>
 942           <doc:para>Select all objects in every layer.</doc:para>
 943         </doc:description>
 944       </doc:doc>
 945     </method>
 946
 947     <method name="selection_box">
 948       <arg type="i" name="x" direction="in" >
 949         <doc:doc>
 950           <doc:summary>X coordinate for the first point.</doc:summary>
 951         </doc:doc>
 952       </arg>
 953       <arg type="i" name="y" direction="in" >
 954         <doc:doc>
 955           <doc:summary>Y coordinate for the first point.</doc:summary>
 956         </doc:doc>
 957       </arg>
 958       <arg type="i" name="x2" direction="in" >
 959         <doc:doc>
 960           <doc:summary>X coordinate for the second point.</doc:summary>
 961         </doc:doc>
 962       </arg>
 963       <arg type="i" name="y2" direction="in" >
 964         <doc:doc>
 965           <doc:summary>Y coordinate for the second point.</doc:summary>
 966         </doc:doc>
 967       </arg>
 968       <arg type="b" name="replace" direction="in" >
 969         <doc:doc>
 970           <doc:summary>True to replace selection, false to add to selection.</doc:summary>
 971         </doc:doc>
 972       </arg>
 973       <doc:doc>
 974         <doc:description>
 975           <doc:para>This method finds all of the objects inside the box and adds them to the current selection.  If replace is true it will clear the old selection first.</doc:para>
 976         </doc:description>
 977       </doc:doc>
 978     </method>
 979
 980     <method name="selection_invert" >
 981       <doc:doc>
 982         <doc:description>
 983           <doc:para>Invert the selection in the current layer.</doc:para>
 984         </doc:description>
 985       </doc:doc>
 986     </method>
 987
 988     <method name="selection_group" >
 989       <doc:doc>
 990         <doc:description>
 991           <doc:para>Group the selection.</doc:para>
 992         </doc:description>
 993         <doc:seealso><doc:ref type="interface" to="Groups">Groups</doc:ref></doc:seealso>
 994       </doc:doc>
 995     </method>
 996
 997     <method name="selection_ungroup" >
 998       <doc:doc>
 999         <doc:description>
1000           <doc:para>Ungroup the selection.</doc:para>
1001         </doc:description>
1002         <doc:seealso><doc:ref type="interface" to="Groups">Groups</doc:ref></doc:seealso>
1003       </doc:doc>
1004     </method>
1005
1006     <method name="selection_cut" >
1007       <doc:doc>
1008         <doc:description>
1009           <doc:para>Cut the current selection.</doc:para>
1010         </doc:description>
1011       </doc:doc>
1012     </method>
1013
1014     <method name="selection_copy" >
1015       <doc:doc>
1016         <doc:description>
1017           <doc:para>Copy the current selection.</doc:para>
1018         </doc:description>
1019       </doc:doc>
1020     </method>
1021
1022     <method name="selection_paste" >
1023       <doc:doc>
1024         <doc:description>
1025           <doc:para>Paste the current selection at the same location it was cut from.</doc:para>
1026           <doc:para>To paste to a particular location, simply use selection_paste() followed by <doc:ref type="method" to="document.selection_move_to">selection_move_to()</doc:ref>.</doc:para>
1027         </doc:description>
1028       </doc:doc>
1029     </method>
1030
1031     <method name="selection_scale">
1032       <arg type="d" name="grow" direction="in" >
1033         <doc:doc>
1034           <doc:summary>The amount to scale the selection, 1 has no effect. Between 0 and 1 will shrink it proportionally.  Greater than one will grow it proportionally.</doc:summary>
1035         </doc:doc>
1036       </arg>
1037       <doc:doc>
1038         <doc:description>
1039           <doc:para>Scale the selection relative to it's current size.</doc:para>
1040         </doc:description>
1041       </doc:doc>
1042     </method>
1043
1044     <method name="selection_move">
1045       <arg type="d" name="x" direction="in" >
1046         <doc:doc>
1047           <doc:summary>Amount to move in the x direction.</doc:summary>
1048         </doc:doc>
1049       </arg>
1050       <arg type="d" name="y" direction="in" >
1051         <doc:doc>
1052           <doc:summary>Amount to move in the y direction.</doc:summary>
1053         </doc:doc>
1054       </arg>
1055       <doc:doc>
1056         <doc:description>
1057           <doc:para>This will move the selection relative to it's current location.</doc:para>
1058           <doc:para>This may be accomplished with transformation attributes or by changing x and y attributes depending on the state of the objects in the selection.</doc:para>
1059         </doc:description>
1060         <doc:seealso><doc:ref type="interface" to="Coordinate System">Coordinate System</doc:ref></doc:seealso>
1061       </doc:doc>
1062     </method>
1063
1064     <method name="selection_move_to">
1065       <arg type="d" name="x" direction="in" >
1066         <doc:doc>
1067           <doc:summary>X coordinate to move to.</doc:summary>
1068         </doc:doc>
1069       </arg>
1070       <arg type="d" name="y" direction="in" >
1071         <doc:doc>
1072           <doc:summary>Y coordinate to move to.</doc:summary>
1073         </doc:doc>
1074       </arg>
1075       <doc:doc>
1076         <doc:description>
1077           <doc:para>This will move the center of the selection to a specific location.</doc:para>
1078           <doc:para>This may be accomplished with transformation attributes or by changing x and y attributes depending on the state of the objects in the selection.</doc:para>
1079         </doc:description>
1080         <doc:seealso><doc:ref type="interface" to="Coordinate System">Coordinate System</doc:ref></doc:seealso>
1081       </doc:doc>
1082     </method>
1083
1084     <method name="selection_move_to_layer">
1085       <arg type="s" name="layer" direction="in" >
1086         <doc:doc>
1087           <doc:summary>layer to move the selection to.</doc:summary>
1088         </doc:doc>
1089       </arg>
1090       <doc:doc>
1091         <doc:description>
1092           <doc:para>Move every item in the selection to a different layer.</doc:para>
1093           <doc:para>Will error if layer does not exist.</doc:para>
1094         </doc:description>
1095         <doc:seealso><doc:ref type="interface" to="Layers and Levels">Layers and Levels</doc:ref></doc:seealso>
1096       </doc:doc>
1097     </method>
1098
1099     <method name="selection_get_center">
1100       <arg type="ad" name="centerpoint" direction="out" >
1101         <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value=""/>
1102         <doc:doc>
1103           <doc:summary>Center of the selection.</doc:summary>
1104         </doc:doc>
1105       </arg>
1106       <doc:doc>
1107         <doc:description>
1108           <doc:para>Gets the center of the selections bounding box in X,Y coordinates.</doc:para>
1109         </doc:description>
1110         <doc:seealso><doc:ref type="interface" to="Coordinate System">Coordinate System</doc:ref></doc:seealso>
1111       </doc:doc>
1112     </method>
1113
1114     <method name="selection_to_path" >
1115       <doc:doc>
1116         <doc:description>
1117           <doc:para>Turns all the objects in the selection into paths.</doc:para>
1118         </doc:description>
1119         <doc:seealso><doc:ref type="method" to="document.object_to_path">object_to_path()</doc:ref></doc:seealso>
1120       </doc:doc>
1121     </method>
1122
1123     <method name="selection_combine" >
1124       <arg type="s" name="type" direction="in" >
1125         <doc:doc>
1126           <doc:summary>Type of combination.</doc:summary>
1127         </doc:doc>
1128       </arg>
1129       <arg type="s" name="newpath" direction="out" >
1130         <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value="error"/>
1131         <doc:doc>
1132           <doc:summary>The new path created, if there is one.  NULL otherwise.</doc:summary>
1133         </doc:doc>
1134       </arg>
1135       <doc:doc>
1136         <doc:description>
1137           <doc:para>Will erase all objects in the selection and replace with a single aggregate path.</doc:para>
1138           <doc:para>There are 5 types that can be passed in:</doc:para>
1139           <doc:para>Union: The new shape is all of the other shapes put together, even if they don't overlap (paths can have multiple non-contiguous areas.)</doc:para>
1140           <doc:para>Intersection:  The new shape is composed of the area where ALL the objects in the selection overlap.  If there is no area where all shapes overlap the new shape will be empty.</doc:para>
1141           <doc:para>Difference: The area of the second shape is subtracted from the first, only works with two objects.</doc:para>
1142           <doc:para>Exclusion: The new shape is the area(s) where none of the objects in the selection overlaped.  Only works with two objects.</doc:para>
1143           <doc:para>Division: the first object is split into multiple segments by the second object.  Only works with two objects and if multiple paths result they are grouped and the group id is returned.</doc:para>
1144         </doc:description>
1145       </doc:doc>
1146     </method>
1147
1148     <method name="selection_divide">
1149       <arg type="as" name="pieces" direction="out" >
1150        <!-- <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value=""/> -->
1151         <doc:doc>
1152           <doc:summary>List of the ids of resulting paths.</doc:summary>
1153         </doc:doc>
1154       </arg>
1155       <doc:doc>
1156         <doc:description>
1157           <doc:para>Returns the result of cutting the bottom object by all other intersecting paths.</doc:para>
1158           <doc:para>This may make many seperate layers.</doc:para>
1159         </doc:description>
1160       </doc:doc>
1161     </method>
1162
1163     <method name="selection_change_level" >
1164       <arg type="s" name="command" direction="in" >
1165         <doc:doc>
1166           <doc:summary>How to change the level</doc:summary>
1167         </doc:doc>
1168       </arg>
1169       <arg type="b" name="objectsmoved" direction="out" >
1170         <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value="error"/>
1171         <doc:doc>
1172           <doc:summary>True if the objects changed levels.  False if they don't(if they were already on top when being raised for example.)</doc:summary>
1173         </doc:doc>
1174       </arg>
1175       <doc:doc>
1176         <doc:description>
1177           <doc:para>Will change the level of a selection, respective of other objects in the same layer.  Will not affect the overlap of objects in different layers.  Will do nothing if the selection contains objects in multiple layers.</doc:para>
1178           <doc:para>There are 4 commands that can be passed in:</doc:para>
1179           <doc:para>"raise" or "lower": Move the selection one level up, or one level down.</doc:para>
1180           <doc:para>"to_top" of "to_bottom": Move the selection above all other objects or below all other objects.</doc:para>
1181         </doc:description>
1182       </doc:doc>
1183     </method>
1184
1185     <!-- LAYER FUNCTIONS -->
1186
1187     <method name="layer_new">
1188       <arg type="s" name="layername" direction="out" >
1189         <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value="error"/>
1190         <doc:doc>
1191           <doc:summary>The name of the new layer.</doc:summary>
1192         </doc:doc>
1193       </arg>
1194       <doc:doc>
1195         <doc:description>
1196           <doc:para>Turns all the objects in the selection into paths.</doc:para>
1197         </doc:description>
1198         <doc:seealso><doc:ref type="interface" to="Layers and Levels">Layers and Levels</doc:ref></doc:seealso>
1199       </doc:doc>
1200     </method>
1201
1202     <method name="layer_set">
1203       <arg type="s" name="layer" direction="in" >
1204         <doc:doc>
1205           <doc:summary>The name of any layer.</doc:summary>
1206         </doc:doc>
1207       </arg>
1208       <doc:doc>
1209         <doc:description>
1210           <doc:para>Sets the layer given as the current layer</doc:para>
1211         </doc:description>
1212         <doc:seealso><doc:ref type="interface" to="Layers and Levels">Layers and Levels</doc:ref></doc:seealso>
1213       </doc:doc>
1214     </method>
1215
1216     <method name="layer_get_all">
1217       <arg type="as" name="layers" direction="out" >
1218         <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value=""/>
1219         <doc:doc>
1220           <doc:summary>list of layers.</doc:summary>
1221         </doc:doc>
1222       </arg>
1223       <doc:doc>
1224         <doc:description>
1225           <doc:para>Get a list of all the layers in this document.</doc:para>
1226         </doc:description>
1227         <doc:seealso><doc:ref type="interface" to="Layers and Levels">Layers and Levels</doc:ref></doc:seealso>
1228       </doc:doc>
1229     </method>
1230
1231     <method name="layer_change_level" >
1232       <arg type="s" name="command" direction="in" >
1233         <doc:doc>
1234           <doc:summary>How to change the level</doc:summary>
1235         </doc:doc>
1236       </arg>
1237       <arg type="b" name="layermoved" direction="out" >
1238         <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value="error"/>
1239         <doc:doc>
1240           <doc:summary>True if the layer was moved.  False if it was not (if it was already on top when being raised for example.)</doc:summary>
1241         </doc:doc>
1242       </arg>
1243       <doc:doc>
1244         <doc:description>
1245           <doc:para>Will change the level of a layer, respective of other layers.  Will not affect the relative level of objects within the layer.</doc:para>
1246           <doc:para>There are 4 commands that can be passed in:</doc:para>
1247           <doc:para>"raise" or "lower": Move the layer one level up, or one level down.</doc:para>
1248           <doc:para>"to_top" of "to_bottom": Move the layer above all other layers or below all other layers.</doc:para>
1249         </doc:description>
1250       </doc:doc>
1251     </method>
1252
1253     <method name="layer_next" >
1254       <doc:doc>
1255         <doc:description>
1256           <doc:para>Sets the next (or higher) layer as active.</doc:para>
1257         </doc:description>
1258         <doc:seealso><doc:ref type="interface" to="Layers and Levels">Layers and Levels</doc:ref></doc:seealso>
1259       </doc:doc>
1260     </method>
1261
1262     <method name="layer_previous" >
1263       <doc:doc>
1264         <doc:description>
1265           <doc:para>Sets the previous (or lower) layer as active.</doc:para>
1266         </doc:description>
1267         <doc:seealso><doc:ref type="interface" to="Layers and Levels">Layers and Levels</doc:ref></doc:seealso>
1268       </doc:doc>
1269     </method>
1270
1271
1272   </interface>
1273 </node>