Author: jghali
Date: Tue May 5 16:20:38 2020
New Revision: 23691
URL: http://scribus.net/websvn/listing.php?repname=Scribus&sc=1&rev=23691
Log:
Scripter: add getTextFlowMode()
Modified:
trunk/Scribus/doc/de/scripterapi-manobj.html
trunk/Scribus/doc/en/scripterapi-manobj.html
trunk/Scribus/doc/fr/scripterapi-manobj.html
trunk/Scribus/doc/it/scripterapi-manobj.html
trunk/Scribus/doc/ru/scripterapi-manobj.html
trunk/Scribus/scribus/plugins/scriptplugin/cmdobj.cpp
trunk/Scribus/scribus/plugins/scriptplugin/cmdobj.h
trunk/Scribus/scribus/plugins/scriptplugin/scriptplugin.cpp
Modified: trunk/Scribus/doc/de/scripterapi-manobj.html
URL:
http://scribus.net/websvn/diff.php?repname=Scribus&rev=23691&path=/trunk/Scribus/doc/de/scripterapi-manobj.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi-manobj.html (original)
+++ trunk/Scribus/doc/de/scripterapi-manobj.html Tue May 5 16:20:38 2020
@@ -1,134 +1,140 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
- <title>Manipuler les objets</title>
+ <title>Manipulating Objects</title>
</head>
<body>
-<h2>Manipuler les objets</h2>
+<h2>Manipulating Objects</h2>
<dl>
<dt><a name="-combinePolygons"><strong>combinePolygons()</strong></a></dt>
<dd><code>combinePolygons()</code>
-<p>Combine deux polygones ou plus.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
+<p>Combines two or more selected polygons.</p>
+<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
<dt><a name="-copyObject"><strong>copyObject</strong>(...)</a></dt>
-<dd><code>copyObject(["nom"]) -> chaîne</code>
-<p>Effectue une copie de l'objet sélectionné vers le presse-papiers.</p></dd>
+<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(["nom"]) -> chaîne</code>
-<p>Crée une copie du ou des objects sélectionnés dans le document
courant.</p></dd>
+<dd><code>duplicateObject(["name"]) -> string</code>
+<p>Creates a Duplicate of the selected Object (or Selection Group).</p></dd>
<dt><a
name="-getCharacterStyle"><strong>getCharacterStyle</strong></a>(...)</dt>
-<dd><code>getCharacterStyle(["nom"]) -> chaîne</code>
-<p>Retourne le nom du style de caractère appliqué à l'objet "nom". Si aucun
nom d'objet n'est fourni, l'élément sélectionné est utilisé.</p>
-<p>Si l'objet courant possède une sélection de texte, le nom retourné est
celui du style appliqué au début de la sélection. Sinon le nom retourné est
celui du style de caractère appliqué par défaut.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
+<dd><code>getCharacterStyle(["name"])</code>
+<p>Return name of character style applied to object named "name". If "name" is
not given, the currently selected object is used.</p>
+<p>If current object has a text selection, the name of style applied to start
of selection is returned. Otherwise the name of the item default character
style is returned.</p>
+<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if target
frame is not a text frame.</p></dd>
<dt><a
name="-getParagraphStyle"><strong>getParagraphStyle</strong></a>(...)</dt>
-<dd><code>getParagraphStyle(["nom"]) -> chaîne</code>
-<p>Retourne le nom du style de paragraphe appliqué à l'objet "nom". Si aucun
nom d'objet n'est fourni, l'élément sélectionné est utilisé.</p>
-<p>Si l'objet courant possède une sélection de texte, le nom retourné est
celui du style appliqué au début de la sélection. Sinon le nom retourné est
celui du style appliqué par défaut.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
+<dd><code>getParagraphStyle(["name"])</code>
+<p>Return name of paragraph style applied to object named "name". If "name" is
not given, the currently selected object is used.</p>
+<p>If current object has a text selection, the name of style applied to start
of selection is returned. Otherwise the name of the item default style is
returned.</p>
+<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if target
frame is not a text frame.</p></dd>
<dt><a name="-getStyle"><strong>getStyle</strong></a>(...)</dt>
-<dd><code>getStyle(["nom"]) -> chaîne</code>
-<p>Obsolète. Veuillez utiliser getParagraphStyle() en lieu et place.</p></dd>
+<dd><code>getStyle(["name"])</code>
+<p>Deprecated. Use getParagraphStyle() instead.</p></dd>
+
+<dt><a name="-getTextFlowMode"><strong>getTextFlowMode</strong></a>(...)</dt>
+<dd><code>getTextFlowMode(["name"]) -> integer</code>
+<p>Return the current text flow mode used by item "name" as an integer. If
"name" is not given, the currently selected object is used.</p>
+<p>The function will return one of the following value:
+<ul>
+ <li>0 : text flow around frame is disabled</li>
+ <li>1 : text flow around frame shape</li>
+ <li>2 : text flow around frame bounding box</li>
+ <li>3 : text flow around frame contour line</li>
+ <li>4 : text flow around image clip path</li>
+</ul>
+</p></dd>
<dt><a name="-groupObjects"><strong>groupObjects</strong></a>(...)</dt>
-<dd><code>groupObjects(liste) -> chaîne</code>
-<p>Groupe les objets énumérés dans "liste". La "liste" doit contenir les
noms des objets à grouper.
-Si la "liste" n'est pas fournie, les éléments sélectionnés sont
-utilisés. Retourne le nom du groupe créé pour utilisation
ultérieure.</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(["nom"]) -> booléen</code>
-<p>Retourne la valeur True si l'objet "nom" est verrouillé. Si "nom" n'est
pas fourni, l'élément sélectionné est utilisé. </p></dd>
+<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>lockObject(["nom"]) -> booléen</code>
-<p>Verrouille l'objet "nom" s'il est déverrouillé, ou le déverrouille s'il
y a lieu. Si "nom" n'est pas fourni, l'élément sélectionné est utilisé.
-Retourne la valeur True si verrouillé.</p></dd>
+<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>moveObject(dx, dy [, "nom"])</code>
-<p>Déplace l'objet "nom" de dx et dy par rapport à sa position courante. Les
-distances sont exprimées dans les unités de mesure du document (voir
-les constantes UNIT). Si "nom" n'est pas fourni, l'élément sélectionné est
utilisé. Si l'objet "nom" appartient à un groupe, tout le groupe est
déplacé.</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.</p></dd>
<dt><a name="-moveObjectAbs"><strong>moveObjectAbs</strong></a>(...)</dt>
-<dd><code>moveObjectAbs(x, y [, "nom"])</code>
-<p>Déplace l'objet "nom" à une nouvelle position. Les coordonnées
-sont exprimées dans les unités de mesure du document (voir les
-constantes UNIT). Si "nom" n'est pas fourni, l'élément sélectionné est
utilisé. Si l'objet "nom" appartient à un groupe, tout le groupe est
déplacé.</p></dd>
+<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 [, "nom"])</code>
-<p>Fait pivoter l'objet "nom" de la valeur "rot" en degrés relatifs. La
rotation est activée par le sommet sélectionné comme point de rotation - par
défaut, le sommet en haut à gauche est le point de rotation zéro. Les
valeurs positives signifient une rotation dans le sens des aiguilles d'une
montre, lorsque le point de rotation par défaut est utilisé. Si "nom" n'est
pas fourni, l'élément sélectionné est utilisé. </p></dd>
+<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>rotateObjectAbs(rot [, "nom"])</code>
-<p>Établit la rotation de l'objet "nom" Ã "rot". Des valeurs positives
signifient une rotation dans le sens des aiguilles d'une montre. Si "nom" n'est
pas fourni, l'élément sélectionné est utilisé. </p></dd>
+<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>scaleGroup(facteur [,"nom"])</code>
-<p>Redimensionne le groupe auquel l'objet "nom" appartient. Les valeurs
supérieures à 1 agrandissent le groupe, les valeurs inférieures à 1 rendent
le groupe plus petit, par exemple une valeur de 0.5 redimensionne le groupe Ã
50 % de sa taille originale, tandis qu'une valeur de 1.5 redimensionne le
groupe à 150 % de sa taille originale. La valeur de "facteur" doit être
supérieure à 0. Si le "nom" n'est pas fourni, l'élément sélectionné
courant est utilisé.</p>
-<p>Peut générer ValueError si le facteur de redimensionnement n'est pas
valide.</p></dd>
+<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="-setCharacterStyle"><strong>setCharacterStyle</strong></a>(...)</dt>
-<dd><code>setCharacterStyle("style" [, "nom"])</code>
-<p>Applique le "style" de caractère spécifié à l'objet "nom".</p>
-<p>Si le nom d'objet "nom" n'est pas spécifié, le style est appliqué à la
sélection d'objets courante.</p>
-<p>Si de multiples objets sont sélectionnés ou si l'objet sélectionné ne
comporte aucune sélection de texte, le style est appliqué aux objets
sélectionnés. Dans le cas contraire, le style est appliqué à la sélection
de texte courante.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> si l'objet
cible n'est pas un cadre de texte.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#NotFoundError">NotFoundError</a> si le nom de style
spécifié n'appartient pas au document courant.</p></dd>
+<dd><code>setCharacterStyle("style" [, "name"])</code>
+<p>Apply the named character "style" to the object named "name".</p>
+<p>If object name is not provided, style is applied on current object
selection.</p>
+<p>If multiple objects are selected or if selected object has no text
selection, style is applied on selected object(s). Otherwise style is applied
to the current text selection.</p>
+<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the
target frame is not a text frame.</p>
+<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if
specified style name does not exist in current document.</p></dd>
<dt><a
name="-setParagraphStyle"><strong>setParagraphStyle</strong></a>(...)</dt>
-<dd><code>setParagraphStyle("style" [, "nom"])</code>
-<p>Applique le "style" de paragraphe spécifié à l'objet "nom".</p>
-<p>Si le nom d'objet "nom" n'est pas spécifié, le style est appliqué à la
sélection d'objets courante.</p>
-<p>Si de multiples objets sont sélectionnés ou si l'objet sélectionné ne
comporte aucune sélection de texte, le style est appliqué aux objets
sélectionnés. Dans le cas contraire, le style est appliqué à la sélection
de texte courante.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> si l'objet
cible n'est pas un cadre de texte.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#NotFoundError">NotFoundError</a> si le nom de style
spécifié n'appartient pas au document courant.</p></dd>
+<dd><code>setParagraphStyle("style" [, "name"])</code>
+<p>Apply the named paragraph "style" to the object named "name".</p>
+<p>If object name is not provided, style is applied on current object
selection.</p>
+<p>If multiple objects are selected or if selected object has no text
selection, style is applied on selected object(s). Otherwise style is applied
to the current text selection.</p>
+<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the
target frame is not a text frame.</p>
+<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if
specified style name does not exist in current document.</p></dd>
<dt><a
name="-setScaleFrameToImage"><strong>setScaleFrameToImage</strong></a>(...)</dt>
-<dd><code>setScaleFrameToImage([nom])</code>
-<p>Redimensionne l'objet "nom" aux dimensions de l'image. Si "nom" n'est pas
fourni, l'élément sélectionné est utilisé</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
+<dd><code>setScaleFrameToImage([name])</code>
+<p>Set frame size on the selected or specified image frame to image size.</p>
+<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
<dt><a
name="-setScaleImageToFrame"><strong>setScaleImageToFrame</strong></a>(...)</dt>
-<dd><code>setScaleImageToFrame(redimAuCadre, proportionnel=None,
nom=<selection>)</code>
-<p>Établit le mode de redimensionnement par rapport au cadre d'image
sélectionné, ou spécifié dans 'redimAuCadre'.
-Si 'proportionnel' est spécifié, établit le redimensionnement en maintenant
des proportions fixes. 'redimAuCadre' et 'proportionnel' sont booléens.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
+<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 <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
<dt><a name="-setStyle"><strong>setStyle</strong></a>(...)</dt>
-<dd><code>setStyle("style" [, "nom"])</code>
-<p>Obsolète. Veuillez utiliser setParagraphStyle() en lieu et place.</p></dd>
+<dd><code>setStyle("style" [, "name"])</code>
+<p>Deprecated. Use setParagraphStyle() instead.</p></dd>
-<dt><a name="-setTextFlowMode"><strong>setTextFlowMode</strong></a>(...)</dt>
-<dd><code>setTextFlowMode("nom" [, etat])</code>
-<p>Active ou désactive l'habillage du texte pour l'objet "nom".</p>
-<p>Appelé avec les paramètres chaîne "nom" et l'entier optionnel "état" (0
<= "état" <= 3).
-Paramétrer "état" à la valeur 0 désactivera l'habillage du texte.
Paramétrer "état" à la valeur 1 habillera le texte selon le cadre de l'objet.
-Paramétrer "état" à la valeur 2 habillera le texte selon la bounding box de
l'objet. Paramétrer "état" à la valeur 3 habillera le texte selon la ligne
de contourde l'objet.
-Si l'argument"état" n'est pas passé, cette fonctionnalité change de valeur
(activée si inactive ou désactivée si active).</p></dd>
+<dt><a name="-setTextFlowMode"><strong>setTextFlowMode</strong>(...)</a></dt>
+<dd><code>setTextFlowMode("name" [, state])</code>
+<p>Enables/disables "Text Flows Around Frame" feature for object "name".</p>
+<p>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>
<dt><a name="-sizeObject"><strong>sizeObject</strong></a>(...)</dt>
-<dd><code>sizeObject(largeur, hauteur [, "nom"])</code>
-<p>Redimensionne l'objet "nom" à la largeur et à la hauteur données. Si
"nom" n'est pas fourni, l'élément sélectionné est utilisé. </p></dd>
+<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="-unGroupObjects"><strong>unGroupObjects</strong></a>(...)</dt>
-<dd><code>unGroupObjects("nom")</code>
-<p>Détruit le groupe auquel appartient l'objet "nom". Si le "nom" n'est pas
fourni, l'élément sélectionné est utilisé.</p></dd>
+<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="-textFlowMode"><strong>textFlowMode</strong></a>(...)</dt>
-<dd><code>textFlowMode("nom" [, etat])</code>
-<p>Obsolète. Veuillez utiliser setTextFlowMode() en lieu et place.</p></dd>
+<dt><a name="-textFlowMode"><strong>textFlowMode</strong>(...)</a></dt>
+<dd><code>textFlowMode("name" [, state])</code>
+<p>Deprecated. Use setTextFlowMode() instead.</p></dd>
</dl>
</body>
</html>
-
Modified: trunk/Scribus/doc/en/scripterapi-manobj.html
URL:
http://scribus.net/websvn/diff.php?repname=Scribus&rev=23691&path=/trunk/Scribus/doc/en/scripterapi-manobj.html
==============================================================================
--- trunk/Scribus/doc/en/scripterapi-manobj.html (original)
+++ trunk/Scribus/doc/en/scripterapi-manobj.html Tue May 5 16:20:38 2020
@@ -36,6 +36,19 @@
<dt><a name="-getStyle"><strong>getStyle</strong></a>(...)</dt>
<dd><code>getStyle(["name"])</code>
<p>Deprecated. Use getParagraphStyle() instead.</p></dd>
+
+<dt><a name="-getTextFlowMode"><strong>getTextFlowMode</strong></a>(...)</dt>
+<dd><code>getTextFlowMode(["name"]) -> integer</code>
+<p>Return the current text flow mode used by item "name" as an integer. If
"name" is not given, the currently selected object is used.</p>
+<p>The function will return one of the following value:
+<ul>
+ <li>0 : text flow around frame is disabled</li>
+ <li>1 : text flow around frame shape</li>
+ <li>2 : text flow around frame bounding box</li>
+ <li>3 : text flow around frame contour line</li>
+ <li>4 : text flow around image clip path</li>
+</ul>
+</p></dd>
<dt><a name="-groupObjects"><strong>groupObjects</strong></a>(...)</dt>
<dd><code>groupObjects(list)</code>
Modified: trunk/Scribus/doc/fr/scripterapi-manobj.html
URL:
http://scribus.net/websvn/diff.php?repname=Scribus&rev=23691&path=/trunk/Scribus/doc/fr/scripterapi-manobj.html
==============================================================================
--- trunk/Scribus/doc/fr/scripterapi-manobj.html (original)
+++ trunk/Scribus/doc/fr/scripterapi-manobj.html Tue May 5 16:20:38 2020
@@ -36,6 +36,19 @@
<dt><a name="-getStyle"><strong>getStyle</strong></a>(...)</dt>
<dd><code>getStyle(["nom"]) -> chaîne</code>
<p>Obsolète. Veuillez utiliser getParagraphStyle() en lieu et place.</p></dd>
+
+<dt><a name="-getTextFlowMode"><strong>getTextFlowMode</strong></a>(...)</dt>
+<dd><code>getTextFlowMode(["nom"]) -> entier</code>
+<p>Return le mode d'habillage du texte appliqué à l'objet "nom" sous forme
d'un entier. Si aucun nom d'objet n'est fourni, l'élément sélectionné est
utilisé.</p>
+<p>La fonction retournera une des valeurs suivantes:
+<ul>
+ <li>0 : l'habillage du texte est désactivé</li>
+ <li>1 : l'habillage du texte suit la forme du cadre</li>
+ <li>2 : l'habillage du texte suit la bounding box du cadre</li>
+ <li>3 : l'habillage du texte suit la ligne de contour du cadre</li>
+ <li>4 : l'habillage du texte suit le tracé de découpage de
l'image</li>
+</ul>
+</p></dd>
<dt><a name="-groupObjects"><strong>groupObjects</strong></a>(...)</dt>
<dd><code>groupObjects(liste) -> chaîne</code>
Modified: trunk/Scribus/doc/it/scripterapi-manobj.html
URL:
http://scribus.net/websvn/diff.php?repname=Scribus&rev=23691&path=/trunk/Scribus/doc/it/scripterapi-manobj.html
==============================================================================
--- trunk/Scribus/doc/it/scripterapi-manobj.html (original)
+++ trunk/Scribus/doc/it/scripterapi-manobj.html Tue May 5 16:20:38 2020
@@ -1,134 +1,140 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
- <title>Manipuler les objets</title>
+ <title>Manipulating Objects</title>
</head>
<body>
-<h2>Manipuler les objets</h2>
+<h2>Manipulating Objects</h2>
<dl>
<dt><a name="-combinePolygons"><strong>combinePolygons()</strong></a></dt>
<dd><code>combinePolygons()</code>
-<p>Combine deux polygones ou plus.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
+<p>Combines two or more selected polygons.</p>
+<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
<dt><a name="-copyObject"><strong>copyObject</strong>(...)</a></dt>
-<dd><code>copyObject(["nom"]) -> chaîne</code>
-<p>Effectue une copie de l'objet sélectionné vers le presse-papiers.</p></dd>
+<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(["nom"]) -> chaîne</code>
-<p>Crée une copie du ou des objects sélectionnés dans le document
courant.</p></dd>
+<dd><code>duplicateObject(["name"]) -> string</code>
+<p>Creates a Duplicate of the selected Object (or Selection Group).</p></dd>
<dt><a
name="-getCharacterStyle"><strong>getCharacterStyle</strong></a>(...)</dt>
-<dd><code>getCharacterStyle(["nom"]) -> chaîne</code>
-<p>Retourne le nom du style de caractère appliqué à l'objet "nom". Si aucun
nom d'objet n'est fourni, l'élément sélectionné est utilisé.</p>
-<p>Si l'objet courant possède une sélection de texte, le nom retourné est
celui du style appliqué au début de la sélection. Sinon le nom retourné est
celui du style de caractère appliqué par défaut.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
+<dd><code>getCharacterStyle(["name"])</code>
+<p>Return name of character style applied to object named "name". If "name" is
not given, the currently selected object is used.</p>
+<p>If current object has a text selection, the name of style applied to start
of selection is returned. Otherwise the name of the item default character
style is returned.</p>
+<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if target
frame is not a text frame.</p></dd>
<dt><a
name="-getParagraphStyle"><strong>getParagraphStyle</strong></a>(...)</dt>
-<dd><code>getParagraphStyle(["nom"]) -> chaîne</code>
-<p>Retourne le nom du style de paragraphe appliqué à l'objet "nom". Si aucun
nom d'objet n'est fourni, l'élément sélectionné est utilisé.</p>
-<p>Si l'objet courant possède une sélection de texte, le nom retourné est
celui du style appliqué au début de la sélection. Sinon le nom retourné est
celui du style appliqué par défaut.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
+<dd><code>getParagraphStyle(["name"])</code>
+<p>Return name of paragraph style applied to object named "name". If "name" is
not given, the currently selected object is used.</p>
+<p>If current object has a text selection, the name of style applied to start
of selection is returned. Otherwise the name of the item default style is
returned.</p>
+<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if target
frame is not a text frame.</p></dd>
<dt><a name="-getStyle"><strong>getStyle</strong></a>(...)</dt>
-<dd><code>getStyle(["nom"]) -> chaîne</code>
-<p>Obsolète. Veuillez utiliser getParagraphStyle() en lieu et place.</p></dd>
+<dd><code>getStyle(["name"])</code>
+<p>Deprecated. Use getParagraphStyle() instead.</p></dd>
+
+<dt><a name="-getTextFlowMode"><strong>getTextFlowMode</strong></a>(...)</dt>
+<dd><code>getTextFlowMode(["name"]) -> integer</code>
+<p>Return the current text flow mode used by item "name" as an integer. If
"name" is not given, the currently selected object is used.</p>
+<p>The function will return one of the following value:
+<ul>
+ <li>0 : text flow around frame is disabled</li>
+ <li>1 : text flow around frame shape</li>
+ <li>2 : text flow around frame bounding box</li>
+ <li>3 : text flow around frame contour line</li>
+ <li>4 : text flow around image clip path</li>
+</ul>
+</p></dd>
<dt><a name="-groupObjects"><strong>groupObjects</strong></a>(...)</dt>
-<dd><code>groupObjects(liste) -> chaîne</code>
-<p>Groupe les objets énumérés dans "liste". La "liste" doit contenir les
noms des objets à grouper.
-Si la "liste" n'est pas fournie, les éléments sélectionnés sont
-utilisés. Retourne le nom du groupe créé pour utilisation
ultérieure.</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(["nom"]) -> booléen</code>
-<p>Retourne la valeur True si l'objet "nom" est verrouillé. Si "nom" n'est
pas fourni, l'élément sélectionné est utilisé. </p></dd>
+<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>lockObject(["nom"]) -> booléen</code>
-<p>Verrouille l'objet "nom" s'il est déverrouillé, ou le déverrouille s'il
y a lieu. Si "nom" n'est pas fourni, l'élément sélectionné est utilisé.
-Retourne la valeur True si verrouillé.</p></dd>
+<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>moveObject(dx, dy [, "nom"])</code>
-<p>Déplace l'objet "nom" de dx et dy par rapport à sa position courante. Les
-distances sont exprimées dans les unités de mesure du document (voir
-les constantes UNIT). Si "nom" n'est pas fourni, l'élément sélectionné est
utilisé. Si l'objet "nom" appartient à un groupe, tout le groupe est
déplacé.</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.</p></dd>
<dt><a name="-moveObjectAbs"><strong>moveObjectAbs</strong></a>(...)</dt>
-<dd><code>moveObjectAbs(x, y [, "nom"])</code>
-<p>Déplace l'objet "nom" à une nouvelle position. Les coordonnées
-sont exprimées dans les unités de mesure du document (voir les
-constantes UNIT). Si "nom" n'est pas fourni, l'élément sélectionné est
utilisé. Si l'objet "nom" appartient à un groupe, tout le groupe est
déplacé.</p></dd>
+<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 [, "nom"])</code>
-<p>Fait pivoter l'objet "nom" de la valeur "rot" en degrés relatifs. La
rotation est activée par le sommet sélectionné comme point de rotation - par
défaut, le sommet en haut à gauche est le point de rotation zéro. Les
valeurs positives signifient une rotation dans le sens des aiguilles d'une
montre, lorsque le point de rotation par défaut est utilisé. Si "nom" n'est
pas fourni, l'élément sélectionné est utilisé. </p></dd>
+<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>rotateObjectAbs(rot [, "nom"])</code>
-<p>Établit la rotation de l'objet "nom" Ã "rot". Des valeurs positives
signifient une rotation dans le sens des aiguilles d'une montre. Si "nom" n'est
pas fourni, l'élément sélectionné est utilisé. </p></dd>
+<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>scaleGroup(facteur [,"nom"])</code>
-<p>Redimensionne le groupe auquel l'objet "nom" appartient. Les valeurs
supérieures à 1 agrandissent le groupe, les valeurs inférieures à 1 rendent
le groupe plus petit, par exemple une valeur de 0.5 redimensionne le groupe Ã
50 % de sa taille originale, tandis qu'une valeur de 1.5 redimensionne le
groupe à 150 % de sa taille originale. La valeur de "facteur" doit être
supérieure à 0. Si le "nom" n'est pas fourni, l'élément sélectionné
courant est utilisé.</p>
-<p>Peut générer ValueError si le facteur de redimensionnement n'est pas
valide.</p></dd>
+<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="-setCharacterStyle"><strong>setCharacterStyle</strong></a>(...)</dt>
-<dd><code>setCharacterStyle("style" [, "nom"])</code>
-<p>Applique le "style" de caractère spécifié à l'objet "nom".</p>
-<p>Si le nom d'objet "nom" n'est pas spécifié, le style est appliqué à la
sélection d'objets courante.</p>
-<p>Si de multiples objets sont sélectionnés ou si l'objet sélectionné ne
comporte aucune sélection de texte, le style est appliqué aux objets
sélectionnés. Dans le cas contraire, le style est appliqué à la sélection
de texte courante.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> si l'objet
cible n'est pas un cadre de texte.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#NotFoundError">NotFoundError</a> si le nom de style
spécifié n'appartient pas au document courant.</p></dd>
+<dd><code>setCharacterStyle("style" [, "name"])</code>
+<p>Apply the named character "style" to the object named "name".</p>
+<p>If object name is not provided, style is applied on current object
selection.</p>
+<p>If multiple objects are selected or if selected object has no text
selection, style is applied on selected object(s). Otherwise style is applied
to the current text selection.</p>
+<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the
target frame is not a text frame.</p>
+<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if
specified style name does not exist in current document.</p></dd>
<dt><a
name="-setParagraphStyle"><strong>setParagraphStyle</strong></a>(...)</dt>
-<dd><code>setParagraphStyle("style" [, "nom"])</code>
-<p>Applique le "style" de paragraphe spécifié à l'objet "nom".</p>
-<p>Si le nom d'objet "nom" n'est pas spécifié, le style est appliqué à la
sélection d'objets courante.</p>
-<p>Si de multiples objets sont sélectionnés ou si l'objet sélectionné ne
comporte aucune sélection de texte, le style est appliqué aux objets
sélectionnés. Dans le cas contraire, le style est appliqué à la sélection
de texte courante.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> si l'objet
cible n'est pas un cadre de texte.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#NotFoundError">NotFoundError</a> si le nom de style
spécifié n'appartient pas au document courant.</p></dd>
+<dd><code>setParagraphStyle("style" [, "name"])</code>
+<p>Apply the named paragraph "style" to the object named "name".</p>
+<p>If object name is not provided, style is applied on current object
selection.</p>
+<p>If multiple objects are selected or if selected object has no text
selection, style is applied on selected object(s). Otherwise style is applied
to the current text selection.</p>
+<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the
target frame is not a text frame.</p>
+<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if
specified style name does not exist in current document.</p></dd>
<dt><a
name="-setScaleFrameToImage"><strong>setScaleFrameToImage</strong></a>(...)</dt>
-<dd><code>setScaleFrameToImage([nom])</code>
-<p>Redimensionne l'objet "nom" aux dimensions de l'image. Si "nom" n'est pas
fourni, l'élément sélectionné est utilisé</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
+<dd><code>setScaleFrameToImage([name])</code>
+<p>Set frame size on the selected or specified image frame to image size.</p>
+<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
<dt><a
name="-setScaleImageToFrame"><strong>setScaleImageToFrame</strong></a>(...)</dt>
-<dd><code>setScaleImageToFrame(redimAuCadre, proportionnel=None,
nom=<selection>)</code>
-<p>Établit le mode de redimensionnement par rapport au cadre d'image
sélectionné, ou spécifié dans 'redimAuCadre'.
-Si 'proportionnel' est spécifié, établit le redimensionnement en maintenant
des proportions fixes. 'redimAuCadre' et 'proportionnel' sont booléens.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
+<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 <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
<dt><a name="-setStyle"><strong>setStyle</strong></a>(...)</dt>
-<dd><code>setStyle("style" [, "nom"])</code>
-<p>Obsolète. Veuillez utiliser setParagraphStyle() en lieu et place.</p></dd>
+<dd><code>setStyle("style" [, "name"])</code>
+<p>Deprecated. Use setParagraphStyle() instead.</p></dd>
-<dt><a name="-setTextFlowMode"><strong>setTextFlowMode</strong></a>(...)</dt>
-<dd><code>setTextFlowMode("nom" [, etat])</code>
-<p>Active ou désactive l'habillage du texte pour l'objet "nom".</p>
-<p>Appelé avec les paramètres chaîne "nom" et l'entier optionnel "état" (0
<= "état" <= 3).
-Paramétrer "état" à la valeur 0 désactivera l'habillage du texte.
Paramétrer "état" à la valeur 1 habillera le texte selon le cadre de l'objet.
-Paramétrer "état" à la valeur 2 habillera le texte selon la bounding box de
l'objet. Paramétrer "état" à la valeur 3 habillera le texte selon la ligne
de contourde l'objet.
-Si l'argument"état" n'est pas passé, cette fonctionnalité change de valeur
(activée si inactive ou désactivée si active).</p></dd>
+<dt><a name="-setTextFlowMode"><strong>setTextFlowMode</strong>(...)</a></dt>
+<dd><code>setTextFlowMode("name" [, state])</code>
+<p>Enables/disables "Text Flows Around Frame" feature for object "name".</p>
+<p>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>
<dt><a name="-sizeObject"><strong>sizeObject</strong></a>(...)</dt>
-<dd><code>sizeObject(largeur, hauteur [, "nom"])</code>
-<p>Redimensionne l'objet "nom" à la largeur et à la hauteur données. Si
"nom" n'est pas fourni, l'élément sélectionné est utilisé. </p></dd>
+<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="-unGroupObjects"><strong>unGroupObjects</strong></a>(...)</dt>
-<dd><code>unGroupObjects("nom")</code>
-<p>Détruit le groupe auquel appartient l'objet "nom". Si le "nom" n'est pas
fourni, l'élément sélectionné est utilisé.</p></dd>
+<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="-textFlowMode"><strong>textFlowMode</strong></a>(...)</dt>
-<dd><code>textFlowMode("nom" [, etat])</code>
-<p>Obsolète. Veuillez utiliser setTextFlowMode() en lieu et place.</p></dd>
+<dt><a name="-textFlowMode"><strong>textFlowMode</strong>(...)</a></dt>
+<dd><code>textFlowMode("name" [, state])</code>
+<p>Deprecated. Use setTextFlowMode() instead.</p></dd>
</dl>
</body>
</html>
-
Modified: trunk/Scribus/doc/ru/scripterapi-manobj.html
URL:
http://scribus.net/websvn/diff.php?repname=Scribus&rev=23691&path=/trunk/Scribus/doc/ru/scripterapi-manobj.html
==============================================================================
--- trunk/Scribus/doc/ru/scripterapi-manobj.html (original)
+++ trunk/Scribus/doc/ru/scripterapi-manobj.html Tue May 5 16:20:38 2020
@@ -1,134 +1,140 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
- <title>Manipuler les objets</title>
+ <title>Manipulating Objects</title>
</head>
<body>
-<h2>Manipuler les objets</h2>
+<h2>Manipulating Objects</h2>
<dl>
<dt><a name="-combinePolygons"><strong>combinePolygons()</strong></a></dt>
<dd><code>combinePolygons()</code>
-<p>Combine deux polygones ou plus.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
+<p>Combines two or more selected polygons.</p>
+<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
<dt><a name="-copyObject"><strong>copyObject</strong>(...)</a></dt>
-<dd><code>copyObject(["nom"]) -> chaîne</code>
-<p>Effectue une copie de l'objet sélectionné vers le presse-papiers.</p></dd>
+<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(["nom"]) -> chaîne</code>
-<p>Crée une copie du ou des objects sélectionnés dans le document
courant.</p></dd>
+<dd><code>duplicateObject(["name"]) -> string</code>
+<p>Creates a Duplicate of the selected Object (or Selection Group).</p></dd>
<dt><a
name="-getCharacterStyle"><strong>getCharacterStyle</strong></a>(...)</dt>
-<dd><code>getCharacterStyle(["nom"]) -> chaîne</code>
-<p>Retourne le nom du style de caractère appliqué à l'objet "nom". Si aucun
nom d'objet n'est fourni, l'élément sélectionné est utilisé.</p>
-<p>Si l'objet courant possède une sélection de texte, le nom retourné est
celui du style appliqué au début de la sélection. Sinon le nom retourné est
celui du style de caractère appliqué par défaut.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
+<dd><code>getCharacterStyle(["name"])</code>
+<p>Return name of character style applied to object named "name". If "name" is
not given, the currently selected object is used.</p>
+<p>If current object has a text selection, the name of style applied to start
of selection is returned. Otherwise the name of the item default character
style is returned.</p>
+<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if target
frame is not a text frame.</p></dd>
<dt><a
name="-getParagraphStyle"><strong>getParagraphStyle</strong></a>(...)</dt>
-<dd><code>getParagraphStyle(["nom"]) -> chaîne</code>
-<p>Retourne le nom du style de paragraphe appliqué à l'objet "nom". Si aucun
nom d'objet n'est fourni, l'élément sélectionné est utilisé.</p>
-<p>Si l'objet courant possède une sélection de texte, le nom retourné est
celui du style appliqué au début de la sélection. Sinon le nom retourné est
celui du style appliqué par défaut.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
+<dd><code>getParagraphStyle(["name"])</code>
+<p>Return name of paragraph style applied to object named "name". If "name" is
not given, the currently selected object is used.</p>
+<p>If current object has a text selection, the name of style applied to start
of selection is returned. Otherwise the name of the item default style is
returned.</p>
+<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if target
frame is not a text frame.</p></dd>
<dt><a name="-getStyle"><strong>getStyle</strong></a>(...)</dt>
-<dd><code>getStyle(["nom"]) -> chaîne</code>
-<p>Obsolète. Veuillez utiliser getParagraphStyle() en lieu et place.</p></dd>
+<dd><code>getStyle(["name"])</code>
+<p>Deprecated. Use getParagraphStyle() instead.</p></dd>
+
+<dt><a name="-getTextFlowMode"><strong>getTextFlowMode</strong></a>(...)</dt>
+<dd><code>getTextFlowMode(["name"]) -> integer</code>
+<p>Return the current text flow mode used by item "name" as an integer. If
"name" is not given, the currently selected object is used.</p>
+<p>The function will return one of the following value:
+<ul>
+ <li>0 : text flow around frame is disabled</li>
+ <li>1 : text flow around frame shape</li>
+ <li>2 : text flow around frame bounding box</li>
+ <li>3 : text flow around frame contour line</li>
+ <li>4 : text flow around image clip path</li>
+</ul>
+</p></dd>
<dt><a name="-groupObjects"><strong>groupObjects</strong></a>(...)</dt>
-<dd><code>groupObjects(liste) -> chaîne</code>
-<p>Groupe les objets énumérés dans "liste". La "liste" doit contenir les
noms des objets à grouper.
-Si la "liste" n'est pas fournie, les éléments sélectionnés sont
-utilisés. Retourne le nom du groupe créé pour utilisation
ultérieure.</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(["nom"]) -> booléen</code>
-<p>Retourne la valeur True si l'objet "nom" est verrouillé. Si "nom" n'est
pas fourni, l'élément sélectionné est utilisé. </p></dd>
+<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>lockObject(["nom"]) -> booléen</code>
-<p>Verrouille l'objet "nom" s'il est déverrouillé, ou le déverrouille s'il
y a lieu. Si "nom" n'est pas fourni, l'élément sélectionné est utilisé.
-Retourne la valeur True si verrouillé.</p></dd>
+<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>moveObject(dx, dy [, "nom"])</code>
-<p>Déplace l'objet "nom" de dx et dy par rapport à sa position courante. Les
-distances sont exprimées dans les unités de mesure du document (voir
-les constantes UNIT). Si "nom" n'est pas fourni, l'élément sélectionné est
utilisé. Si l'objet "nom" appartient à un groupe, tout le groupe est
déplacé.</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.</p></dd>
<dt><a name="-moveObjectAbs"><strong>moveObjectAbs</strong></a>(...)</dt>
-<dd><code>moveObjectAbs(x, y [, "nom"])</code>
-<p>Déplace l'objet "nom" à une nouvelle position. Les coordonnées
-sont exprimées dans les unités de mesure du document (voir les
-constantes UNIT). Si "nom" n'est pas fourni, l'élément sélectionné est
utilisé. Si l'objet "nom" appartient à un groupe, tout le groupe est
déplacé.</p></dd>
+<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 [, "nom"])</code>
-<p>Fait pivoter l'objet "nom" de la valeur "rot" en degrés relatifs. La
rotation est activée par le sommet sélectionné comme point de rotation - par
défaut, le sommet en haut à gauche est le point de rotation zéro. Les
valeurs positives signifient une rotation dans le sens des aiguilles d'une
montre, lorsque le point de rotation par défaut est utilisé. Si "nom" n'est
pas fourni, l'élément sélectionné est utilisé. </p></dd>
+<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>rotateObjectAbs(rot [, "nom"])</code>
-<p>Établit la rotation de l'objet "nom" Ã "rot". Des valeurs positives
signifient une rotation dans le sens des aiguilles d'une montre. Si "nom" n'est
pas fourni, l'élément sélectionné est utilisé. </p></dd>
+<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>scaleGroup(facteur [,"nom"])</code>
-<p>Redimensionne le groupe auquel l'objet "nom" appartient. Les valeurs
supérieures à 1 agrandissent le groupe, les valeurs inférieures à 1 rendent
le groupe plus petit, par exemple une valeur de 0.5 redimensionne le groupe Ã
50 % de sa taille originale, tandis qu'une valeur de 1.5 redimensionne le
groupe à 150 % de sa taille originale. La valeur de "facteur" doit être
supérieure à 0. Si le "nom" n'est pas fourni, l'élément sélectionné
courant est utilisé.</p>
-<p>Peut générer ValueError si le facteur de redimensionnement n'est pas
valide.</p></dd>
+<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="-setCharacterStyle"><strong>setCharacterStyle</strong></a>(...)</dt>
-<dd><code>setCharacterStyle("style" [, "nom"])</code>
-<p>Applique le "style" de caractère spécifié à l'objet "nom".</p>
-<p>Si le nom d'objet "nom" n'est pas spécifié, le style est appliqué à la
sélection d'objets courante.</p>
-<p>Si de multiples objets sont sélectionnés ou si l'objet sélectionné ne
comporte aucune sélection de texte, le style est appliqué aux objets
sélectionnés. Dans le cas contraire, le style est appliqué à la sélection
de texte courante.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> si l'objet
cible n'est pas un cadre de texte.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#NotFoundError">NotFoundError</a> si le nom de style
spécifié n'appartient pas au document courant.</p></dd>
+<dd><code>setCharacterStyle("style" [, "name"])</code>
+<p>Apply the named character "style" to the object named "name".</p>
+<p>If object name is not provided, style is applied on current object
selection.</p>
+<p>If multiple objects are selected or if selected object has no text
selection, style is applied on selected object(s). Otherwise style is applied
to the current text selection.</p>
+<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the
target frame is not a text frame.</p>
+<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if
specified style name does not exist in current document.</p></dd>
<dt><a
name="-setParagraphStyle"><strong>setParagraphStyle</strong></a>(...)</dt>
-<dd><code>setParagraphStyle("style" [, "nom"])</code>
-<p>Applique le "style" de paragraphe spécifié à l'objet "nom".</p>
-<p>Si le nom d'objet "nom" n'est pas spécifié, le style est appliqué à la
sélection d'objets courante.</p>
-<p>Si de multiples objets sont sélectionnés ou si l'objet sélectionné ne
comporte aucune sélection de texte, le style est appliqué aux objets
sélectionnés. Dans le cas contraire, le style est appliqué à la sélection
de texte courante.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> si l'objet
cible n'est pas un cadre de texte.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#NotFoundError">NotFoundError</a> si le nom de style
spécifié n'appartient pas au document courant.</p></dd>
+<dd><code>setParagraphStyle("style" [, "name"])</code>
+<p>Apply the named paragraph "style" to the object named "name".</p>
+<p>If object name is not provided, style is applied on current object
selection.</p>
+<p>If multiple objects are selected or if selected object has no text
selection, style is applied on selected object(s). Otherwise style is applied
to the current text selection.</p>
+<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the
target frame is not a text frame.</p>
+<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if
specified style name does not exist in current document.</p></dd>
<dt><a
name="-setScaleFrameToImage"><strong>setScaleFrameToImage</strong></a>(...)</dt>
-<dd><code>setScaleFrameToImage([nom])</code>
-<p>Redimensionne l'objet "nom" aux dimensions de l'image. Si "nom" n'est pas
fourni, l'élément sélectionné est utilisé</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
+<dd><code>setScaleFrameToImage([name])</code>
+<p>Set frame size on the selected or specified image frame to image size.</p>
+<p>May raise <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
<dt><a
name="-setScaleImageToFrame"><strong>setScaleImageToFrame</strong></a>(...)</dt>
-<dd><code>setScaleImageToFrame(redimAuCadre, proportionnel=None,
nom=<selection>)</code>
-<p>Établit le mode de redimensionnement par rapport au cadre d'image
sélectionné, ou spécifié dans 'redimAuCadre'.
-Si 'proportionnel' est spécifié, établit le redimensionnement en maintenant
des proportions fixes. 'redimAuCadre' et 'proportionnel' sont booléens.</p>
-<p>Peut générer l'exception <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
+<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 <a
href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a>.</p></dd>
<dt><a name="-setStyle"><strong>setStyle</strong></a>(...)</dt>
-<dd><code>setStyle("style" [, "nom"])</code>
-<p>Obsolète. Veuillez utiliser setParagraphStyle() en lieu et place.</p></dd>
+<dd><code>setStyle("style" [, "name"])</code>
+<p>Deprecated. Use setParagraphStyle() instead.</p></dd>
-<dt><a name="-setTextFlowMode"><strong>setTextFlowMode</strong></a>(...)</dt>
-<dd><code>setTextFlowMode("nom" [, etat])</code>
-<p>Active ou désactive l'habillage du texte pour l'objet "nom".</p>
-<p>Appelé avec les paramètres chaîne "nom" et l'entier optionnel "état" (0
<= "état" <= 3).
-Paramétrer "état" à la valeur 0 désactivera l'habillage du texte.
Paramétrer "état" à la valeur 1 habillera le texte selon le cadre de l'objet.
-Paramétrer "état" à la valeur 2 habillera le texte selon la bounding box de
l'objet. Paramétrer "état" à la valeur 3 habillera le texte selon la ligne
de contourde l'objet.
-Si l'argument"état" n'est pas passé, cette fonctionnalité change de valeur
(activée si inactive ou désactivée si active).</p></dd>
+<dt><a name="-setTextFlowMode"><strong>setTextFlowMode</strong>(...)</a></dt>
+<dd><code>setTextFlowMode("name" [, state])</code>
+<p>Enables/disables "Text Flows Around Frame" feature for object "name".</p>
+<p>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>
<dt><a name="-sizeObject"><strong>sizeObject</strong></a>(...)</dt>
-<dd><code>sizeObject(largeur, hauteur [, "nom"])</code>
-<p>Redimensionne l'objet "nom" à la largeur et à la hauteur données. Si
"nom" n'est pas fourni, l'élément sélectionné est utilisé. </p></dd>
+<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="-unGroupObjects"><strong>unGroupObjects</strong></a>(...)</dt>
-<dd><code>unGroupObjects("nom")</code>
-<p>Détruit le groupe auquel appartient l'objet "nom". Si le "nom" n'est pas
fourni, l'élément sélectionné est utilisé.</p></dd>
+<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="-textFlowMode"><strong>textFlowMode</strong></a>(...)</dt>
-<dd><code>textFlowMode("nom" [, etat])</code>
-<p>Obsolète. Veuillez utiliser setTextFlowMode() en lieu et place.</p></dd>
+<dt><a name="-textFlowMode"><strong>textFlowMode</strong>(...)</a></dt>
+<dd><code>textFlowMode("name" [, state])</code>
+<p>Deprecated. Use setTextFlowMode() instead.</p></dd>
</dl>
</body>
</html>
-
Modified: trunk/Scribus/scribus/plugins/scriptplugin/cmdobj.cpp
URL:
http://scribus.net/websvn/diff.php?repname=Scribus&rev=23691&path=/trunk/Scribus/scribus/plugins/scriptplugin/cmdobj.cpp
==============================================================================
--- trunk/Scribus/scribus/plugins/scriptplugin/cmdobj.cpp (original)
+++ trunk/Scribus/scribus/plugins/scriptplugin/cmdobj.cpp Tue May 5
16:20:38 2020
@@ -530,6 +530,19 @@
Py_RETURN_NONE;
}
+PyObject *scribus_gettextflowmode(PyObject* /* self */, PyObject* args)
+{
+ char *name = const_cast<char*>("");
+ if (!PyArg_ParseTuple(args, "|es", "utf-8", &name))
+ return NULL;
+ if (!checkHaveDocument())
+ return NULL;
+ PageItem *item = GetUniqueItem(QString::fromUtf8(name));
+ if (item == NULL)
+ return NULL;
+
+ return PyLong_FromLong(static_cast<int>(item->textFlowMode()));
+};
/* 03/21/2004 - exception raises by non existent name (subik)
*/
Modified: trunk/Scribus/scribus/plugins/scriptplugin/cmdobj.h
URL:
http://scribus.net/websvn/diff.php?repname=Scribus&rev=23691&path=/trunk/Scribus/scribus/plugins/scriptplugin/cmdobj.h
==============================================================================
--- trunk/Scribus/scribus/plugins/scriptplugin/cmdobj.h (original)
+++ trunk/Scribus/scribus/plugins/scriptplugin/cmdobj.h Tue May 5 16:20:38 2020
@@ -195,6 +195,21 @@
deleted else the active object erased. */
PyObject *scribus_deleteobj(PyObject * /*self*/, PyObject* args);
+PyDoc_STRVAR(scribus_gettextflowmode__doc__,
+QT_TR_NOOP("getTextFlowMode([\"name\"]) -> integer\n\
+\n\
+Return the current text flow mode used by item \"name\" as an integer.\n\
+If \"name\" is not given, the currently selected object is used.\n\
+\n\
+The function will return one of the following value:\n\
+- 0 : text flow around frame is disabled\n\
+- 1 : text flow around frame shape\n\
+- 2 : text flow around frame bounding box\n\
+- 3 : text flow around frame contour line\n\
+- 4 : text flow around image clip path\n\
+"));
+PyObject *scribus_gettextflowmode(PyObject * /*self*/, PyObject* args);
+
/*! docstring */
PyDoc_STRVAR(scribus_settextflowmode__doc__,
QT_TR_NOOP("setTextFlowMode(\"name\" [, state])\n\
Modified: trunk/Scribus/scribus/plugins/scriptplugin/scriptplugin.cpp
URL:
http://scribus.net/websvn/diff.php?repname=Scribus&rev=23691&path=/trunk/Scribus/scribus/plugins/scriptplugin/scriptplugin.cpp
==============================================================================
--- trunk/Scribus/scribus/plugins/scriptplugin/scriptplugin.cpp (original)
+++ trunk/Scribus/scribus/plugins/scriptplugin/scriptplugin.cpp Tue May 5
16:20:38 2020
@@ -403,6 +403,7 @@
{const_cast<char*>("getText"), scribus_getframetext, METH_VARARGS,
tr(scribus_gettext__doc__)}, // Deprecated
{const_cast<char*>("getTextColor"), scribus_gettextcolor, METH_VARARGS,
tr(scribus_gettextcolor__doc__)},
{const_cast<char*>("getTextDistances"), scribus_gettextdistances,
METH_VARARGS, tr(scribus_gettextdistances__doc__)},
+ {const_cast<char*>("getTextFlowMode"), scribus_gettextflowmode,
METH_VARARGS, tr(scribus_gettextflowmode__doc__)},
{const_cast<char*>("getTextLength"), scribus_gettextlength,
METH_VARARGS, tr(scribus_gettextlength__doc__)},
{const_cast<char*>("getTextLines"), scribus_gettextlines, METH_VARARGS,
tr(scribus_gettextlines__doc__)},
{const_cast<char*>("getTextShade"), scribus_gettextshade, METH_VARARGS,
tr(scribus_gettextshade__doc__)},
_______________________________________________
scribus-commit mailing list
scribus-commit@lists.scribus.net
http://lists.scribus.net/mailman/listinfo/scribus-commit
