r15259 by jghali - #9204 : add missing getPageNSize() and getPageNMargins() to scripter docs

[scribus-commit]

Revision: 15259
Author: jghali
Date: 2010-06-23T20:31:02.152438Z
Commit message: #9204 : add missing getPageNSize() and getPageNMargins() to scripter docs

Changeset: 
M  /trunk/Scribus/scribus/plugins/scriptplugin/cmdpage.h
M  /trunk/Scribus/doc/en/scripterapi-page.html
M  /trunk/Scribus/doc/fr/scripterapi-page.html

Diffs:
Index: doc/en/scripterapi-page.html
===================================================================
--- doc/en/scripterapi-page.html	(revision 15258)
+++ doc/en/scripterapi-page.html	(revision 15259)
@@ -58,12 +58,20 @@
 
 <dt><a name="-getPageMargins"><strong>getPageMargins</strong></a>(...)</dt>
 <dd><code>getPageMargins()</code>
-<p>Returns the page margins as a (top, left, right, bottom) tuple in the current units. See UNIT_&lt;type&gt; constants and <a href="#-getPageSize">getPageSize</a>().</p></dd>
+<p>Returns the document page margins as a (top, left, right, bottom) tuple in the document's current units. See UNIT_&lt;type&gt; constants and <a href="#-getPageSize">getPageSize</a>().</p></dd>
 
+<dt><a name="-getPageNMargins"><strong>getPageNMargins</strong></a>(...)</dt>
+<dd><code>getPageNMargins(nr)</code>
+<p>Returns a tuple with a particular page's margins measured in the document's current units. See UNIT_&lt;type&gt; constants and <a href="#-getPageSize">getPageSize</a>().</p></dd>
+
 <dt><a name="-getPageSize"><strong>getPageSize</strong></a>(...)</dt>
 <dd><code>getPageSize() -&gt; tuple</code>
-<p>Returns a tuple with page dimensions measured in the document's current units. See UNIT_&lt;type&gt; constants and <a href="#-getPageMargins">getPageMargins</a>()</p></dd>
+<p>Returns a tuple with document page dimensions measured in the document's current units. See UNIT_&lt;type&gt; constants and <a href="#-getPageMargins">getPageMargins</a>()</p></dd>
 
+<dt><a name="-getPageNSize"><strong>getPageNSize</strong></a>(...)</dt>
+<dd><code>getPageNSize(nr) -&gt; tuple</code>
+<p>Returns a tuple with a particular page's size measured in the document's current units. See UNIT_&lt;type&gt; constants and <a href="#-getPageMargins">getPageMargins</a>()</p></dd>
+
 <dt><a name="-gotoPage"><strong>gotoPage</strong></a>(...)</dt>
 <dd><code>gotoPage(nr)</code>
 <p>Moves to the page "nr" (that is, makes the current page "nr"). Note that gotoPage doesn't (curently) change the page the user's view is displaying, it just sets the page that script commands will operates on.</p>
Index: doc/fr/scripterapi-page.html
===================================================================
--- doc/fr/scripterapi-page.html	(revision 15258)
+++ doc/fr/scripterapi-page.html	(revision 15259)
@@ -35,12 +35,20 @@
 
 <dt><a name="-getPageMargins"><strong>getPageMargins</strong></a>(...)</dt>
 <dd><code><a href="#-getPageMargins">getPageMargins</a>()</code>
-<p>Retourne les marges de la page comme un vecteur (haut, gauche, droite, bas) dans les unit&eacute;s courantes. Voir les constantes UNIT_&lt;type&gt; et <a href="#-getPageSize">getPageSize</a>().</p></dd>
+<p>Retourne les marges de page du document comme un vecteur (haut, gauche, droite, bas) dans les unit&eacute;s courantes du document. Voir les constantes UNIT_&lt;type&gt; et <a href="#-getPageSize">getPageSize</a>().</p></dd>
 
+<dt><a name="-getPageNMargins"><strong>getPageNMargins</strong></a>(...)</dt>
+<dd><code><a href="#-getPageNMargins">getPageNMargins</a>(nr)</code>
+<p>Retourne les marges d'une page donn&eacute;e comme un vecteur (haut, gauche, droite, bas) dans les unit&eacute;s courantes du document. Voir les constantes UNIT_&lt;type&gt; et <a href="#-getPageSize">getPageSize</a>().</p></dd>
+
 <dt><a name="-getPageSize"><strong>getPageSize</strong></a>(...)</dt>
 <dd><code><a href="#-getPageSize">getPageSize</a>() -&gt; vecteur</code>
-<p>Retourne un vecteur avec les dimensions de la page mesur&eacute;es dans les unit&eacute;s courantes du document. Voir les constantes UNIT_&lt;type&gt; et <a href="#-getPageMargins">getPageMargins</a>()</p></dd>
+<p>Retourne un vecteur avec les dimensions de page du document mesur&eacute;es dans les unit&eacute;s courantes du document. Voir les constantes UNIT_&lt;type&gt; et <a href="#-getPageMargins">getPageMargins</a>()</p></dd>
 
+<dt><a name="-getPageNSize"><strong>getPageNSize</strong></a>(...)</dt>
+<dd><code><a href="#-getPageNSize">getPageNSize</a>(nr) -&gt; vecteur</code>
+<p>Retourne un vecteur avec les dimensions d'une page donn&eacute;e mesur&eacute;es dans les unit&eacute;s courantes du document. Voir les constantes UNIT_&lt;type&gt; et <a href="#-getPageMargins">getPageMargins</a>()</p></dd>
+
 <dt><a name="-gotoPage"><strong>gotoPage</strong></a>(...)</dt>
 <dd><code><a href="#-gotoPage">gotoPage</a>(nr)</code>
 <p>D&eacute;place &agrave; la page "nr" (c'est-&agrave;-dire, la page courante devient "nr"). Notez que gotoPage ne change pas (actuellement) la page affich&eacute;e dans la vue de l'utilisateur; il &eacute;tablit simplement la page sur laquelle les commandes du script agiront.</p>
@@ -57,7 +65,7 @@
 
 <dt><a name="-pageDimension"><strong>pageDimension</strong></a>(...)</dt>
 <dd><code><a href="#-getPageSize">getPageSize</a>() -&gt; vecteur</code>
-<p>Alias. Retourne un vecteur avec les dimensions de la page mesur&eacute;es dans les unit&eacute;s courantes du document. Voir les constantes UNIT_&lt;type&gt; et <a href="#-getPageMargins">getPageMargins</a>()</p></dd>
+<p>Alias. Retourne un vecteur avec les dimensions de page du document mesur&eacute;es dans les unit&eacute;s courantes du document. Voir les constantes UNIT_&lt;type&gt; et <a href="#-getPageMargins">getPageMargins</a>()</p></dd>
 	
 <dt><a name="-redrawAll"><strong>redrawAll</strong></a>(...)</dt>
 <dd><code><a href="#-redrawAll">redrawAll</a>()</code>
Index: scribus/plugins/scriptplugin/cmdpage.h
===================================================================
--- scribus/plugins/scriptplugin/cmdpage.h	(revision 15258)
+++ scribus/plugins/scriptplugin/cmdpage.h	(revision 15259)
@@ -146,7 +146,7 @@
 PyDoc_STRVAR(scribus_pagedimension__doc__,
 QT_TR_NOOP("getPageSize() -> tuple\n\
 \n\
-Returns a tuple with page dimensions measured in the document's current units.\n\
+Returns a tuple with document page dimensions measured in the document's current units.\n\
 See UNIT_<type> constants and getPageMargins()\n\
 "));
 /**
@@ -158,7 +158,7 @@
 
 /*! docstring */
 PyDoc_STRVAR(scribus_pagensize__doc__,
-QT_TR_NOOP("getPageNSize() -> tuple\n\
+QT_TR_NOOP("getPageNSize(nr) -> tuple\n\
 \n\
 Returns a tuple with a particular page's size measured in the document's current units.\n\
 See UNIT_<type> constants and getPageMargins()\n\
@@ -170,8 +170,21 @@
 PyObject *scribus_pagensize(PyObject * /*self*/, PyObject* args);
 
 /*! docstring */
+PyDoc_STRVAR(scribus_getpagemargins__doc__,
+QT_TR_NOOP("getPageMargins()\n\
+\n\
+Returns the document page margins as a (top, left, right, bottom) tuple in the document's current\n\
+units. See UNIT_<type> constants and getPageSize().\n\
+"));
+/**
+returns a tuple with page margins
+Craig Ringer, Petr Vanek 09/25/2004
+*/
+PyObject *scribus_getpagemargins(PyObject * /*self*/);
+
+/*! docstring */
 PyDoc_STRVAR(scribus_pagenmargins__doc__,
-QT_TR_NOOP("getPageNMargins() -> tuple\n\
+QT_TR_NOOP("getPageNMargins(nr) -> tuple\n\
 \n\
 Returns a tuple with a particular page's margins measured in the document's current units.\n\
 See UNIT_<type> constants and getPageMargins()\n\
@@ -198,19 +211,6 @@
 */
 PyObject *scribus_getpageitems(PyObject * /*self*/);
 
-/*! docstring */
-PyDoc_STRVAR(scribus_getpagemargins__doc__,
-QT_TR_NOOP("getPageMargins()\n\
-\n\
-Returns the page margins as a (top, left, right, bottom) tuple in the current\n\
-units. See UNIT_<type> constants and getPageSize().\n\
-"));
-/**
-returns a tuple with page margins
-Craig Ringer, Petr Vanek 09/25/2004
-*/
-PyObject *scribus_getpagemargins(PyObject * /*self*/);
-
 /*! importpage */
 PyDoc_STRVAR(scribus_importpage__doc__,
 QT_TR_NOOP("importPage(\"fromDoc\", (pageList), [create, imortwhere, importwherePage])\n\