r23384 by jghali - #15965: Scripter: getMasterPage() is not documented

scribus-commit scribus-commit at lists.scribus.net
Wed Nov 27 00:35:57 UTC 2019 

Author: jghali
Date: Wed Nov 27 00:35:57 2019
New Revision: 23384

URL: http://scribus.net/websvn/listing.php?repname=Scribus&sc=1&rev=23384
Log:
#15965: Scripter: getMasterPage() is not documented

Modified:
    trunk/Scribus/doc/de/scripterapi-page.html
    trunk/Scribus/doc/en/scripterapi-page.html
    trunk/Scribus/doc/fr/scripterapi-page.html
    trunk/Scribus/doc/it/scripterapi-page.html
    trunk/Scribus/doc/ru/scripterapi-page.html
    trunk/Scribus/scribus/plugins/scriptplugin/cmddoc.h

Modified: trunk/Scribus/doc/de/scripterapi-page.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=23384&path=/trunk/Scribus/doc/de/scripterapi-page.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi-page.html	(original)
+++ trunk/Scribus/doc/de/scripterapi-page.html	Wed Nov 27 00:35:57 2019
@@ -55,13 +55,14 @@
 <p>Returns a list containing positions of the horizontal guides. Values are in the
 document's current units - see UNIT_<type> constants.</p></dd>
 
+<dt><a name="-getMasterPage"><strong>getMasterPage</strong>(...)</a></dt>
+<dd><code>getMasterPage(nr) -> string</code>
+<p>Returns the name of master page applied to page "nr"</p>
+<p>May raise IndexError if the page number is out of range.</p></dd>
+
 <dt><a name="-getPageType"><strong>getPageType</strong>(...)</a></dt>
 <dd><code>getPageType() -> integer</code>
 <p>Returns the type of the Page, 0 means left Page, 1 is a middle Page and 2 is a right Page</p></dd>
-
-<dt><a name="-getVGuides"><strong>getVGuides</strong></a>(...)</dt>
-<dd><code>getVGuides()</code>
-<p>See <a href="#-getHGuides">getHGuides</a>.</p></dd>
 
 <dt><a name="-getPageItems"><strong>getPageItems</strong></a>(...)</dt>
 <dd><code>getPageItems() -> list</code>
@@ -82,6 +83,10 @@
 <dt><a name="-getPageNSize"><strong>getPageNSize</strong></a>(...)</dt>
 <dd><code>getPageNSize(nr) -> tuple</code>
 <p>Returns a tuple with a particular page's size measured in the document's current units. See UNIT_<type> constants and <a href="#-getPageMargins">getPageMargins</a>()</p></dd>
+
+<dt><a name="-getVGuides"><strong>getVGuides</strong></a>(...)</dt>
+<dd><code>getVGuides()</code>
+<p>See <a href="#-getHGuides">getHGuides</a>.</p></dd>
 
 <dt><a name="-gotoPage"><strong>gotoPage</strong></a>(...)</dt>
 <dd><code>gotoPage(nr)</code>

Modified: trunk/Scribus/doc/en/scripterapi-page.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=23384&path=/trunk/Scribus/doc/en/scripterapi-page.html
==============================================================================
--- trunk/Scribus/doc/en/scripterapi-page.html	(original)
+++ trunk/Scribus/doc/en/scripterapi-page.html	Wed Nov 27 00:35:57 2019
@@ -55,13 +55,14 @@
 <p>Returns a list containing positions of the horizontal guides. Values are in the
 document's current units - see UNIT_<type> constants.</p></dd>
 
+<dt><a name="-getMasterPage"><strong>getMasterPage</strong>(...)</a></dt>
+<dd><code>getMasterPage(nr) -> string</code>
+<p>Returns the name of master page applied to page "nr".</p>
+<p>May raise IndexError if the page number is out of range.</p></dd>
+
 <dt><a name="-getPageType"><strong>getPageType</strong>(...)</a></dt>
 <dd><code>getPageType() -> integer</code>
 <p>Returns the type of the Page, 0 means left Page, 1 is a middle Page and 2 is a right Page</p></dd>
-
-<dt><a name="-getVGuides"><strong>getVGuides</strong></a>(...)</dt>
-<dd><code>getVGuides()</code>
-<p>See <a href="#-getHGuides">getHGuides</a>.</p></dd>
 
 <dt><a name="-getPageItems"><strong>getPageItems</strong></a>(...)</dt>
 <dd><code>getPageItems() -> list</code>
@@ -82,6 +83,10 @@
 <dt><a name="-getPageNSize"><strong>getPageNSize</strong></a>(...)</dt>
 <dd><code>getPageNSize(nr) -> tuple</code>
 <p>Returns a tuple with a particular page's size measured in the document's current units. See UNIT_<type> constants and <a href="#-getPageMargins">getPageMargins</a>()</p></dd>
+
+<dt><a name="-getVGuides"><strong>getVGuides</strong></a>(...)</dt>
+<dd><code>getVGuides()</code>
+<p>See <a href="#-getHGuides">getHGuides</a>.</p></dd>
 
 <dt><a name="-gotoPage"><strong>gotoPage</strong></a>(...)</dt>
 <dd><code>gotoPage(nr)</code>

Modified: trunk/Scribus/doc/fr/scripterapi-page.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=23384&path=/trunk/Scribus/doc/fr/scripterapi-page.html
==============================================================================
--- trunk/Scribus/doc/fr/scripterapi-page.html	(original)
+++ trunk/Scribus/doc/fr/scripterapi-page.html	Wed Nov 27 00:35:57 2019
@@ -47,13 +47,14 @@
 <dd><code>getHGuides() -> liste</code>
 <p>Retourne une liste contenant les positions des guides horizontaux. Les valeurs sont dans les unités courantes du document - voir les constantes UNIT_<type>.</p></dd>
 
+<dt><a name="-getMasterPage"><strong>getMasterPage</strong>(...)</a></dt>
+<dd><code>getMasterPage(nr) -> chaîne</code>
+<p>Retourne le nom du gabarit appliqué à la page "nr".</p>
+<p>Peut générer IndexError si le numéro de page est hors limites.</p></dd>
+
 <dt><a name="-getPageType"><strong>getPageType</strong>(...)</a></dt>
 <dd><code>getPageType() -> entier</code>
 <p>Retourne le type de page : 0 indique une page gauche, 1 une page centrale et 2 une page droite</p></dd>
-
-<dt><a name="-getVGuides"><strong>getVGuides</strong></a>(...)</dt>
-<dd><code>getVGuides()</code>
-<p>Voir <a href="#-getHGuides">getHGuides</a>.</p></dd>
 
 <dt><a name="-getPageItems"><strong>getPageItems</strong></a>(...)</dt>
 <dd><code>getPageItems() -> liste</code>
@@ -74,6 +75,10 @@
 <dt><a name="-getPageNSize"><strong>getPageNSize</strong></a>(...)</dt>
 <dd><code>getPageNSize(nr) -> vecteur</code>
 <p>Retourne un vecteur avec les dimensions d'une page donnée mesurées dans les unités courantes du document. Voir les constantes UNIT_<type> et <a href="#-getPageMargins">getPageMargins</a>()</p></dd>
+
+<dt><a name="-getVGuides"><strong>getVGuides</strong></a>(...)</dt>
+<dd><code>getVGuides()</code>
+<p>Voir <a href="#-getHGuides">getHGuides</a>.</p></dd>
 
 <dt><a name="-gotoPage"><strong>gotoPage</strong></a>(...)</dt>
 <dd><code>gotoPage(nr)</code>

Modified: trunk/Scribus/doc/it/scripterapi-page.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=23384&path=/trunk/Scribus/doc/it/scripterapi-page.html
==============================================================================
--- trunk/Scribus/doc/it/scripterapi-page.html	(original)
+++ trunk/Scribus/doc/it/scripterapi-page.html	Wed Nov 27 00:35:57 2019
@@ -55,13 +55,14 @@
 <p>Returns a list containing positions of the horizontal guides. Values are in the
 document's current units - see UNIT_<type> constants.</p></dd>
 
+<dt><a name="-getMasterPage"><strong>getMasterPage</strong>(...)</a></dt>
+<dd><code>getMasterPage(nr) -> string</code>
+<p>Returns the name of master page applied to page "nr"</p>
+<p>May raise IndexError if the page number is out of range.</p></dd>
+
 <dt><a name="-getPageType"><strong>getPageType</strong>(...)</a></dt>
 <dd><code>getPageType() -> integer</code>
 <p>Returns the type of the Page, 0 means left Page, 1 is a middle Page and 2 is a right Page</p></dd>
-
-<dt><a name="-getVGuides"><strong>getVGuides</strong></a>(...)</dt>
-<dd><code>getVGuides()</code>
-<p>See <a href="#-getHGuides">getHGuides</a>.</p></dd>
 
 <dt><a name="-getPageItems"><strong>getPageItems</strong></a>(...)</dt>
 <dd><code>getPageItems() -> list</code>
@@ -82,6 +83,10 @@
 <dt><a name="-getPageNSize"><strong>getPageNSize</strong></a>(...)</dt>
 <dd><code>getPageNSize(nr) -> tuple</code>
 <p>Returns a tuple with a particular page's size measured in the document's current units. See UNIT_<type> constants and <a href="#-getPageMargins">getPageMargins</a>()</p></dd>
+
+<dt><a name="-getVGuides"><strong>getVGuides</strong></a>(...)</dt>
+<dd><code>getVGuides()</code>
+<p>See <a href="#-getHGuides">getHGuides</a>.</p></dd>
 
 <dt><a name="-gotoPage"><strong>gotoPage</strong></a>(...)</dt>
 <dd><code>gotoPage(nr)</code>

Modified: trunk/Scribus/doc/ru/scripterapi-page.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=23384&path=/trunk/Scribus/doc/ru/scripterapi-page.html
==============================================================================
--- trunk/Scribus/doc/ru/scripterapi-page.html	(original)
+++ trunk/Scribus/doc/ru/scripterapi-page.html	Wed Nov 27 00:35:57 2019
@@ -55,13 +55,14 @@
 <p>Returns a list containing positions of the horizontal guides. Values are in the
 document's current units - see UNIT_<type> constants.</p></dd>
 
+<dt><a name="-getMasterPage"><strong>getMasterPage</strong>(...)</a></dt>
+<dd><code>getMasterPage(nr) -> string</code>
+<p>Returns the name of master page applied to page "nr"</p>
+<p>May raise IndexError if the page number is out of range.</p></dd>
+
 <dt><a name="-getPageType"><strong>getPageType</strong>(...)</a></dt>
 <dd><code>getPageType() -> integer</code>
 <p>Returns the type of the Page, 0 means left Page, 1 is a middle Page and 2 is a right Page</p></dd>
-
-<dt><a name="-getVGuides"><strong>getVGuides</strong></a>(...)</dt>
-<dd><code>getVGuides()</code>
-<p>See <a href="#-getHGuides">getHGuides</a>.</p></dd>
 
 <dt><a name="-getPageItems"><strong>getPageItems</strong></a>(...)</dt>
 <dd><code>getPageItems() -> list</code>
@@ -82,6 +83,10 @@
 <dt><a name="-getPageNSize"><strong>getPageNSize</strong></a>(...)</dt>
 <dd><code>getPageNSize(nr) -> tuple</code>
 <p>Returns a tuple with a particular page's size measured in the document's current units. See UNIT_<type> constants and <a href="#-getPageMargins">getPageMargins</a>()</p></dd>
+
+<dt><a name="-getVGuides"><strong>getVGuides</strong></a>(...)</dt>
+<dd><code>getVGuides()</code>
+<p>See <a href="#-getHGuides">getHGuides</a>.</p></dd>
 
 <dt><a name="-gotoPage"><strong>gotoPage</strong></a>(...)</dt>
 <dd><code>gotoPage(nr)</code>

Modified: trunk/Scribus/scribus/plugins/scriptplugin/cmddoc.h
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=23384&path=/trunk/Scribus/scribus/plugins/scriptplugin/cmddoc.h
==============================================================================
--- trunk/Scribus/scribus/plugins/scriptplugin/cmddoc.h	(original)
+++ trunk/Scribus/scribus/plugins/scriptplugin/cmddoc.h	Wed Nov 27 00:35:57 2019
@@ -286,9 +286,9 @@
 PyObject* scribus_deletemasterpage(PyObject* self, PyObject* args);
 
 PyDoc_STRVAR(scribus_getmasterpage__doc__,
-QT_TR_NOOP("getMasterPage(nr)\n\
-\n\
-Get Master Page of the page \"nr\".\n\
+QT_TR_NOOP("getMasterPage(pageNr)\n\
+\n\
+Returns the name of master page applied to page \"nr\".\n\
 \n\
 May raise IndexError if the page number is out of range.\n\
 "));

More information about the scribus-commit mailing list