Author: jghali
Date: Sat Nov 17 18:00:37 2018
New Revision: 22758
URL: http://scribus.net/websvn/listing.php?repname=Scribus&sc=1&rev=22758
Log:
Document scripter getObjectAttributes() and setObjectAttributes()
Modified:
trunk/Scribus/doc/de/scripterapi-getobjprop.html
trunk/Scribus/doc/de/scripterapi-setobjprop.html
trunk/Scribus/doc/en/scripterapi-getobjprop.html
trunk/Scribus/doc/en/scripterapi-setobjprop.html
trunk/Scribus/doc/fr/scripterapi-getobjprop.html
trunk/Scribus/doc/fr/scripterapi-setobjprop.html
trunk/Scribus/doc/it/scripterapi-getobjprop.html
trunk/Scribus/doc/it/scripterapi-setobjprop.html
trunk/Scribus/scribus/plugins/scriptplugin/cmdsetprop.h
Modified: trunk/Scribus/doc/de/scripterapi-getobjprop.html
URL:
http://scribus.net/websvn/diff.php?repname=Scribus&rev=22758&path=/trunk/Scribus/doc/de/scripterapi-getobjprop.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi-getobjprop.html (original)
+++ trunk/Scribus/doc/de/scripterapi-getobjprop.html Sat Nov 17 18:00:37 2018
@@ -19,13 +19,17 @@
<dd><code>getCornerRadius(["name"]) -> integer</code>
<p>Returns the corner radius of the object "name". The radius is expressed in
points. If "name" is not given the currently selected item is used.</p></dd>
-<dt><a name="-getFillColor"><strong>getFillColor</strong></a>(...)</dt>
-<dd><code>getFillColor(["name"]) -> string</code>
-<p>Returns the name of the fill color of the object "name". If "name" is not
given the currently selected item is used.</p></dd>
+<dt><a
name="-getCustomLineStyle"><strong>getCustomLineStyle</strong></a>(...)</dt>
+<dd><code>getCustomLineStyle(styleName, ["name"])</code>
+<p>Returns the styleName of custom line style for the object. If object's
"name" is not given the currently selected item is used.</p></dd>
<dt><a name="-getFillBlendmode"><strong>getFillBlendmode</strong>(...)</a></dt>
<dd><code>getFillBlendmode(["name"]) -> integer</code>
<p>Returns the fill blendmode of the object "name". If "name" is not given the
currently selected Item is used.</p></dd>
+
+<dt><a name="-getFillColor"><strong>getFillColor</strong></a>(...)</dt>
+<dd><code>getFillColor(["name"]) -> string</code>
+<p>Returns the name of the fill color of the object "name". If "name" is not
given the currently selected item is used.</p></dd>
<dt><a name="-getFillShade"><strong>getFillShade</strong></a>(...)</dt>
<dd><code>getFillShade(["name"]) -> integer</code>
@@ -36,7 +40,7 @@
<p>Returns the fill transparency of the object "name". If "name" is not given
the currently selected Item is used.</p></dd>
<dt><a name="-getImageFile"><strong>getImageFile</strong></a>(...)</dt>
-<dd><code>getImageName(["name"]) -> string</code>
+<dd><code>getImageFile(["name"]) -> string</code>
<p>Returns the filename for the image in the image frame. If "name" is not
given the currently selected item is used.</p></dd>
<dt><a name="-getImageScale"><strong>getImageScale</strong></a>(...)</dt>
@@ -74,6 +78,10 @@
<dt><a name="-getLineWidth"><strong>getLineWidth</strong></a>(...)</dt>
<dd><code>getLineWidth(["name"]) -> integer</code>
<p>Returns the line width of the object "name". If "name" is not given the
currently selected Item is used.</p></dd>
+
+<dt><a
name="-getObjectAttributes"><strong>getObjectAttributes</strong></a>(...)</dt>
+<dd><code>getObjectAttributes(["name"]) -> list</code>
+<p>Returns a list containing all attributes of object "name". If "name" is not
given the currently selected Item is used.</p></dd>
<dt><a name="-getPosition"><strong>getPosition</strong></a>(...)</dt>
<dd><code>getPosition(["name"]) -> (x,y)</code>
Modified: trunk/Scribus/doc/de/scripterapi-setobjprop.html
URL:
http://scribus.net/websvn/diff.php?repname=Scribus&rev=22758&path=/trunk/Scribus/doc/de/scripterapi-setobjprop.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi-setobjprop.html (original)
+++ trunk/Scribus/doc/de/scripterapi-setobjprop.html Sat Nov 17 18:00:37 2018
@@ -18,15 +18,19 @@
<p>Loads the picture "picture" into the image frame "name". If "name" is not
given the currently selected item is used.</p>
<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the
target frame is not an image frame</p></dd></dt>
+<dt><a name="-setCornerRadius"><strong>setCornerRadius</strong></a>(...)</dt>
+<dd><code>setCornerRadius(radius, ["name"])</code>
+<p>Sets the corner radius of the object "name". The radius is expressed in
points regardless of page units, and must be an integer. If "name" is not given
the currently selected item is used.</p>
+<p>May raise ValueError if the corner radius is negative.</p></dd>
+
+<dt><a
name="-setCustomLineStyle"><strong>setCustomLineStyle</strong></a>(...)</dt>
+<dd><code>setCustomLineStyle(styleName, ["name"])</code>
+<p>Sets the custom line style of the object "name" to "styleName". Argument
"styleName" is the name of line style as seen in Style Manager. If "name" is
not given the currently selected item is used.</p></dd>
+
<dt><a name="-setFillBlendmode"><strong>setFillBlendmode</strong>(...)</a></dt>
<dd><code>setFillBlendmode(blendmode, ["name"])</code>
<p>Sets the fill blendmode of the object "name" to blendmode is the name of
one of the defined colors. If "name" is not given the currently selected item
is used.</p></dd>
-<dt><a name="-setCornerRadius"><strong>setCornerRadius</strong></a>(...)</dt>
-<dd><code>setCornerRadius(radius, ["name"])</code>
-<p>Sets the corner radius of the object "name". The radius is expressed in
points. If "name" is not given the currently selected item is used.</p>
-<p>May raise ValueError if the corner radius is negative.</p></dd>
-
<dt><a name="-setFillColor"><strong>setFillColor</strong></a>(...)</dt>
<dd><code>setFillColor("color", ["name"])</code>
<p>Sets the fill color of the object "name" to the color "color". "color" is
the name of one of the defined colors. If "name" is not given the currently
selected item is used.</p></dd>
@@ -38,7 +42,7 @@
<dt><a
name="-setFillTransparency"><strong>setFillTransparency</strong>(...)</a></dt>
<dd><code>setFillTransparency(transparency, ["name"])</code>
-<p>Sets the fill transparency of the object "name" to transparency is the name
of one of the defined colors. If "name" is not given the currently selected
item is used.</p></dd>
+<p>Sets the fill transparency of the object "name". If "name" is not given the
currently selected item is used. In spite of this command's wording, the
"transparency" value is actually a decimal corresponding to the
<strong>opacity</strong>, so for example, 0.9 = 90% opacity, 0.2 = 20%
opacity.</p></dd>
<dt><a name="-setLineBlendmode"><strong>setLineBlendmode</strong>(...)</a></dt>
<dd><code>setLineBlendmode(blendmode, ["name"])</code>
@@ -46,7 +50,7 @@
<dt><a
name="-setLineTransparency"><strong>setLineTransparency</strong>(...)</a></dt>
<dd><code>setLineTransparency(transparency, ["name"])</code>
-<p>Sets the line transparency of the object "name" to transparency is the name
of one of the defined colors. If "name" is not given the currently selected
item is used.</p></dd>
+<p>Sets the line transparency of the object "name". If "name" is not given the
currently selected item is used. In spite of this command's wording, the
"transparency" value is actually a decimal corresponding to the
<strong>opacity</strong>, so for example, 0.9 = 90% opacity, 0.2 = 20%
opacity.</p></dd>
<dt><a name="-setGradientFill"><strong>setGradientFill</strong></a>(...)</dt>
<dd><code>setGradientFill(type, "color1", shade1, "color2", shade2,
["name"])</code>
@@ -101,6 +105,11 @@
<p>Sets the position of the picture in the image frame "name". If "name" is
not given the currently selected item is used. The specified offset values are
equal to the values shown on properties palette when point unit is used.</p>
<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the
target frame is not an image frame</p></dd>
+<dt><a
name="-setObjectAttributes"><strong>setObjectAttributes</strong></a>(...)</dt>
+<dd><code>setObjectAttributes(attributes, ["name"])</code>
+<p>Sets attributes of the object "name". If "name" is not given the currently
selected item is used.</p>
+<p>attributes is a list of dictionary. Each dictionary must have those keys:
Name, Type, Value, Parameter, Relationship, RelationshipTo, AutoAddTo. All
values must be strings.</p></dd>
+
<dt><a name="-traceText"><strong>traceText</strong></a>(...)</dt>
<dd><code>traceText(["name"])</code>
<p>Convert the text frame "name" to outlines. If "name" is not given the
currently selected item is used.</p></dd>
Modified: trunk/Scribus/doc/en/scripterapi-getobjprop.html
URL:
http://scribus.net/websvn/diff.php?repname=Scribus&rev=22758&path=/trunk/Scribus/doc/en/scripterapi-getobjprop.html
==============================================================================
--- trunk/Scribus/doc/en/scripterapi-getobjprop.html (original)
+++ trunk/Scribus/doc/en/scripterapi-getobjprop.html Sat Nov 17 18:00:37 2018
@@ -78,6 +78,10 @@
<dt><a name="-getLineWidth"><strong>getLineWidth</strong></a>(...)</dt>
<dd><code>getLineWidth(["name"]) -> integer</code>
<p>Returns the line width of the object "name". If "name" is not given the
currently selected Item is used.</p></dd>
+
+<dt><a
name="-getObjectAttributes"><strong>getObjectAttributes</strong></a>(...)</dt>
+<dd><code>getObjectAttributes(["name"]) -> list</code>
+<p>Returns a list containing all attributes of object "name". If "name" is not
given the currently selected Item is used.</p></dd>
<dt><a name="-getPosition"><strong>getPosition</strong></a>(...)</dt>
<dd><code>getPosition(["name"]) -> (x,y)</code>
Modified: trunk/Scribus/doc/en/scripterapi-setobjprop.html
URL:
http://scribus.net/websvn/diff.php?repname=Scribus&rev=22758&path=/trunk/Scribus/doc/en/scripterapi-setobjprop.html
==============================================================================
--- trunk/Scribus/doc/en/scripterapi-setobjprop.html (original)
+++ trunk/Scribus/doc/en/scripterapi-setobjprop.html Sat Nov 17 18:00:37 2018
@@ -105,6 +105,11 @@
<p>Sets the position of the picture in the image frame "name". If "name" is
not given the currently selected item is used. The specified offset values are
equal to the values shown on properties palette when point unit is used.</p>
<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the
target frame is not an image frame</p></dd>
+<dt><a
name="-setObjectAttributes"><strong>setObjectAttributes</strong></a>(...)</dt>
+<dd><code>setObjectAttributes(attributes, ["name"])</code>
+<p>Sets attributes of the object "name". If "name" is not given the currently
selected item is used.</p>
+<p>attributes is a list of dictionary. Each dictionary must have those keys:
Name, Type, Value, Parameter, Relationship, RelationshipTo, AutoAddTo. All
values must be strings.</p></dd>
+
<dt><a name="-traceText"><strong>traceText</strong></a>(...)</dt>
<dd><code>traceText(["name"])</code>
<p>Convert the text frame "name" to outlines. If "name" is not given the
currently selected item is used.</p></dd>
Modified: trunk/Scribus/doc/fr/scripterapi-getobjprop.html
URL:
http://scribus.net/websvn/diff.php?repname=Scribus&rev=22758&path=/trunk/Scribus/doc/fr/scripterapi-getobjprop.html
==============================================================================
--- trunk/Scribus/doc/fr/scripterapi-getobjprop.html (original)
+++ trunk/Scribus/doc/fr/scripterapi-getobjprop.html Sat Nov 17 18:00:37 2018
@@ -38,7 +38,7 @@
<dt><a name="-getLineCap"><strong>getLineCap</strong></a>(...)</dt>
<dd><code>getLineEnd(["nom"]) -> nombre entier (voir les constantes)</code>
-<p>Retourne le style de bout de ligne de l'objet "nom". Si "nom" n'est pas
fourni, l'élément sélectionnéest utilisé.
+<p>Retourne le style de bout de ligne de l'objet "nom". Si "nom" n'est pas
fourni, l'élément sélectionné est utilisé.
Les types de bout de ligne sont: CAP_FLAT, CAP_ROUND,
CAP_SQUARE</p></dd>
@@ -49,7 +49,7 @@
<dt><a name="-getLineJoin"><strong>getLineJoin</strong></a>(...)</dt>
<dd><code><a href="#-getLineJoin">getLineJoin</a>(["nom"]) -> nombre entier
(voir les constantes)</code>
-<p>Retourne le style de jointure de filet de l'objet "nom". Si "nom" n'est pas
fourni, l'élément sélectionnéest utilisé. T
+<p>Retourne le style de jointure de filet de l'objet "nom". Si "nom" n'est pas
fourni, l'élément sélectionné est utilisé. T
Les types de jointure sont: JOIN_BEVEL, JOIN_MITTER, JOIN_ROUND</p></dd>
<dt><a name="-getLineShade"><strong>getLineShade</strong></a>(...)</dt>
@@ -60,16 +60,20 @@
<dt><a name="-getLineStyle"><strong>getLineStyle</strong></a>(...)</dt>
<dd><code><a href="#-getLineStyle">getLineStyle</a>(["nom"]) ->
nombre entier (voir les constantes)</code>
-<p>Retourne le style de filet de l'objet "nom". Si "nom" n'est pas fourni,
l'élément sélectionnéest utilisé. Les
constantes de style de filet sont: LINE_DASH, LINE_DASHDOT, LINE_DASHDOTDOT,
LINE_DOT, LINE_SOLID</p></dd>
+<p>Retourne le style de filet de l'objet "nom". Si "nom" n'est pas fourni,
l'élément sélectionné est utilisé. Les
constantes de style de filet sont: LINE_DASH, LINE_DASHDOT, LINE_DASHDOTDOT,
LINE_DOT, LINE_SOLID</p></dd>
<dt><a name="-getLineWidth"><strong>getLineWidth</strong></a>(...)</dt>
<dd><code><a href="#-getLineWidth">getLineWidth</a>(["nom"]) ->
nombre entier</code>
<p>Retourne la largeur de filet de l'objet "nom". Si "nom" n'est pas fourni,
l'élément sélectionné est utilisé. </p></dd>
-
+
+<dt><a
name="-getObjectAttributes"><strong>getObjectAttributes</strong></a>(...)</dt>
+<dd><code>getObjectAttributes(["nom"]) -> liste</code>
+<p>Retourne une liste contenant les attributs de l'objet "nom". Si "nom" n'est
pas fourni, l'élément sélectionné est
utilisé.</p></dd>
+
<dt><a name="-getPosition"><strong>getPosition</strong></a>(...)</dt>
<dd><code><a href="#-getPosition">getPosition</a>(["nom"]) -> (x,y)</code>
-<p>Retourne un vecteur (x, y) indiquant la position de l'objet "nom". Si "nom"
n'est pas fourni, l'élément sélectionnéest
utilisé.
+<p>Retourne un vecteur (x, y) indiquant la position de l'objet "nom". Si "nom"
n'est pas fourni, l'élément sélectionné est
utilisé.
La position est exprimée dans les unités de mesure courantes du
document - voir UNIT_<type> pour référence.</p></dd>
<dt><a name="-getRotation"><strong>getRotation</strong></a>(...)</dt>
@@ -78,7 +82,7 @@
<dt><a name="-getSize"><strong>getSize</strong></a>(...)</dt>
<dd><code><a href="#-getSize">getSize</a>(["nom"]) -> (largeur,
hauteur)</code>
-<p>Retourne un vecteur (largeur, hauteur) décrivant la taille de
l'objet "nom". Si "nom" n'est pas fourni, l'élément
sélectionnéest utilisé.
+<p>Retourne un vecteur (largeur, hauteur) décrivant la taille de
l'objet "nom". Si "nom" n'est pas fourni, l'élément
sélectionné est utilisé.
La taille est exprimée dans les unité de mesure courantes du
document - voir UNIT_<type> pour référence.</p></dd>
Modified: trunk/Scribus/doc/fr/scripterapi-setobjprop.html
URL:
http://scribus.net/websvn/diff.php?repname=Scribus&rev=22758&path=/trunk/Scribus/doc/fr/scripterapi-setobjprop.html
==============================================================================
--- trunk/Scribus/doc/fr/scripterapi-setobjprop.html (original)
+++ trunk/Scribus/doc/fr/scripterapi-setobjprop.html Sat Nov 17 18:00:37 2018
@@ -24,7 +24,7 @@
<p>Peut générer <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> si le cadre
cible n'est pas un cadre d'image</p></dd>
<dt><a name="-setImageScale"><strong>setImageScale</strong></a>(...)</dt>
-<dd><code><a href="#-setImageScale">setImageScale</a>(x, y [, "nom"])</code>
+<dd><code><a href="#-setImageScale">setImageScale</a>(x, y [, "nom"])</code>
<p>Définit les facteurs de redimensionnement de l'image dans le cadre
d'image "nom". Si le "nom" n'est pas fourni, l'élément
sélectionné est utilisé. Un nombre de 1 signifie 100 %.
Les facteurs de redimensionnement sont égaux aux valeurs
indiquées dans la palette des propriétés.</p>
<p>Peut générer <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> si le cadre
cible n'est pas un cadre d'image</p></dd>
@@ -94,6 +94,11 @@
exprimée en points. Si le "nom" n'est pas fourni,
l'élément sélectionné est utilisé. </p>
<p>Peut générer ValueError si l'épaisseur de filet est
hors limites.</p></dd>
+<dt><a
name="-setObjectAttributes"><strong>setObjectAttributes</strong></a>(...)</dt>
+<dd><code>setObjectAttributes(attributs, ["nom"])</code>
+<p>Définit les attributes de l'objet "nom". Si le "nom" n'est pas
fourni, l'élément sélectionné est
utilisé.</p>
+<p>L'argument "attributs" est une liste de dictionnaires. Chaque dictionnaire
doit définir les clés suivantes: Name, Type, Value, Parameter,
Relationship, RelationshipTo, AutoAddTo. Chacune de ces valeurs doit être du
type chaîne de caractère.</p></dd>
+
<dt><a name="-traceText"><strong>traceText</strong></a>(...)</dt>
<dd><code><a href="#-traceText">traceText</a>(["nom"])</code>
<p>Convertit le cadre de texte "nom" en contours. Si le "nom" n'est pas
fourni, l'élément sélectionné est utilisé.
</p></dd>
Modified: trunk/Scribus/doc/it/scripterapi-getobjprop.html
URL:
http://scribus.net/websvn/diff.php?repname=Scribus&rev=22758&path=/trunk/Scribus/doc/it/scripterapi-getobjprop.html
==============================================================================
--- trunk/Scribus/doc/it/scripterapi-getobjprop.html (original)
+++ trunk/Scribus/doc/it/scripterapi-getobjprop.html Sat Nov 17 18:00:37 2018
@@ -1,89 +1,100 @@
-<html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
- <title>Getting Object Properties</title>
-</head>
-<body>
-<h2>Getting Object Properties</h2>
-
-<dl>
-
-<dt><a name="-getObjectType"><strong>getObjectType</strong></a>(...)</dt>
-<dd><code>getObjectType(["name"]) -> string</code>
-<p>Get type of object "name" as a string. If "name" is not given the currently
selected item is used.</p></dd>
-
-<dt><a name="-getCornerRadius"><strong>getCornerRadius</strong></a>(...)</dt>
-<dd><code>getCornerRadius(["name"]) -> integer</code>
-<p>Returns the corner radius of the object "name". The radius is expressed in
points. If "name" is not given the currently selected item is used.</p></dd>
-
-<dt><a name="-getFillColor"><strong>getFillColor</strong></a>(...)</dt>
-<dd><code>getFillColor(["name"]) -> string</code>
-<p>Returns the name of the fill color of the object "name". If "name" is not
given the currently selected item is used.</p></dd>
-
-<dt><a name="-getFillBlendmode"><strong>getFillBlendmode</strong>(...)</a></dt>
-<dd><code>getFillBlendmode(["name"]) -> integer</code>
-<p>Returns the fill blendmode of the object "name". If "name" is not given the
currently selected Item is used.</p></dd>
-
-<dt><a name="-getFillShade"><strong>getFillShade</strong></a>(...)</dt>
-<dd><code>getFillShade(["name"]) -> integer</code>
-<p>Returns the shading value of the fill color of the object "name". If "name"
is not given the currently selected item is used.</p></dd>
-
-<dt><a
name="-getFillTransparency"><strong>getFillTransparency</strong>(...)</a></dt>
-<dd><code>getFillTransparency(["name"]) -> float</code>
-<p>Returns the fill transparency of the object "name". If "name" is not given
the currently selected Item is used.</p></dd>
-
-<dt><a name="-getImageFile"><strong>getImageFile</strong></a>(...)</dt>
-<dd><code>getImageName(["name"]) -> string</code>
-<p>Returns the filename for the image in the image frame. If "name" is not
given the currently selected item is used.</p></dd>
-
-<dt><a name="-getImageScale"><strong>getImageScale</strong></a>(...)</dt>
-<dd><code>getImageScale(["name"]) -> (x,y)</code>
-<p>Returns a (x, y) tuple containing the scaling values of the image frame
"name". If "name" is not given the currently selected item is used.</p></dd>
-
-<dt><a name="-getLineBlendmode"><strong>getLineBlendmode</strong>(...)</a></dt>
-<dd><code>getLineBlendmode(["name"]) -> integer</code>
-<p>Returns the line blendmode of the object "name". If "name" is not given the
currently selected Item is used.</p></dd>
-
-<dt><a name="-getLineCap"><strong>getLineCap</strong></a>(...)</dt>
-<dd><code>getLineEnd(["name"]) -> integer (see constants)</code>
-<p>Returns the line cap style of the object "name". If "name" is not given the
currently selected item is used. The cap types are: CAP_FLAT, CAP_ROUND,
CAP_SQUARE</p></dd>
-
-<dt><a name="-getLineColor"><strong>getLineColor</strong></a>(...)</dt>
-<dd><code>getLineColor(["name"]) -> string</code>
-<p>Returns the name of the line color of the object "name". If "name" is not
given the currently selected item is used.</p></dd>
-
-<dt><a name="-getLineJoin"><strong>getLineJoin</strong></a>(...)</dt>
-<dd><code>getLineJoin(["name"]) -> integer (see contants)</code>
-<p>Returns the line join style of the object "name". If "name" is not given
the currently selected item is used. The join types are: JOIN_BEVEL,
JOIN_MITTER, JOIN_ROUND</p></dd>
-
-<dt><a name="-getLineShade"><strong>getLineShade</strong></a>(...)</dt>
-<dd><code>getLineShade(["name"]) -> integer</code>
-<p>Returns the shading value of the line color of the object "name". If "name"
is not given the currently selected item is used.</p></dd>
-
-<dt><a name="-getLineStyle"><strong>getLineStyle</strong></a>(...)</dt>
-<dd><code>getLineStyle(["name"]) -> integer (see constants)</code>
-<p>Returns the line style of the object "name". If "name" is not given the
currently selected item is used. Line style constants are: LINE_DASH,
LINE_DASHDOT, LINE_DASHDOTDOT, LINE_DOT, LINE_SOLID</p></dd>
-
-<dt><a
name="-getLineTransparency"><strong>getLineTransparency</strong>(...)</a></dt>
-<dd><code>getLineTransparency(["name"]) -> float</code>
-<p>Returns the line transparency of the object "name". If "name" is not given
the currently selected Item is used.</p></dd>
-
-<dt><a name="-getLineWidth"><strong>getLineWidth</strong></a>(...)</dt>
-<dd><code>getLineWidth(["name"]) -> integer</code>
-<p>Returns the line width of the object "name". If "name" is not given the
currently selected Item is used.</p></dd>
-
-<dt><a name="-getPosition"><strong>getPosition</strong></a>(...)</dt>
-<dd><code>getPosition(["name"]) -> (x,y)</code>
-<p>Returns a (x, y) tuple with the position of the object "name". If "name" is
not given the currently selected item is used. The position is expressed in the
actual measurement unit of the document - see UNIT_<type> for
reference.</p></dd>
-
-<dt><a name="-getRotation"><strong>getRotation</strong></a>(...)</dt>
-<dd><code>getRotation(["name"]) -> integer</code>
-<p>Returns the rotation of the object "name". The value is expressed in
degrees, and clockwise is positive. If "name" is not given the currently
selected item is used.</p></dd>
-
-<dt><a name="-getSize"><strong>getSize</strong></a>(...)</dt>
-<dd><code>getSize(["name"]) -> (width,height)</code>
-<p>Returns a (width, height) tuple with the size of the object "name". If
"name" is not given the currently selected item is used. The size is expressed
in the current measurement unit of the document - see UNIT_<type> for
reference.</p></dd>
-
-</dl>
-</body>
-</html>
+<html>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+ <title>Getting Object Properties</title>
+</head>
+<style>
+@import "manual.css";
+</style>
+<body>
+<h2>Getting Object Properties</h2>
+
+<dl>
+
+<dt><a name="-getObjectType"><strong>getObjectType</strong></a>(...)</dt>
+<dd><code>getObjectType(["name"]) -> string</code>
+<p>Get type of object "name" as a string. If "name" is not given the currently
selected item is used.</p></dd>
+
+<dt><a name="-getCornerRadius"><strong>getCornerRadius</strong></a>(...)</dt>
+<dd><code>getCornerRadius(["name"]) -> integer</code>
+<p>Returns the corner radius of the object "name". The radius is expressed in
points. If "name" is not given the currently selected item is used.</p></dd>
+
+<dt><a
name="-getCustomLineStyle"><strong>getCustomLineStyle</strong></a>(...)</dt>
+<dd><code>getCustomLineStyle(styleName, ["name"])</code>
+<p>Returns the styleName of custom line style for the object. If object's
"name" is not given the currently selected item is used.</p></dd>
+
+<dt><a name="-getFillBlendmode"><strong>getFillBlendmode</strong>(...)</a></dt>
+<dd><code>getFillBlendmode(["name"]) -> integer</code>
+<p>Returns the fill blendmode of the object "name". If "name" is not given the
currently selected Item is used.</p></dd>
+
+<dt><a name="-getFillColor"><strong>getFillColor</strong></a>(...)</dt>
+<dd><code>getFillColor(["name"]) -> string</code>
+<p>Returns the name of the fill color of the object "name". If "name" is not
given the currently selected item is used.</p></dd>
+
+<dt><a name="-getFillShade"><strong>getFillShade</strong></a>(...)</dt>
+<dd><code>getFillShade(["name"]) -> integer</code>
+<p>Returns the shading value of the fill color of the object "name". If "name"
is not given the currently selected item is used.</p></dd>
+
+<dt><a
name="-getFillTransparency"><strong>getFillTransparency</strong>(...)</a></dt>
+<dd><code>getFillTransparency(["name"]) -> float</code>
+<p>Returns the fill transparency of the object "name". If "name" is not given
the currently selected Item is used.</p></dd>
+
+<dt><a name="-getImageFile"><strong>getImageFile</strong></a>(...)</dt>
+<dd><code>getImageFile(["name"]) -> string</code>
+<p>Returns the filename for the image in the image frame. If "name" is not
given the currently selected item is used.</p></dd>
+
+<dt><a name="-getImageScale"><strong>getImageScale</strong></a>(...)</dt>
+<dd><code>getImageScale(["name"]) -> (x,y)</code>
+<p>Returns a (x, y) tuple containing the scaling values of the image frame
"name". If "name" is not given the currently selected item is used.</p></dd>
+
+<dt><a name="-getLineBlendmode"><strong>getLineBlendmode</strong>(...)</a></dt>
+<dd><code>getLineBlendmode(["name"]) -> integer</code>
+<p>Returns the line blendmode of the object "name". If "name" is not given the
currently selected Item is used.</p></dd>
+
+<dt><a name="-getLineCap"><strong>getLineCap</strong></a>(...)</dt>
+<dd><code>getLineEnd(["name"]) -> integer (see constants)</code>
+<p>Returns the line cap style of the object "name". If "name" is not given the
currently selected item is used. The cap types are: CAP_FLAT, CAP_ROUND,
CAP_SQUARE</p></dd>
+
+<dt><a name="-getLineColor"><strong>getLineColor</strong></a>(...)</dt>
+<dd><code>getLineColor(["name"]) -> string</code>
+<p>Returns the name of the line color of the object "name". If "name" is not
given the currently selected item is used.</p></dd>
+
+<dt><a name="-getLineJoin"><strong>getLineJoin</strong></a>(...)</dt>
+<dd><code>getLineJoin(["name"]) -> integer (see contants)</code>
+<p>Returns the line join style of the object "name". If "name" is not given
the currently selected item is used. The join types are: JOIN_BEVEL,
JOIN_MITTER, JOIN_ROUND</p></dd>
+
+<dt><a name="-getLineShade"><strong>getLineShade</strong></a>(...)</dt>
+<dd><code>getLineShade(["name"]) -> integer</code>
+<p>Returns the shading value of the line color of the object "name". If "name"
is not given the currently selected item is used.</p></dd>
+
+<dt><a name="-getLineStyle"><strong>getLineStyle</strong></a>(...)</dt>
+<dd><code>getLineStyle(["name"]) -> integer (see constants)</code>
+<p>Returns the line style of the object "name". If "name" is not given the
currently selected item is used. Line style constants are: LINE_DASH,
LINE_DASHDOT, LINE_DASHDOTDOT, LINE_DOT, LINE_SOLID</p></dd>
+
+<dt><a
name="-getLineTransparency"><strong>getLineTransparency</strong>(...)</a></dt>
+<dd><code>getLineTransparency(["name"]) -> float</code>
+<p>Returns the line transparency of the object "name". If "name" is not given
the currently selected Item is used.</p></dd>
+
+<dt><a name="-getLineWidth"><strong>getLineWidth</strong></a>(...)</dt>
+<dd><code>getLineWidth(["name"]) -> integer</code>
+<p>Returns the line width of the object "name". If "name" is not given the
currently selected Item is used.</p></dd>
+
+<dt><a
name="-getObjectAttributes"><strong>getObjectAttributes</strong></a>(...)</dt>
+<dd><code>getObjectAttributes(["name"]) -> list</code>
+<p>Returns a list containing all attributes of object "name". If "name" is not
given the currently selected Item is used.</p></dd>
+
+<dt><a name="-getPosition"><strong>getPosition</strong></a>(...)</dt>
+<dd><code>getPosition(["name"]) -> (x,y)</code>
+<p>Returns a (x, y) tuple with the position of the object "name". If "name" is
not given the currently selected item is used. The position is expressed in the
actual measurement unit of the document - see UNIT_<type> for
reference.</p></dd>
+
+<dt><a name="-getRotation"><strong>getRotation</strong></a>(...)</dt>
+<dd><code>getRotation(["name"]) -> integer</code>
+<p>Returns the rotation of the object "name". The value is expressed in
degrees, and clockwise is positive. If "name" is not given the currently
selected item is used.</p></dd>
+
+<dt><a name="-getSize"><strong>getSize</strong></a>(...)</dt>
+<dd><code>getSize(["name"]) -> (width,height)</code>
+<p>Returns a (width, height) tuple with the size of the object "name". If
"name" is not given the currently selected item is used. The size is expressed
in the current measurement unit of the document - see UNIT_<type> for
reference.</p></dd>
+
+</dl>
+</body>
+</html>
Modified: trunk/Scribus/doc/it/scripterapi-setobjprop.html
URL:
http://scribus.net/websvn/diff.php?repname=Scribus&rev=22758&path=/trunk/Scribus/doc/it/scripterapi-setobjprop.html
==============================================================================
--- trunk/Scribus/doc/it/scripterapi-setobjprop.html (original)
+++ trunk/Scribus/doc/it/scripterapi-setobjprop.html Sat Nov 17 18:00:37 2018
@@ -1,116 +1,124 @@
-<html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
- <title>Setting Object Properties</title>
-</head>
-<body>
-<h2>Setting Object Properties</h2>
-
-<dl>
-
-<dt><a name="-linkTextFrames"><strong>linkTextFrames</strong></a>(...)</dt>
-<dd><code>linkTextFrames("fromname", "toname")</code>
-<p>Link two text frames. The frame named "fromname" is linked to the frame
named "toname". The target frame must be an empty text frame and must not link
to or be linked from any other frames already.</p>
-<p>May throw <a href="#ScribusException">ScribusException</a> if linking rules
are violated.</p></dd>
-
-<dt><a name="-loadImage"><strong>loadImage</strong></a>(...)</dt>
-<dd><code>loadImage("filename" [, "name"])</code>
-<p>Loads the picture "picture" into the image frame "name". If "name" is not
given the currently selected item is used.</p>
-<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the
target frame is not an image frame</p></dd></dt>
-
-<dt><a name="-setFillBlendmode"><strong>setFillBlendmode</strong>(...)</a></dt>
-<dd><code>setFillBlendmode(blendmode, ["name"])</code>
-<p>Sets the fill blendmode of the object "name" to blendmode is the name of
one of the defined colors. If "name" is not given the currently selected item
is used.</p></dd>
-
-<dt><a name="-setCornerRadius"><strong>setCornerRadius</strong></a>(...)</dt>
-<dd><code>setCornerRadius(radius, ["name"])</code>
-<p>Sets the corner radius of the object "name". The radius is expressed in
points. If "name" is not given the currently selected item is used.</p>
-<p>May raise ValueError if the corner radius is negative.</p></dd>
-
-<dt><a name="-setFillColor"><strong>setFillColor</strong></a>(...)</dt>
-<dd><code>setFillColor("color", ["name"])</code>
-<p>Sets the fill color of the object "name" to the color "color". "color" is
the name of one of the defined colors. If "name" is not given the currently
selected item is used.</p></dd>
-
-<dt><a name="-setFillShade"><strong>setFillShade</strong></a>(...)</dt>
-<dd><code>setFillShade(shade, ["name"])</code>
-<p>Sets the shading of the fill color of the object "name" to "shade". "shade"
must be an integer value in the range from 0 (lightest) to 100 (full Color
intensity). If "name" is not given the currently selected Item is used.<p>
-<p>May raise ValueError if the fill shade is out of bounds.</p></dd>
-
-<dt><a
name="-setFillTransparency"><strong>setFillTransparency</strong>(...)</a></dt>
-<dd><code>setFillTransparency(transparency, ["name"])</code>
-<p>Sets the fill transparency of the object "name" to transparency is the name
of one of the defined colors. If "name" is not given the currently selected
item is used.</p></dd>
-
-<dt><a name="-setLineBlendmode"><strong>setLineBlendmode</strong>(...)</a></dt>
-<dd><code>setLineBlendmode(blendmode, ["name"])</code>
-<p>Sets the line blendmode of the object "name" to blendmode is the name of
one of the defined colors. If "name" is not given the currently selected item
is used.</p></dd>
-
-<dt><a
name="-setLineTransparency"><strong>setLineTransparency</strong>(...)</a></dt>
-<dd><code>setLineTransparency(transparency, ["name"])</code>
-<p>Sets the line transparency of the object "name" to transparency is the name
of one of the defined colors. If "name" is not given the currently selected
item is used.</p></dd>
-
-<dt><a name="-setGradientFill"><strong>setGradientFill</strong></a>(...)</dt>
-<dd><code>setGradientFill(type, "color1", shade1, "color2", shade2,
["name"])</code>
-<p>Sets the gradient fill of the object "name" to type. Color descriptions are
the same as for <a href="#-setFillColor">setFillColor</a>() and <a
href="#-setFillShade">setFillShade</a>(). See the constants for available types
(FILL_<type>).</p></dd>
-
-<dt><a name="-setGradientStop"><strong>setGradientStop</strong></a>(...)</dt>
-<dd><code>setGradientStop("color", shade, opacity, ramppoint, ["name"])</code>
-<p>Set or add a gradient stop to the gradient fill of the object \"name\" at
position ramppoint. Color descriptions are the same as for <a
href="#-setFillColor">setFillColor</a>() and <a
href="#-setFillShade">setFillShade</a>(). setGradientFill() must have been
called previously for the gradient fill to be visible.</p></dd>
-
-<dt><a name="-setLineCap"><strong>setLineCap</strong></a>(...)</dt>
-<dd><code>setLineCap(captype, ["name"])</code>
-<p>Sets the line cap style of the object "name" to the style "cap". If "name"
is not given the currently selected item is used. There are predefined
constants for "cap" - CAP_<type>.</p></dd>
-
-<dt><a name="-setLineColor"><strong>setLineColor</strong></a>(...)</dt>
-<dd><code>setLineColor("color", ["name"])</code>
-<p>Sets the line color of the object "name" to the color "color". If "name" is
not given the currently selected item is used.</p></dd>
-
-<dt><a name="-setMultiLine"><strong>setMultiLine</strong></a>(...)</dt>
-<dd><code>setMultiLine("namedStyle", ["name"])</code>
-<p>Sets the line style of the object "name" to the named style "namedStyle".
If "name" is not given the currently selected item is used.</p>
-<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the
line style doesn't exist.</p></dd>
-
-<dt><a name="-setLineJoin"><strong>setLineJoin</strong></a>(...)</dt>
-<dd><code>setLineJoin(join, ["name"])</code>
-<p>Sets the line join style of the object "name" to the style "join". If
"name" is not given the currently selected item is used. There are predefined
constants for join - JOIN_<type>.</p></dd>
-
-<dt><a name="-setLineShade"><strong>setLineShade</strong></a>(...)</dt>
-<dd><code>setLineShade(shade, ["name"])</code>
-<p>Sets the shading of the line color of the object "name" to "shade". "shade"
must be an integer value in the range from 0 (lightest) to 100 (full color
intensity). If "name" is not given the currently selected item is used.</p>
-<p>May raise ValueError if the line shade is out of bounds.</p></dd>
-
-<dt><a name="-setLineStyle"><strong>setLineStyle</strong></a>(...)</dt>
-<dd><code>setLineStyle(style, ["name"])</code>
-<p>Sets the line style of the object "name" to the style "style". If "name" is
not given the currently selected item is used. There are predefined constants
for "style" - LINE_<style>.</p></dd>
-
-<dt><a name="-setLineWidth"><strong>setLineWidth</strong></a>(...)</dt>
-<dd><code>setLineWidth(width, ["name"])</code>
-<p>Sets line width of the object "name" to "width". "width" must be in the
range from 0.0 to 12.0 inclusive, and is measured in points. If "name" is not
given the currently selected item is used.</p>
-<p>May raise ValueError if the line width is out of bounds.</p></dd>
-
-<dt><a name="-scaleImage"><strong>scaleImage</strong></a>(...)</dt>
-<dd><code>scaleImage(x, y [, "name"])</code>
-<p>Sets the internal scaling factors of the picture in the image frame "name".
If "name" is not given the currently selected item is used. A number of 1 means
100 %. Internal scaling factors are different from the values shown on
properties palette. Note : deprecated, use setImageScale() instead.</p>
-<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the
target frame is not an image frame</p></dd>
-
-<dt><a name="-setImageScale"><strong>setImageScale</strong></a>(...)</dt>
-<dd><code>setImageScale(x, y [, "name"])</code>
-<p>Sets the scaling factors of the picture in the image frame "name". If
"name" is not given the currently selected item is used. A number of 1 means
100 %. Scaling factors are equal to the values shown on properties palette.</p>
-<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the
target frame is not an image frame</p></dd>
-
-<dt><a name="-setImageOffset"><strong>setImageOffset</strong></a>(...)</dt>
-<dd><code>setImageOffset(x, y [, "name"])</code>
-<p>Sets the position of the picture in the image frame "name". If "name" is
not given the currently selected item is used. The specified offset values are
equal to the values shown on properties palette when point unit is used.</p>
-<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the
target frame is not an image frame</p></dd>
-
-<dt><a name="-traceText"><strong>traceText</strong></a>(...)</dt>
-<dd><code>traceText(["name"])</code>
-<p>Convert the text frame "name" to outlines. If "name" is not given the
currently selected item is used.</p></dd>
-
-<dt><a name="-unlinkTextFrames"><strong>unlinkTextFrames</strong></a>(...)</dt>
-<dd><code>unlinkTextFrames("name")</code>
-<p>Remove the specified (named) object from the text frame flow/linkage. If
the frame was in the middle of a chain, the previous and next frames will be
connected, eg 'a->b->c' becomes 'a->c' when you <a
href="#-unlinkTextFrames">unlinkTextFrames</a>(b)'</p>
-<p>May throw <a href="#ScribusException">ScribusException</a> if linking rules
are violated.</p></dd>
-
-</dl>
-</body>
-</html>
+<html>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+ <title>Setting Object Properties</title>
+</head>
+<body>
+<h2>Setting Object Properties</h2>
+
+<dl>
+
+<dt><a name="-linkTextFrames"><strong>linkTextFrames</strong></a>(...)</dt>
+<dd><code>linkTextFrames("fromname", "toname")</code>
+<p>Link two text frames. The frame named "fromname" is linked to the frame
named "toname". The target frame must be an empty text frame and must not link
to or be linked from any other frames already.</p>
+<p>May throw <a href="#ScribusException">ScribusException</a> if linking rules
are violated.</p></dd>
+
+<dt><a name="-loadImage"><strong>loadImage</strong></a>(...)</dt>
+<dd><code>loadImage("filename" [, "name"])</code>
+<p>Loads the picture "picture" into the image frame "name". If "name" is not
given the currently selected item is used.</p>
+<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the
target frame is not an image frame</p></dd></dt>
+
+<dt><a name="-setCornerRadius"><strong>setCornerRadius</strong></a>(...)</dt>
+<dd><code>setCornerRadius(radius, ["name"])</code>
+<p>Sets the corner radius of the object "name". The radius is expressed in
points regardless of page units, and must be an integer. If "name" is not given
the currently selected item is used.</p>
+<p>May raise ValueError if the corner radius is negative.</p></dd>
+
+<dt><a
name="-setCustomLineStyle"><strong>setCustomLineStyle</strong></a>(...)</dt>
+<dd><code>setCustomLineStyle(styleName, ["name"])</code>
+<p>Sets the custom line style of the object "name" to "styleName". Argument
"styleName" is the name of line style as seen in Style Manager. If "name" is
not given the currently selected item is used.</p></dd>
+
+<dt><a name="-setFillBlendmode"><strong>setFillBlendmode</strong>(...)</a></dt>
+<dd><code>setFillBlendmode(blendmode, ["name"])</code>
+<p>Sets the fill blendmode of the object "name" to blendmode is the name of
one of the defined colors. If "name" is not given the currently selected item
is used.</p></dd>
+
+<dt><a name="-setFillColor"><strong>setFillColor</strong></a>(...)</dt>
+<dd><code>setFillColor("color", ["name"])</code>
+<p>Sets the fill color of the object "name" to the color "color". "color" is
the name of one of the defined colors. If "name" is not given the currently
selected item is used.</p></dd>
+
+<dt><a name="-setFillShade"><strong>setFillShade</strong></a>(...)</dt>
+<dd><code>setFillShade(shade, ["name"])</code>
+<p>Sets the shading of the fill color of the object "name" to "shade". "shade"
must be an integer value in the range from 0 (lightest) to 100 (full Color
intensity). If "name" is not given the currently selected Item is used.<p>
+<p>May raise ValueError if the fill shade is out of bounds.</p></dd>
+
+<dt><a
name="-setFillTransparency"><strong>setFillTransparency</strong>(...)</a></dt>
+<dd><code>setFillTransparency(transparency, ["name"])</code>
+<p>Sets the fill transparency of the object "name". If "name" is not given the
currently selected item is used. In spite of this command's wording, the
"transparency" value is actually a decimal corresponding to the
<strong>opacity</strong>, so for example, 0.9 = 90% opacity, 0.2 = 20%
opacity.</p></dd>
+
+<dt><a name="-setLineBlendmode"><strong>setLineBlendmode</strong>(...)</a></dt>
+<dd><code>setLineBlendmode(blendmode, ["name"])</code>
+<p>Sets the line blendmode of the object "name" to blendmode is the name of
one of the defined colors. If "name" is not given the currently selected item
is used.</p></dd>
+
+<dt><a
name="-setLineTransparency"><strong>setLineTransparency</strong>(...)</a></dt>
+<dd><code>setLineTransparency(transparency, ["name"])</code>
+<p>Sets the line transparency of the object "name". If "name" is not given the
currently selected item is used. In spite of this command's wording, the
"transparency" value is actually a decimal corresponding to the
<strong>opacity</strong>, so for example, 0.9 = 90% opacity, 0.2 = 20%
opacity.</p></dd>
+
+<dt><a name="-setGradientFill"><strong>setGradientFill</strong></a>(...)</dt>
+<dd><code>setGradientFill(type, "color1", shade1, "color2", shade2,
["name"])</code>
+<p>Sets the gradient fill of the object "name" to type. Color descriptions are
the same as for <a href="#-setFillColor">setFillColor</a>() and <a
href="#-setFillShade">setFillShade</a>(). See the constants for available types
(FILL_<type>).</p></dd>
+
+<dt><a name="-setGradientStop"><strong>setGradientStop</strong></a>(...)</dt>
+<dd><code>setGradientStop("color", shade, opacity, ramppoint, ["name"])</code>
+<p>Set or add a gradient stop to the gradient fill of the object \"name\" at
position ramppoint. Color descriptions are the same as for <a
href="#-setFillColor">setFillColor</a>() and <a
href="#-setFillShade">setFillShade</a>(). setGradientFill() must have been
called previously for the gradient fill to be visible.</p></dd>
+
+<dt><a name="-setLineCap"><strong>setLineCap</strong></a>(...)</dt>
+<dd><code>setLineCap(captype, ["name"])</code>
+<p>Sets the line cap style of the object "name" to the style "cap". If "name"
is not given the currently selected item is used. There are predefined
constants for "cap" - CAP_<type>.</p></dd>
+
+<dt><a name="-setLineColor"><strong>setLineColor</strong></a>(...)</dt>
+<dd><code>setLineColor("color", ["name"])</code>
+<p>Sets the line color of the object "name" to the color "color". If "name" is
not given the currently selected item is used.</p></dd>
+
+<dt><a name="-setMultiLine"><strong>setMultiLine</strong></a>(...)</dt>
+<dd><code>setMultiLine("namedStyle", ["name"])</code>
+<p>Sets the line style of the object "name" to the named style "namedStyle".
If "name" is not given the currently selected item is used.</p>
+<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the
line style doesn't exist.</p></dd>
+
+<dt><a name="-setLineJoin"><strong>setLineJoin</strong></a>(...)</dt>
+<dd><code>setLineJoin(join, ["name"])</code>
+<p>Sets the line join style of the object "name" to the style "join". If
"name" is not given the currently selected item is used. There are predefined
constants for join - JOIN_<type>.</p></dd>
+
+<dt><a name="-setLineShade"><strong>setLineShade</strong></a>(...)</dt>
+<dd><code>setLineShade(shade, ["name"])</code>
+<p>Sets the shading of the line color of the object "name" to "shade". "shade"
must be an integer value in the range from 0 (lightest) to 100 (full color
intensity). If "name" is not given the currently selected item is used.</p>
+<p>May raise ValueError if the line shade is out of bounds.</p></dd>
+
+<dt><a name="-setLineStyle"><strong>setLineStyle</strong></a>(...)</dt>
+<dd><code>setLineStyle(style, ["name"])</code>
+<p>Sets the line style of the object "name" to the style "style". If "name" is
not given the currently selected item is used. There are predefined constants
for "style" - LINE_<style>.</p></dd>
+
+<dt><a name="-setLineWidth"><strong>setLineWidth</strong></a>(...)</dt>
+<dd><code>setLineWidth(width, ["name"])</code>
+<p>Sets line width of the object "name" to "width". "width" must be in the
range from 0.0 to 12.0 inclusive, and is measured in points. If "name" is not
given the currently selected item is used.</p>
+<p>May raise ValueError if the line width is out of bounds.</p></dd>
+
+<dt><a name="-scaleImage"><strong><em>scaleImage</em></strong></a>(...)</dt>
+<dd><code>scaleImage(x, y [, "name"])</code>
+<p><b>Do not use this command, since it no longer works. Use setImageScale
instead.</b></p></dd>
+
+<dt><a name="-setImageScale"><strong>setImageScale</strong></a>(...)</dt>
+<dd><code>setImageScale(x, y [, "name"])</code>
+<p>Sets the scaling factors of the picture in the image frame "name". If
"name" is not given the currently selected item is used. A number of 1 means
100 %. Scaling factors are equal to the values shown on properties palette.</p>
+<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the
target frame is not an image frame</p></dd>
+
+<dt><a name="-setImageOffset"><strong>setImageOffset</strong></a>(...)</dt>
+<dd><code>setImageOffset(x, y [, "name"])</code>
+<p>Sets the position of the picture in the image frame "name". If "name" is
not given the currently selected item is used. The specified offset values are
equal to the values shown on properties palette when point unit is used.</p>
+<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the
target frame is not an image frame</p></dd>
+
+<dt><a
name="-setObjectAttributes"><strong>setObjectAttributes</strong></a>(...)</dt>
+<dd><code>setObjectAttributes(attributes, ["name"])</code>
+<p>Sets attributes of the object "name". If "name" is not given the currently
selected item is used.</p>
+<p>attributes is a list of dictionary. Each dictionary must have those keys:
Name, Type, Value, Parameter, Relationship, RelationshipTo, AutoAddTo. All
values must be strings.</p></dd>
+
+<dt><a name="-traceText"><strong>traceText</strong></a>(...)</dt>
+<dd><code>traceText(["name"])</code>
+<p>Convert the text frame "name" to outlines. If "name" is not given the
currently selected item is used.</p></dd>
+
+<dt><a name="-unlinkTextFrames"><strong>unlinkTextFrames</strong></a>(...)</dt>
+<dd><code>unlinkTextFrames("name")</code>
+<p>Remove the specified (named) object from the text frame flow/linkage. If
the frame was in the middle of a chain, the previous and next frames will be
connected, eg 'a->b->c' becomes 'a->c' when you <a
href="#-unlinkTextFrames">unlinkTextFrames</a>(b)'</p>
+<p>May throw <a href="#ScribusException">ScribusException</a> if linking rules
are violated.</p></dd>
+
+</dl>
+</body>
+</html>
Modified: trunk/Scribus/scribus/plugins/scriptplugin/cmdsetprop.h
URL:
http://scribus.net/websvn/diff.php?repname=Scribus&rev=22758&path=/trunk/Scribus/scribus/plugins/scriptplugin/cmdsetprop.h
==============================================================================
--- trunk/Scribus/scribus/plugins/scriptplugin/cmdsetprop.h (original)
+++ trunk/Scribus/scribus/plugins/scriptplugin/cmdsetprop.h Sat Nov 17
18:00:37 2018
@@ -225,7 +225,7 @@
Sets attributes of the object \"name\".\n\
If \"name\" is not given the currently selected item is used.\n\
\n\
-attributes is list of dictionary. Each dictionary must have those keys:\n\
+attributes is a list of dictionary. Each dictionary must have those keys:\n\
Name, Type, Value, Parameter, Relationship, RelationshipTo, AutoAddTo\n\
All values must be strings.\n\
\n\
_______________________________________________
scribus-commit mailing list
[email protected]
http://lists.scribus.net/mailman/listinfo/scribus-commit
