r22766 by jghali - Update some scripterapi-* files in DE and IT docs
scribus-commit
scribus-commit at lists.scribus.net
Sat Nov 17 20:38:06 UTC 2018
Author: jghali
Date: Sat Nov 17 20:38:06 2018
New Revision: 22766
URL: http://scribus.net/websvn/listing.php?repname=Scribus&sc=1&rev=22766
Log:
Update some scripterapi-* files in DE and IT docs
Modified:
trunk/Scribus/doc/de/scripterapi-constants.html
Modified: trunk/Scribus/doc/de/scripterapi-constants.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=22766&path=/trunk/Scribus/doc/de/scripterapi-constants.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi-constants.html (original)
+++ trunk/Scribus/doc/de/scripterapi-constants.html Sat Nov 17 20:38:06 2018
@@ -18,11 +18,13 @@
<pre>
if scribus.scribus_version_info[:3] < (1,2,2):
messageBox("Scribus - Python script",
- "This script requires Scribus 1.2.2 or newer. "+\
- "You're running %s." % scribus.scribus_version,
- ICON_CRITICAL)
+ "This script requires Scribus 1.2.2 or newer. "+"You're running %s." % scribus.scribus_version, scribus.ICON_CRITICAL)
sys.exit()
</pre>
+<p><em>Note that if you are using this style of import statement:</em></p>
+<pre>import scribus</pre>
+<p>you will need to add a prefix to these predefined constants, for example, <strong>scribus.ICON_CRITICAL</strong>.</p>
+
<h4>Unit Enumeration Constants: </h4>
<dl>
@@ -67,69 +69,123 @@
</dl>
<h4>Definitions for Page Formats: </h4>
+<p>If you are using these, it's important to understand that these constants are simply tuples of these specific numbers. There are now two sets of these constants for A and B series of paper formats.</p>
+<p>The original set, such as PAPER_A4, is used when a document is created with points units. Now you can also use the similarly named PAPER_A4_MM when you are using millimeters as the page units. As before, they must be used with the appropriate constant, either UNIT_POINTS or UNIT_MILLIMETERS. What you can then do, for example, is use them to create a document in points, then switch the units of the document with the setUnit() command.</p>
+<table><tr>
+<td>
<dl>
<dt>PAPER_A0</dt>
- <dd>Paperformat A0 = 2380 x 3368 Points</dd>
+ <dd>Paper format A0 = 2380 x 3368 Points</dd>
<dt>PAPER_A1</dt>
- <dd>Paperformat A1 = 1684 x 2380 Points</dd>
+ <dd>Paper format A1 = 1684 x 2380 Points</dd>
<dt>PAPER_A2</dt>
- <dd>Paperformat A2 = 1190 x 1684 Points</dd>
+ <dd>Paper format A2 = 1190 x 1684 Points</dd>
<dt>PAPER_A3</dt>
- <dd>Paperformat A3 = 842 x 1190 Points</dd>
+ <dd>Paper format A3 = 842 x 1190 Points</dd>
<dt>PAPER_A4</dt>
- <dd>Paperformat A4 = 595 x 842 Points</dd>
+ <dd>Paper format A4 = 595 x 842 Points</dd>
<dt>PAPER_A5</dt>
- <dd>Paperformat A5 = 421 x 595 Points</dd>
+ <dd>Paper format A5 = 421 x 595 Points</dd>
<dt>PAPER_A6</dt>
- <dd>Paperformat A6 = 297 x 421 Points</dd>
+ <dd>Paper format A6 = 297 x 421 Points</dd>
<dt>PAPER_A7</dt>
- <dd>Paperformat A7 = 210 x 297 Points</dd>
+ <dd>Paper format A7 = 210 x 297 Points</dd>
<dt>PAPER_A8</dt>
- <dd>Paperformat A8 = 148 x 210 Points</dd>
+ <dd>Paper format A8 = 148 x 210 Points</dd>
<dt>PAPER_A9</dt>
- <dd>Paperformat A9 = 105 x 148 Points</dd>
+ <dd>Paper format A9 = 105 x 148 Points</dd></dl></td>
+<td>
+<dl>
+ <dt>PAPER_A0_MM</dt>
+ <dd>Paper format A0 = 841 x 1189 Millimeters</dd>
+ <dt>PAPER_A1_MM</dt>
+ <dd>Paper format A1 = 594 x 841 Millimeters</dd>
+ <dt>PAPER_A2_MM</dt>
+ <dd>Paper format A2 = 420 x 594 Millimeters</dd>
+ <dt>PAPER_A3_MM</dt>
+ <dd>Paper format A3 = 297 x 420 Millimeters</dd>
+ <dt>PAPER_A4_MM</dt>
+ <dd>Paper format A4 = 210 x 297 Millimeters</dd>
+ <dt>PAPER_A5_MM</dt>
+ <dd>Paper format A5 = 148 x 210 Millimeters</dd>
+ <dt>PAPER_A6_MM</dt>
+ <dd>Paper format A6 = 105 x 148 Millimeters</dd>
+ <dt>PAPER_A7_MM</dt>
+ <dd>Paper format A7 = 74 x 105 Millimeters</dd>
+ <dt>PAPER_A8_MM</dt>
+ <dd>Paper format A8 = 52 x 74 Millimeters</dd>
+ <dt>PAPER_A9_MM</dt>
+ <dd>Paper format A9 = 37 x 52 Millimeters</dd></dl></td></tr>
+<tr><td>
+<dl>
<dt>PAPER_B0</dt>
- <dd>Paperformat B0 = 2836 x 4008 Points</dd>
+ <dd>Paper format B0 = 2836 x 4008 Points</dd>
<dt>PAPER_B1</dt>
- <dd>Paperformat B1 = 2004 x 2836 Points</dd>
+ <dd>Paper format B1 = 2004 x 2836 Points</dd>
<dt>PAPER_B2</dt>
- <dd>Paperformat B2 = 1418 x 2004 Points</dd>
+ <dd>Paper format B2 = 1418 x 2004 Points</dd>
<dt>PAPER_B3</dt>
- <dd>Paperformat B3 = 1002 x 1418 Points</dd>
+ <dd>Paper format B3 = 1002 x 1418 Points</dd>
<dt>PAPER_B4</dt>
- <dd>Paperformat B4 = 709 x 1002 Points</dd>
+ <dd>Paper format B4 = 709 x 1002 Points</dd>
<dt>PAPER_B5</dt>
- <dd>Paperformat B5 = 501 x 709 Points</dd>
+ <dd>Paper format B5 = 501 x 709 Points</dd>
<dt>PAPER_B6</dt>
- <dd>Paperformat B6 = 355 x 501 Points</dd>
+ <dd>Paper format B6 = 355 x 501 Points</dd>
<dt>PAPER_B7</dt>
- <dd>Paperformat B7 = 250 x 355 Points</dd>
+ <dd>Paper format B7 = 250 x 355 Points</dd>
<dt>PAPER_B8</dt>
- <dd>Paperformat B8 = 178 x 250 Points</dd>
+ <dd>Paper format B8 = 178 x 250 Points</dd>
<dt>PAPER_B9</dt>
- <dd>Paperformat B9 = 125 x 178 Points</dd>
+ <dd>Paper format B9 = 125 x 178 Points</dd>
<dt>PAPER_B10</dt>
- <dd>Paperformat B10 = 89 x 125 Points</dd>
+ <dd>Paper format B10 = 89 x 125 Points</dd></dl></td>
+<td>
+<dl>
+ <dt>PAPER_B0_MM</dt>
+ <dd>Paper format B0 = 1000 x 1414 Millimeters</dd>
+ <dt>PAPER_B1_MM</dt>
+ <dd>Paper format B1 = 707 x 1000 Millimeters</dd>
+ <dt>PAPER_B2_MM</dt>
+ <dd>Paper format B2 = 500 x 707 Millimeters</dd>
+ <dt>PAPER_B3_MM</dt>
+ <dd>Paper format B3 = 353 x 500 Millimeters</dd>
+ <dt>PAPER_B4_MM</dt>
+ <dd>Paper format B4 = 250 x 353 Millimeters</dd>
+ <dt>PAPER_B5_MM</dt>
+ <dd>Paper format B5 = 176 x 250 Millimeters</dd>
+ <dt>PAPER_B6_MM</dt>
+ <dd>Paper format B6 = 125 x 176 Millimeters</dd>
+ <dt>PAPER_B7_MM</dt>
+ <dd>Paper format B7 = 88 x 125 Millimeters</dd>
+ <dt>PAPER_B8_MM</dt>
+ <dd>Paper format B8 = 62 x 88 Millimeters</dd>
+ <dt>PAPER_B9_MM</dt>
+ <dd>Paper format B9 = 44 x 62 Millimeters</dd>
+ <dt>PAPER_B10_MM</dt>
+ <dd>Paper format B10 = 31 x 44 Millimeters</dd></dl></td></tr>
+<tr><td>
+<dl>
<dt>PAPER_C5E</dt>
- <dd>Paperformat C5E = 462 x 649 Points</dd>
+ <dd>Paper format C5E = 462 x 649 Points</dd>
<dt>PAPER_COMM10E</dt>
- <dd>Paperformat Comm10E = 298 x 683 Points</dd>
+ <dd>Paper format Comm10E = 298 x 683 Points</dd>
<dt>PAPER_DLE</dt>
- <dd>Paperformat DLE = 312 x 624 Points</dd>
+ <dd>Paper format DLE = 312 x 624 Points</dd>
<dt>PAPER_EXECUTIVE</dt>
- <dd>Paperformat Executive = 542 x 720 Points</dd>
+ <dd>Paper format Executive = 542 x 720 Points</dd>
<dt>PAPER_FOLIO</dt>
- <dd>Paperformat Folio = 595 x 935 Points</dd>
+ <dd>Paper format Folio = 595 x 935 Points</dd>
<dt>PAPER_LEDGER</dt>
- <dd>Paperformat Ledger = 1224 x 792 Points</dd>
+ <dd>Paper format Ledger = 1224 x 792 Points</dd>
<dt>PAPER_LEGAL</dt>
- <dd>Paperformat Legal = 612 x 1008 Points</dd>
+ <dd>Paper format Legal = 612 x 1008 Points</dd>
<dt>PAPER_LETTER</dt>
- <dd>Paperformat Letter = 612 x 792 Points</dd>
+ <dd>Paper format Letter = 612 x 792 Points</dd>
<dt>PAPER_TABLOID</dt>
- <dd>Paperformat Tabloid = 792 x 1224 Points</dd>
-</dl>
-
+ <dd>Paper format Tabloid = 792 x 1224 Points</dd>
+</dl></td></tr>
+</table>
<h4>Definitions for Document Layout:</h4>
<dl>
<dt>FACINGPAGES</dt>
@@ -163,9 +219,11 @@
<dt>LINE_DASHDOTDOT</dt>
<dt>LINE_DOT</dt>
<dt>LINE_SOLID</dt>
+ <dt><p/></dt>
<dt>JOIN_BEVEL</dt>
<dt>JOIN_MITTER</dt>
<dt>JOIN_ROUND</dt>
+ <dt><p/></dt>
<dt>CAP_FLAT</dt>
<dt>CAP_ROUND</dt>
<dt>CAP_SQUARE</dt>
@@ -183,16 +241,22 @@
</dl>
<h4>Dialog Buttons</h4>
-<dl>
- <dt>BUTTON_ABORT</dt>
- <dt>BUTTON_CANCEL</dt>
- <dt>BUTTON_IGNORE</dt>
- <dt>BUTTON_NO</dt>
- <dt>BUTTON_NONE</dt>
- <dt>BUTTON_OK</dt>
- <dt>BUTTON_RETRY</dt>
- <dt>BUTTON_YES</dt>
-</dl>
+<p>
+<table>
+<tr><td><strong>Button Type</strong></td><td><strong>Return Value</strong></td></tr>
+<tr> <td>BUTTON_ABORT</td><td>262144</td></tr>
+<tr> <td>BUTTON_CANCEL</td><td>4194304</td></tr>
+ <tr><td>BUTTON_IGNORE</td><td>1048576</td></tr>
+ <tr><td>BUTTON_NO</td><td>65536</td></tr>
+ <tr><td>BUTTON_NONE</td><td>N/A</td></tr>
+ <tr><td>BUTTON_OK</td><td>1024</td></tr>
+ <tr><td>BUTTON_RETRY</td><td>524288</td></tr>
+ <tr><td>BUTTON_YES</td><td>16384</td></tr>
+</table></p>
+
+<p>There is also a hierarchy of buttons in terms of how they appear in the dialogs, with this ordering, left to right:</p>
+<p>BUTTON_YES, BUTTON_NO, BUTTON_OK, BUTTON_RETRY, BUTTON_IGNORE, BUTTON_ABORT, BUTTON_CANCEL</p>
+<p>For example, even if you assign CANCEL to button1, RETRY to button2, and YES to button3, they will appear YES, RETRY, and CANCEL left to right in the dialog.</p>
<h4>Dialog Icons</h4>
<dl>
More information about the scribus-commit
mailing list