r24014 by jghali - Add scripter setBleeds() to documentation
scribus-commit
scribus-commit at lists.scribus.net
Mon Sep 14 14:34:49 UTC 2020
Author: jghali
Date: Mon Sep 14 14:34:49 2020
New Revision: 24014
URL: http://scribus.net/websvn/listing.php?repname=Scribus&sc=1&rev=24014
Log:
Add scripter setBleeds() to documentation
Modified:
trunk/Scribus/doc/de/scripterapi-doc.html
trunk/Scribus/doc/en/scripterapi-doc.html
trunk/Scribus/doc/fr/scripterapi-doc.html
trunk/Scribus/doc/it/scripterapi-doc.html
trunk/Scribus/doc/ru/scripterapi-doc.html
trunk/Scribus/scribus/plugins/scriptplugin/cmddoc.h
Modified: trunk/Scribus/doc/de/scripterapi-doc.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=24014&path=/trunk/Scribus/doc/de/scripterapi-doc.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi-doc.html (original)
+++ trunk/Scribus/doc/de/scripterapi-doc.html Mon Sep 14 14:34:49 2020
@@ -154,6 +154,18 @@
relative path).</p>
<p>May raise ScribusError if the save fails.</p></dd>
+<dt><a name="-setBaseLine"><strong>setBaseLine</strong></a>(...)</dt>
+<dd><code>setBaseLine(grid, offset)</code>
+<p>Sets the base line settings of the document, grid spacing(grid), grid offset(offset). Values are given in the measurement units of the document - see UNIT_<type> constants.</p></dd>
+
+<dt><a name="-setBleeds"><strong>setBleeds</strong></a>(...)</dt>
+<dd><code>setBleeds(lr, rr, tr, br)</code>
+<p>Sets the bleeds of the document. Left(lr), Right(rr), Top(tr) and Bottom(br) bleeds are given in the measurement units of the document - see UNIT_<type> constants.</p></dd>
+
+<dt><a name="-setDocType"><strong>setDocType</strong></a>(...)</dt>
+<dd><code>setDocType(facingPages, firstPageLeft)</code>
+<p>Sets the document type. To get facing pages set the first parameter to FACINGPAGES, to switch facingPages off use NOFACINGPAGES instead. If you want to be the first page a left side set the second parameter to FIRSTPAGELEFT, for a right page use FIRSTPAGERIGHT.</p></dd>
+
<dt><a name="-setInfo"><strong>setInfo</strong></a>(...)</dt>
<dd><code>setInfo("author", "info", "description") -> bool</code>
<p>Sets the document information. "Author", "Info", "Description" are strings.</p></dd>
@@ -162,10 +174,6 @@
<dd><code>setMargins(lr, rr, tr, br)</code>
<p>Sets the margins of the document, Left(lr), Right(rr), Top(tr) and Bottom(br) margins are given in the measurement units of the document - see UNIT_<type> constants.</p></dd>
-<dt><a name="-setDocType"><strong>setDocType</strong></a>(...)</dt>
-<dd><code>setDocType(facingPages, firstPageLeft)</code>
-<p>Sets the document type. To get facing pages set the first parameter to FACINGPAGES, to switch facingPages off use NOFACINGPAGES instead. If you want to be the first page a left side set the second parameter to FIRSTPAGELEFT, for a right page use FIRSTPAGERIGHT.</p></dd>
-
<dt><a name="-setUnit"><strong>setUnit</strong></a>(...)</dt>
<dd><code>setUnit(type)</code>
<p>Changes the measurement unit of the document. Possible values for "unit" are defined as constants UNIT_<type>.</p>
@@ -173,10 +181,6 @@
<p>As noted above, typically you may use this command so that you can change the measurement units to something else, for which you are creating or modifying objects based some particular units, like points, after which you want to return to whatever the original units were.</p><p><b>original = getUnit()</b></p>
<p><i>do some operations...then later</i></p>
<p><b>setUnit(original)</b></p></dd>
-
-<dt><a name="-setBaseLine"><strong>setBaseLine</strong></a>(...)</dt>
-<dd><code>setBaseLine(grid, offset)</code>
-<p>Sets the base line settings of the document, grid spacing(grid), grid offset(offset). Values are given in the measurement units of the document - see UNIT_<type> constants.</p></dd>
<dt><a name="-scrollDocument"><strong>scrollDocument</strong>(...)</a></dt>
<dd><code>scrollDocument(x,y)</code>
Modified: trunk/Scribus/doc/en/scripterapi-doc.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=24014&path=/trunk/Scribus/doc/en/scripterapi-doc.html
==============================================================================
--- trunk/Scribus/doc/en/scripterapi-doc.html (original)
+++ trunk/Scribus/doc/en/scripterapi-doc.html Mon Sep 14 14:34:49 2020
@@ -154,6 +154,18 @@
relative path).</p>
<p>May raise ScribusError if the save fails.</p></dd>
+<dt><a name="-setBaseLine"><strong>setBaseLine</strong></a>(...)</dt>
+<dd><code>setBaseLine(grid, offset)</code>
+<p>Sets the base line settings of the document, grid spacing(grid), grid offset(offset). Values are given in the measurement units of the document - see UNIT_<type> constants.</p></dd>
+
+<dt><a name="-setBleeds"><strong>setBleeds</strong></a>(...)</dt>
+<dd><code>setBleeds(lr, rr, tr, br)</code>
+<p>Sets the bleeds of the document. Left(lr), Right(rr), Top(tr) and Bottom(br) bleeds are given in the measurement units of the document - see UNIT_<type> constants.</p></dd>
+
+<dt><a name="-setDocType"><strong>setDocType</strong></a>(...)</dt>
+<dd><code>setDocType(facingPages, firstPageLeft)</code>
+<p>Sets the document type. To get facing pages set the first parameter to FACINGPAGES, to switch facingPages off use NOFACINGPAGES instead. If you want to be the first page a left side set the second parameter to FIRSTPAGELEFT, for a right page use FIRSTPAGERIGHT.</p></dd>
+
<dt><a name="-setInfo"><strong>setInfo</strong></a>(...)</dt>
<dd><code>setInfo("author", "info", "description") -> bool</code>
<p>Sets the document information. "Author", "Info", "Description" are strings.</p></dd>
@@ -162,10 +174,6 @@
<dd><code>setMargins(lr, rr, tr, br)</code>
<p>Sets the margins of the document, Left(lr), Right(rr), Top(tr) and Bottom(br) margins are given in the measurement units of the document - see UNIT_<type> constants.</p></dd>
-<dt><a name="-setDocType"><strong>setDocType</strong></a>(...)</dt>
-<dd><code>setDocType(facingPages, firstPageLeft)</code>
-<p>Sets the document type. To get facing pages set the first parameter to FACINGPAGES, to switch facingPages off use NOFACINGPAGES instead. If you want to be the first page a left side set the second parameter to FIRSTPAGELEFT, for a right page use FIRSTPAGERIGHT.</p></dd>
-
<dt><a name="-setUnit"><strong>setUnit</strong></a>(...)</dt>
<dd><code>setUnit(type)</code>
<p>Changes the measurement unit of the document. Possible values for "unit" are defined as constants UNIT_<type>.</p>
@@ -173,10 +181,6 @@
<p>As noted above, typically you may use this command so that you can change the measurement units to something else, for which you are creating or modifying objects based some particular units, like points, after which you want to return to whatever the original units were.</p><p><b>original = getUnit()</b></p>
<p><i>do some operations...then later</i></p>
<p><b>setUnit(original)</b></p></dd>
-
-<dt><a name="-setBaseLine"><strong>setBaseLine</strong></a>(...)</dt>
-<dd><code>setBaseLine(grid, offset)</code>
-<p>Sets the base line settings of the document, grid spacing(grid), grid offset(offset). Values are given in the measurement units of the document - see UNIT_<type> constants.</p></dd>
<dt><a name="-scrollDocument"><strong>scrollDocument</strong>(...)</a></dt>
<dd><code>scrollDocument(x,y)</code>
Modified: trunk/Scribus/doc/fr/scripterapi-doc.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=24014&path=/trunk/Scribus/doc/fr/scripterapi-doc.html
==============================================================================
--- trunk/Scribus/doc/fr/scripterapi-doc.html (original)
+++ trunk/Scribus/doc/fr/scripterapi-doc.html Mon Sep 14 14:34:49 2020
@@ -122,6 +122,18 @@
<p>Enregistre le document courant sous le nouveau "nom" (qui peut être un chemin complet ou relatif).</p>
<p>Peut générer ScribusError si l'enregistrement échoue.</p></dd>
+<dt><a name="-setBaseLine"><strong>setBaseLine</strong></a>(...)</dt>
+<dd><code>setBaseLine(grid, offset)</code>
+<p>Définit les valeurs de la ligne de base du document: espacement de la grille(grid), offset de la grille(offset). Les valeurs sont définies dans les unités de mesure du document - voir les constantes UNIT_<type>.</p></dd>
+
+<dt><a name="-setBleeds"><strong>setBleeds</strong></a>(...)</dt>
+<dd><code>setBleeds(lr, rr, tr, br)</code>
+<p>Définit les valeurs de fonds perdus du document. Les valeurs de fonds perdus à gauche (lr), à droite (rr), en haut (tr) et en bas (br) sont définies dans les unités de mesure du document - voir les constantes UNIT_<type>.</p></dd>
+
+<dt><a name="-setDocType"><strong>setDocType</strong></a>(...)</dt>
+<dd><code>setDocType(pagesRegard, premierePageGauche)</code>
+<p>Assigne le type de document. Pour obtenir des pages en regard, mettez le premier paramètre à FACINGPAGES; pour désactiver facingPages, utilisez NOFACINGPAGES à la place. Si vous voulez que la première page soit à gauche, mettez le deuxième paramètre à FIRSTPAGELEFT; pour une première page à droite, utilisez FIRSTPAGERIGHT.</p></dd>
+
<dt><a name="-setInfo"><strong>setInfo</strong></a>(...)</dt>
<dd><code>saveDocAs("auteur", "info",
"description") -> booléen</code>
@@ -134,15 +146,19 @@
Haut(tr) et Bas(br) sont indiquées dans les unités de mesure du
document - voir les constantes UNIT_<type>.</p></dd>
-<dt><a name="-setDocType"><strong>setDocType</strong></a>(...)</dt>
-<dd><code>setDocType(pagesRegard, premierePageGauche)</code>
-<p>Assigne le type de document. Pour obtenir des pages en regard, mettez le premier paramètre à FACINGPAGES; pour désactiver facingPages, utilisez NOFACINGPAGES à la place. Si vous voulez que la première page soit à gauche, mettez le deuxième paramètre à FIRSTPAGELEFT; pour une première page à droite, utilisez FIRSTPAGERIGHT.</p></dd>
-
<dt><a name="-setUnit"><strong>setUnit</strong></a>(...)</dt>
<dd><code>setUnit(type)</code>
<p>Change l'unité de mesure du document. Les valeurs possibles de l'"unité" sont définies par les constantes UNIT_<type>.</p>
<p>Peut générer ValueError si l'unité passée n'est pas valide.</p></dd>
+<dt><a name="-scrollDocument"><strong>scrollDocument</strong>(...)</a></dt>
+<dd><code>scrollDocument(x, y)</code>
+<p>Scrolle le document affiché dans la fenêtre active par les valeurs x and y.</p></dd>
+
+<dt><a name="-zoomDocument"><strong>zoomDocument</strong>(...)</a></dt>
+<dd><code>zoomDocument(double)</code>
+<p>Effectue un zoom du document affiché dans la fenêtre active. Les valeurs de zoom prennent des valeurs positives telles que 20.0, 100.0, etc. Vous pouvez utiliser la valeur spéciale -100.0 pour ajuster automatiquement la valeur de zoom.</p></dd>
+
</dl>
</body>
</html>
Modified: trunk/Scribus/doc/it/scripterapi-doc.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=24014&path=/trunk/Scribus/doc/it/scripterapi-doc.html
==============================================================================
--- trunk/Scribus/doc/it/scripterapi-doc.html (original)
+++ trunk/Scribus/doc/it/scripterapi-doc.html Mon Sep 14 14:34:49 2020
@@ -154,6 +154,18 @@
relative path).</p>
<p>May raise ScribusError if the save fails.</p></dd>
+<dt><a name="-setBaseLine"><strong>setBaseLine</strong></a>(...)</dt>
+<dd><code>setBaseLine(grid, offset)</code>
+<p>Sets the base line settings of the document, grid spacing(grid), grid offset(offset). Values are given in the measurement units of the document - see UNIT_<type> constants.</p></dd>
+
+<dt><a name="-setBleeds"><strong>setBleeds</strong></a>(...)</dt>
+<dd><code>setBleeds(lr, rr, tr, br)</code>
+<p>Sets the bleeds of the document. Left(lr), Right(rr), Top(tr) and Bottom(br) bleeds are given in the measurement units of the document - see UNIT_<type> constants.</p></dd>
+
+<dt><a name="-setDocType"><strong>setDocType</strong></a>(...)</dt>
+<dd><code>setDocType(facingPages, firstPageLeft)</code>
+<p>Sets the document type. To get facing pages set the first parameter to FACINGPAGES, to switch facingPages off use NOFACINGPAGES instead. If you want to be the first page a left side set the second parameter to FIRSTPAGELEFT, for a right page use FIRSTPAGERIGHT.</p></dd>
+
<dt><a name="-setInfo"><strong>setInfo</strong></a>(...)</dt>
<dd><code>setInfo("author", "info", "description") -> bool</code>
<p>Sets the document information. "Author", "Info", "Description" are strings.</p></dd>
@@ -162,10 +174,6 @@
<dd><code>setMargins(lr, rr, tr, br)</code>
<p>Sets the margins of the document, Left(lr), Right(rr), Top(tr) and Bottom(br) margins are given in the measurement units of the document - see UNIT_<type> constants.</p></dd>
-<dt><a name="-setDocType"><strong>setDocType</strong></a>(...)</dt>
-<dd><code>setDocType(facingPages, firstPageLeft)</code>
-<p>Sets the document type. To get facing pages set the first parameter to FACINGPAGES, to switch facingPages off use NOFACINGPAGES instead. If you want to be the first page a left side set the second parameter to FIRSTPAGELEFT, for a right page use FIRSTPAGERIGHT.</p></dd>
-
<dt><a name="-setUnit"><strong>setUnit</strong></a>(...)</dt>
<dd><code>setUnit(type)</code>
<p>Changes the measurement unit of the document. Possible values for "unit" are defined as constants UNIT_<type>.</p>
@@ -173,10 +181,6 @@
<p>As noted above, typically you may use this command so that you can change the measurement units to something else, for which you are creating or modifying objects based some particular units, like points, after which you want to return to whatever the original units were.</p><p><b>original = getUnit()</b></p>
<p><i>do some operations...then later</i></p>
<p><b>setUnit(original)</b></p></dd>
-
-<dt><a name="-setBaseLine"><strong>setBaseLine</strong></a>(...)</dt>
-<dd><code>setBaseLine(grid, offset)</code>
-<p>Sets the base line settings of the document, grid spacing(grid), grid offset(offset). Values are given in the measurement units of the document - see UNIT_<type> constants.</p></dd>
<dt><a name="-scrollDocument"><strong>scrollDocument</strong>(...)</a></dt>
<dd><code>scrollDocument(x,y)</code>
Modified: trunk/Scribus/doc/ru/scripterapi-doc.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=24014&path=/trunk/Scribus/doc/ru/scripterapi-doc.html
==============================================================================
--- trunk/Scribus/doc/ru/scripterapi-doc.html (original)
+++ trunk/Scribus/doc/ru/scripterapi-doc.html Mon Sep 14 14:34:49 2020
@@ -154,6 +154,18 @@
relative path).</p>
<p>May raise ScribusError if the save fails.</p></dd>
+<dt><a name="-setBaseLine"><strong>setBaseLine</strong></a>(...)</dt>
+<dd><code>setBaseLine(grid, offset)</code>
+<p>Sets the base line settings of the document, grid spacing(grid), grid offset(offset). Values are given in the measurement units of the document - see UNIT_<type> constants.</p></dd>
+
+<dt><a name="-setBleeds"><strong>setBleeds</strong></a>(...)</dt>
+<dd><code>setBleeds(lr, rr, tr, br)</code>
+<p>Sets the bleeds of the document. Left(lr), Right(rr), Top(tr) and Bottom(br) bleeds are given in the measurement units of the document - see UNIT_<type> constants.</p></dd>
+
+<dt><a name="-setDocType"><strong>setDocType</strong></a>(...)</dt>
+<dd><code>setDocType(facingPages, firstPageLeft)</code>
+<p>Sets the document type. To get facing pages set the first parameter to FACINGPAGES, to switch facingPages off use NOFACINGPAGES instead. If you want to be the first page a left side set the second parameter to FIRSTPAGELEFT, for a right page use FIRSTPAGERIGHT.</p></dd>
+
<dt><a name="-setInfo"><strong>setInfo</strong></a>(...)</dt>
<dd><code>setInfo("author", "info", "description") -> bool</code>
<p>Sets the document information. "Author", "Info", "Description" are strings.</p></dd>
@@ -162,10 +174,6 @@
<dd><code>setMargins(lr, rr, tr, br)</code>
<p>Sets the margins of the document, Left(lr), Right(rr), Top(tr) and Bottom(br) margins are given in the measurement units of the document - see UNIT_<type> constants.</p></dd>
-<dt><a name="-setDocType"><strong>setDocType</strong></a>(...)</dt>
-<dd><code>setDocType(facingPages, firstPageLeft)</code>
-<p>Sets the document type. To get facing pages set the first parameter to FACINGPAGES, to switch facingPages off use NOFACINGPAGES instead. If you want to be the first page a left side set the second parameter to FIRSTPAGELEFT, for a right page use FIRSTPAGERIGHT.</p></dd>
-
<dt><a name="-setUnit"><strong>setUnit</strong></a>(...)</dt>
<dd><code>setUnit(type)</code>
<p>Changes the measurement unit of the document. Possible values for "unit" are defined as constants UNIT_<type>.</p>
@@ -173,10 +181,6 @@
<p>As noted above, typically you may use this command so that you can change the measurement units to something else, for which you are creating or modifying objects based some particular units, like points, after which you want to return to whatever the original units were.</p><p><b>original = getUnit()</b></p>
<p><i>do some operations...then later</i></p>
<p><b>setUnit(original)</b></p></dd>
-
-<dt><a name="-setBaseLine"><strong>setBaseLine</strong></a>(...)</dt>
-<dd><code>setBaseLine(grid, offset)</code>
-<p>Sets the base line settings of the document, grid spacing(grid), grid offset(offset). Values are given in the measurement units of the document - see UNIT_<type> constants.</p></dd>
<dt><a name="-scrollDocument"><strong>scrollDocument</strong>(...)</a></dt>
<dd><code>scrollDocument(x,y)</code>
Modified: trunk/Scribus/scribus/plugins/scriptplugin/cmddoc.h
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=24014&path=/trunk/Scribus/scribus/plugins/scriptplugin/cmddoc.h
==============================================================================
--- trunk/Scribus/scribus/plugins/scriptplugin/cmddoc.h (original)
+++ trunk/Scribus/scribus/plugins/scriptplugin/cmddoc.h Mon Sep 14 14:34:49 2020
@@ -185,7 +185,7 @@
PyDoc_STRVAR(scribus_setbleeds__doc__,
QT_TR_NOOP("setBleeds(lr, rr, tr, br)\n\
\n\
-Sets the bleeds of the document, Left(lr), Right(rr), Top(tr) and Bottom(br)\n\
+Sets the bleeds of the document. Left(lr), Right(rr), Top(tr) and Bottom(br)\n\
bleeds are given in the measurement units of the document - see UNIT_<type>\n\
constants.\n\
"));
More information about the scribus-commit
mailing list