← Back to branch summary

~scribus/scribus/trunk

« back to all changes in this revision

Viewing changes to doc/en/scripterapi-textframes.html

  • Committer: jghali
  • Date: 2018-10-14 10:31:03 UTC
  • Revision ID: svn-v4:11d20701-8431-0410-a711-e3c959e3b870:trunk/Scribus:22731
#15441: Text vertical alignment not accessible from python/scripter

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/scripterapi-textframes.html
67
67
<p>Returns the number of lines of the text in the text frame "name". If "name" is not given the currently selected item is used.</p></dd>
68
68
 
69
69
<dt><a name="-getTextShade"><strong>getTextShade</strong></a>(...)</dt>
70
 
<dd><code>getLineShade(["name"]) -&gt; integer</code>
 
70
<dd><code>getTextShade(["name"]) -&gt; integer</code>
71
71
<p>Returns the shading value of the line color of the object "name". If "name" is not given the currently selected item is used.</p></dd>
72
72
 
 
73
<dt><a name="-getTextVerticalAlignment"><strong>getTextVerticalAlignment</strong></a>(...)</dt>
 
74
<dd><code>getTextVerticalAlignment(["name"]) -&gt; integer</code>
 
75
<p>Gets the vertical alignment of text inside text frame "name". If "name" is not given the currently selected item is used.</p></dd>
 
76
 
73
77
<dt><a name="-hyphenateText"><strong>hyphenateText</strong></a>(...)</dt>
74
78
<dd><code>hyphenateText(["name"]) -&gt; bool</code>
75
79
<p>Does hyphenation on text frame "name". If "name" is not given the currently selected item is used.</p>
173
177
<dd><code>setTextStroke("color", ["name"])</code>
174
178
<p>Set "color" of the text stroke. If "name" is not given the currently selected item is used.</p></dd>
175
179
 
 
180
<dt><a name="-setTextVerticalAlignment"><strong>setTextVerticalAlignment</strong></a>(...)</dt>
 
181
<dd>
 
182
<code>setTextVerticalAlignment(align, ["name"])</code>
 
183
<p>Sets the vertical alignment of text inside text frame "name" to the specified alignment. If "name" is not given the currently selected item is used. "align" should be one of the ALIGNV_ constants defined in this module - see dir(scribus).</p>
 
184
<p>May throw ValueError for an invalid alignment constant.</p>
 
185
</dd>
 
186
 
176
187
<dt><a name="-textOverflows"><strong>textOverflows</strong></a>(...)</dt>
177
188
<dd><code>textOverflows(["name", nolinks]) -&gt; integer</code>
178
189
<p>Returns 1 if there are overflowing characters in text frame "name", 0 if not. If is nolinks set to non zero value it takes only one frame - it doesn't use text frame linking. Without this parameter it search all linking chain.</p>