r19336 by gpittman - added documentation for copyObject() and pasteObject()
scribus-commit
scribus-commit at lists.scribus.net
Fri Jul 11 02:23:42 UTC 2014
Author: gpittman
Date: Fri Jul 11 02:23:42 2014
New Revision: 19336
URL: http://scribus.net/websvn/listing.php?repname=Scribus&sc=1&rev=19336
Log:
added documentation for copyObject() and pasteObject()
Modified:
trunk/Scribus/doc/de/scripterapi-manobj.html
trunk/Scribus/doc/en/scripterapi-manobj.html
trunk/Scribus/doc/it/scripterapi-manobj.html
Modified: trunk/Scribus/doc/de/scripterapi-manobj.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=19336&path=/trunk/Scribus/doc/de/scripterapi-manobj.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi-manobj.html (original)
+++ trunk/Scribus/doc/de/scripterapi-manobj.html Fri Jul 11 02:23:42 2014
@@ -8,59 +8,72 @@
<dl>
+<dt><a name="-copyObject"><strong>copyObject</strong>(...)</a></dt>
+<dd><code>copyObject(["name"]) -> string</code>
+<p>copies the selected Object to the clipboard.</p></dd>
+
+<dt><a name="-duplicateObject"><strong>duplicateObject</strong>(...)</a></dt>
+<dd><code>duplicateObject(["name"]) -> string</code>
+<p>creates a Duplicate of the selected Object (or Selection Group).</p></dd>
+
<dt><a name="-groupObjects"><strong>groupObjects</strong></a>(...)</dt>
-<dd><code><a href="#-groupObjects">groupObjects</a>(list)</code>
+<dd><code>groupObjects(list)</code>
<p>Groups the objects named in "list" together. "list" must contain the names of the objects to be grouped. If "list" is not given the currently selected items are used.</p></dd>
<dt><a name="-isLocked"><strong>isLocked</strong></a>(...)</dt>
-<dd><code><a href="#-isLocked">isLocked</a>(["name"]) -> bool</code>
+<dd><code>isLocked(["name"]) -> bool</code>
<p>Returns true if is the object "name" locked. If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-lockObject"><strong>lockObject</strong></a>(...)</dt>
-<dd><code><a href="#-lockObject">lockObject</a>(["name"]) -> bool</code>
+<dd><code>lockObject(["name"]) -> bool</code>
<p>Locks the object "name" if it's unlocked or unlock it if it's locked. If "name" is not given the currently selected item is used. Returns true if locked.</p></dd>
<dt><a name="-moveObject"><strong>moveObject</strong></a>(...)</dt>
-<dd><code><a href="#-moveObject">moveObject</a>(dx, dy [, "name"])</code>
-<p>Moves the object "name" by dx and dy relative to its current position. The distances are expressed in the current measurement unit of the document (see UNIT constants). If "name" is not given the currently selected item is used. If the object "name" belongs to a group, the whole group is moved.</p></dd>
+<dd><code>moveObject(dx, dy [, "name"])</code>
+<p>Moves the object "name" by dx and dy relative to its current position. The distances are expressed in the current measurement unit of the document (see UNIT constants). If "name" is not given the currently selected item is used. If the object "name" belongs to a group, the whole group is moved.</p>
+<p>If what you wish to do is to move an object to a different page or layer, it may be more efficient to do the sequence <em>copyObject(...)</em>, followed by <em>pasteObject(...)</em>, and then finally <em>deleteObject(...)</em> to delete the original.</dd>
<dt><a name="-moveObjectAbs"><strong>moveObjectAbs</strong></a>(...)</dt>
-<dd><code><a href="#-moveObjectAbs">moveObjectAbs</a>(x, y [, "name"])</code>
+<dd><code>moveObjectAbs(x, y [, "name"])</code>
<p>Moves the object "name" to a new location. The coordinates are expressed in the current measurement unit of the document (see UNIT constants). If "name" is not given the currently selected item is used. If the object "name" belongs to a group, the whole group is moved.</p></dd>
+<dt><a name="-pasteObject"><strong>pasteObject</strong>(...)</a></dt>
+<dd><code>pasteObject(["name"]) -> string</code>
+<p>pastes an Object from the clipboard. This will be used only or most sensibly following <em>copyObject(...)</em>, since otherwise there will likely be nothing in the clipboard to paste.</p></dd>
+
<dt><a name="-rotateObject"><strong>rotateObject</strong></a>(...)</dt>
-<dd><code><a href="#-rotateObject">rotateObject</a>(rot [, "name"])</code>
+<dd><code>rotateObject(rot [, "name"])</code>
<p>Rotates the object "name" by "rot" degrees relatively. The object is rotated by the vertex that is currently selected as the rotation point - by default, the top left vertext at zero rotation. Positive values mean counter clockwise rotation when the default rotation point is used. If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-rotateObjectAbs"><strong>rotateObjectAbs</strong></a>(...)</dt>
-<dd><code><a href="#-rotateObjectAbs">rotateObjectAbs</a>(rot [, "name"])</code>
+<dd><code>rotateObjectAbs(rot [, "name"])</code>
<p>Sets the rotation of the object "name" to "rot". Positive values mean counter clockwise rotation. If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-scaleGroup"><strong>scaleGroup</strong></a>(...)</dt>
-<dd><code><a href="#-scaleGroup">scaleGroup</a>(factor [,"name"])</code>
+<dd><code>scaleGroup(factor [,"name"])</code>
<p>Scales the group the object "name" belongs to. Values greater than 1 enlarge the group, values smaller than 1 make the group smaller e.g a value of 0.5 scales the group to 50 % of its original size, a value of 1.5 scales the group to 150 % of its original size. The value for "factor" must be greater than 0. If "name" is not given the currently selected item is used.</p>
<p>May raise ValueError if an invalid scale factor is passed.</p></dd>
<dt><a name="-setScaleImageToFrame"><strong>setScaleImageToFrame</strong></a>(...)</dt>
-<dd><code><a href="#-setScaleImageToFrame">setScaleImageToFrame</a>(scaletoframe, proportional=None, name=<selection>)</code>
+<dd><code>setScaleImageToFrame(scaletoframe, proportional=None, name=<selection>)</code>
<p>Sets the scale to frame on the selected or specified image frame to `scaletoframe'. If `proportional' is specified, set fixed aspect ratio scaling to `proportional'. Both `scaletoframe' and `proportional' are boolean.</p>
<p>May raise WrongFrameTypeError.</p></dd>
<dt><a name="-setStyle"><strong>setStyle</strong></a>(...)</dt>
-<dd><code><a href="#-setStyle">setStyle</a>("style" [, "name"])</code>
-<p>Apply the named "style" to the object named "name". If is no object name given, it's applied on the selected object.</p></dd>
+<dd><code>setStyle("style" [, "name"])</code>
+<p>Apply the named "style" to the object named "name". If object name is given, style is applied to the current text selection in object "name". If no object name is given, style is applied on selected object.</p></dd>
<dt><a name="-sizeObject"><strong>sizeObject</strong></a>(...)</dt>
-<dd><code><a href="#-sizeObject">sizeObject</a>(width, height [, "name"])</code>
+<dd><code>sizeObject(width, height [, "name"])</code>
<p>Resizes the object "name" to the given width and height. If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-unGroupObject"><strong>unGroupObject</strong></a>(...)</dt>
<dd><code>unGroupObjects("name")</code>
<p>Destructs the group the object "name" belongs to.If "name" is not given the currently selected item is used.</p></dd>
-<dt><a name="-textFlowsAroundFrame"><strong>textFlowsAroundFrame</strong></a>(...)</dt>
-<dd><code><a href="#-textFlowsAroundFrame">textFlowsAroundFrame</a>("name" [, state])</code>
-<p>Enables/disables "Text Flows Around Frame" feature for object "name". Called with parameters string name and optional boolean "state". If "state" is not passed, text flow is toggled.</p></dd>
+<dt><a name="-textFlowMode"><strong>textFlowMode</strong>(...)</a></dt>
+<dd><code>textFlowMode("name" [, state])</code>
+<p>Enables/disables "Text Flows Around Frame" feature for object "name". Called with parameters string name and optional int "state" (0 <= state <= 3). Setting "state" to 0 will disable text flow. Setting "state" to 1 will make text flow around object frame. Setting "state" to 2 will make text flow around bounding box. Setting "state" to 3 will make text flow around contour line. If "state" is not passed, text flow is toggled.</p></dd>
</dl>
</body>
Modified: trunk/Scribus/doc/en/scripterapi-manobj.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=19336&path=/trunk/Scribus/doc/en/scripterapi-manobj.html
==============================================================================
--- trunk/Scribus/doc/en/scripterapi-manobj.html (original)
+++ trunk/Scribus/doc/en/scripterapi-manobj.html Fri Jul 11 02:23:42 2014
@@ -3,21 +3,22 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Manipulating Objects</title>
</head>
-<style>
- at import "manual.css";
-</style>
<body>
<h2>Manipulating Objects</h2>
<dl>
+
+<dt><a name="-copyObject"><strong>copyObject</strong>(...)</a></dt>
+<dd><code>copyObject(["name"]) -> string</code>
+<p>copies the selected Object to the clipboard.</p></dd>
<dt><a name="-duplicateObject"><strong>duplicateObject</strong>(...)</a></dt>
<dd><code>duplicateObject(["name"]) -> string</code>
<p>creates a Duplicate of the selected Object (or Selection Group).</p></dd>
<dt><a name="-groupObjects"><strong>groupObjects</strong></a>(...)</dt>
-<dd><code>groupObjects(list) -> string</code>
-<p>Groups the objects named in "list" together. "list" must contain the names of the objects to be grouped. If "list" is not given the currently selected items are used. Returns the group name for further referencing.</p></dd>
+<dd><code>groupObjects(list)</code>
+<p>Groups the objects named in "list" together. "list" must contain the names of the objects to be grouped. If "list" is not given the currently selected items are used.</p></dd>
<dt><a name="-isLocked"><strong>isLocked</strong></a>(...)</dt>
<dd><code>isLocked(["name"]) -> bool</code>
@@ -29,11 +30,16 @@
<dt><a name="-moveObject"><strong>moveObject</strong></a>(...)</dt>
<dd><code>moveObject(dx, dy [, "name"])</code>
-<p>Moves the object "name" by dx and dy relative to its current position. The distances are expressed in the current measurement unit of the document (see UNIT constants). If "name" is not given the currently selected item is used. If the object "name" belongs to a group, the whole group is moved.</p></dd>
+<p>Moves the object "name" by dx and dy relative to its current position. The distances are expressed in the current measurement unit of the document (see UNIT constants). If "name" is not given the currently selected item is used. If the object "name" belongs to a group, the whole group is moved.</p>
+<p>If what you wish to do is to move an object to a different page or layer, it may be more efficient to do the sequence <em>copyObject(...)</em>, followed by <em>pasteObject(...)</em>, and then finally <em>deleteObject(...)</em> to delete the original.</dd>
<dt><a name="-moveObjectAbs"><strong>moveObjectAbs</strong></a>(...)</dt>
<dd><code>moveObjectAbs(x, y [, "name"])</code>
<p>Moves the object "name" to a new location. The coordinates are expressed in the current measurement unit of the document (see UNIT constants). If "name" is not given the currently selected item is used. If the object "name" belongs to a group, the whole group is moved.</p></dd>
+
+<dt><a name="-pasteObject"><strong>pasteObject</strong>(...)</a></dt>
+<dd><code>pasteObject(["name"]) -> string</code>
+<p>pastes an Object from the clipboard. This will be used only or most sensibly following <em>copyObject(...)</em>, since otherwise there will likely be nothing in the clipboard to paste.</p></dd>
<dt><a name="-rotateObject"><strong>rotateObject</strong></a>(...)</dt>
<dd><code>rotateObject(rot [, "name"])</code>
Modified: trunk/Scribus/doc/it/scripterapi-manobj.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=19336&path=/trunk/Scribus/doc/it/scripterapi-manobj.html
==============================================================================
--- trunk/Scribus/doc/it/scripterapi-manobj.html (original)
+++ trunk/Scribus/doc/it/scripterapi-manobj.html Fri Jul 11 02:23:42 2014
@@ -7,6 +7,10 @@
<h2>Manipulating Objects</h2>
<dl>
+
+<dt><a name="-copyObject"><strong>copyObject</strong>(...)</a></dt>
+<dd><code>copyObject(["name"]) -> string</code>
+<p>copies the selected Object to the clipboard.</p></dd>
<dt><a name="-duplicateObject"><strong>duplicateObject</strong>(...)</a></dt>
<dd><code>duplicateObject(["name"]) -> string</code>
@@ -26,11 +30,16 @@
<dt><a name="-moveObject"><strong>moveObject</strong></a>(...)</dt>
<dd><code>moveObject(dx, dy [, "name"])</code>
-<p>Moves the object "name" by dx and dy relative to its current position. The distances are expressed in the current measurement unit of the document (see UNIT constants). If "name" is not given the currently selected item is used. If the object "name" belongs to a group, the whole group is moved.</p></dd>
+<p>Moves the object "name" by dx and dy relative to its current position. The distances are expressed in the current measurement unit of the document (see UNIT constants). If "name" is not given the currently selected item is used. If the object "name" belongs to a group, the whole group is moved.</p>
+<p>If what you wish to do is to move an object to a different page or layer, it may be more efficient to do the sequence <em>copyObject(...)</em>, followed by <em>pasteObject(...)</em>, and then finally <em>deleteObject(...)</em> to delete the original.</dd>
<dt><a name="-moveObjectAbs"><strong>moveObjectAbs</strong></a>(...)</dt>
<dd><code>moveObjectAbs(x, y [, "name"])</code>
<p>Moves the object "name" to a new location. The coordinates are expressed in the current measurement unit of the document (see UNIT constants). If "name" is not given the currently selected item is used. If the object "name" belongs to a group, the whole group is moved.</p></dd>
+
+<dt><a name="-pasteObject"><strong>pasteObject</strong>(...)</a></dt>
+<dd><code>pasteObject(["name"]) -> string</code>
+<p>pastes an Object from the clipboard. This will be used only or most sensibly following <em>copyObject(...)</em>, since otherwise there will likely be nothing in the clipboard to paste.</p></dd>
<dt><a name="-rotateObject"><strong>rotateObject</strong></a>(...)</dt>
<dd><code>rotateObject(rot [, "name"])</code>
More information about the scribus-commit
mailing list