document-settings.html
12.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Document settings — PHPRtfLite v1.x documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.x',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="PHPRtfLite v1.x documentation" href="index.html" />
<link rel="next" title="Sections" href="sections.html" />
<link rel="prev" title="Getting started" href="getting-started.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="sections.html" title="Sections"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="getting-started.html" title="Getting started"
accesskey="P">previous</a> |</li>
<li><a href="index.html">PHPRtfLite v1.x documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="document-settings">
<h1>Document settings<a class="headerlink" href="#document-settings" title="Permalink to this headline">¶</a></h1>
<div class="section" id="page-orientation">
<h2>Page orientation<a class="headerlink" href="#page-orientation" title="Permalink to this headline">¶</a></h2>
<p>You can use between <tt class="docutils literal"><span class="pre">landscape</span></tt> and <tt class="docutils literal"><span class="pre">portrait</span></tt> (default) page orientation.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// rtf document instance</span>
<span class="nv">$rtf</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">PHPRtfLite</span><span class="p">();</span>
<span class="c1">// landscape page orientation</span>
<span class="nv">$rtf</span><span class="o">-></span><span class="na">setLandscape</span><span class="p">();</span>
</pre></div>
</div>
</div>
<div class="section" id="page-margins">
<span id="doc-settings-page-margins"></span><h2>Page margins<a class="headerlink" href="#page-margins" title="Permalink to this headline">¶</a></h2>
<p>You can set margins for the document and for sections, too. Section margins will overwrite document margins.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="nv">$rtf</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">PHPRtfLite</span><span class="p">();</span>
<span class="c1">// margin left: 1cm</span>
<span class="nv">$rtf</span><span class="o">-></span><span class="na">setMarginLeft</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span>
<span class="c1">// margin right: 2cm</span>
<span class="nv">$rtf</span><span class="o">-></span><span class="na">setMarginRight</span><span class="p">(</span><span class="mi">2</span><span class="p">);</span>
<span class="c1">// margin top: 3cm</span>
<span class="nv">$rtf</span><span class="o">-></span><span class="na">setMarginTop</span><span class="p">(</span><span class="mi">3</span><span class="p">);</span>
<span class="c1">// margin bottom: 4cm</span>
<span class="nv">$rtf</span><span class="o">-></span><span class="na">setMarginBottom</span><span class="p">(</span><span class="mi">4</span><span class="p">);</span>
</pre></div>
</div>
<p>The code example below does the same in a shorter way.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="nv">$rtf</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">PHPRtfLite</span><span class="p">();</span>
<span class="c1">// margins: left 1cm, top 3cm, right 2cm, bottom 4cm</span>
<span class="nv">$rtf</span><span class="o">-></span><span class="na">setMargins</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">4</span><span class="p">);</span>
</pre></div>
</div>
<p>You can define that odd and even pages uses mirrored margins. Section margins can be mirrored, too, and will overwrite the document setting.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="nv">$rtf</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">PHPRtfLite</span><span class="p">();</span>
<span class="c1">// margin left: 2cm</span>
<span class="nv">$rtf</span><span class="o">-></span><span class="na">setMarginLeft</span><span class="p">(</span><span class="mi">2</span><span class="p">);</span>
<span class="c1">// margin right: 1cm</span>
<span class="nv">$rtf</span><span class="o">-></span><span class="na">setMarginRight</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span>
<span class="c1">// odd pages: left 2cm, right 1cm</span>
<span class="c1">// even pages: left 1cm, right 2cm</span>
<span class="nv">$rtf</span><span class="o">-></span><span class="na">setMirrorMarings</span><span class="p">();</span>
</pre></div>
</div>
</div>
<div class="section" id="page-size">
<span id="doc-settings-page-size"></span><h2>Page size<a class="headerlink" href="#page-size" title="Permalink to this headline">¶</a></h2>
<p>The paper width and height can be set for sections, too, which will overwrite the document settings.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="nv">$rtf</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">PHPRtfLite</span><span class="p">();</span>
<span class="nv">$rtf</span><span class="o">-></span><span class="na">setPaperWidth</span><span class="p">(</span><span class="mi">14</span><span class="p">);</span> <span class="c1">// in cm</span>
<span class="nv">$rtf</span><span class="o">-></span><span class="na">setPaperHeight</span><span class="p">(</span><span class="mi">25</span><span class="p">);</span> <span class="c1">// in cm</span>
</pre></div>
</div>
<div class="section" id="units-in-rtf">
<h3>Units in RTF<a class="headerlink" href="#units-in-rtf" title="Permalink to this headline">¶</a></h3>
<p>RTF uses TWIP (“TWentieth of an Inch Point” - 1/20 Point = 1/1440 Inch) <a class="footnote-reference" href="#f1" id="id1">[1]</a> as internal unit. PHPRtfLite uses centimeter as default unit for all measuring unit inputs.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="nx">PHPRtfLite_Unit</span><span class="o">::</span><span class="na">setGlobalUnit</span><span class="p">(</span><span class="nx">PHPRtfLite_Unit</span><span class="o">::</span><span class="na">UNIT_CM</span><span class="p">);</span> <span class="c1">// inputs used as centimeters</span>
<span class="nx">PHPRtfLite_Unit</span><span class="o">::</span><span class="na">setGlobalUnit</span><span class="p">(</span><span class="nx">PHPRtfLite_Unit</span><span class="o">::</span><span class="na">UNIT_INCH</span><span class="p">);</span> <span class="c1">// inputs used as inches</span>
<span class="nx">PHPRtfLite_Unit</span><span class="o">::</span><span class="na">setGlobalUnit</span><span class="p">(</span><span class="nx">PHPRtfLite_Unit</span><span class="o">::</span><span class="na">UNIT_POINT</span><span class="p">);</span> <span class="c1">// inputs used as points</span>
</pre></div>
</div>
<table class="docutils footnote" frame="void" id="f1" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td><a class="reference external" href="http://en.wikipedia.org/wiki/Twip">http://en.wikipedia.org/wiki/Twip</a></td></tr>
</tbody>
</table>
</div>
<div class="section" id="character-set-text-input">
<h3>Character set (text input)<a class="headerlink" href="#character-set-text-input" title="Permalink to this headline">¶</a></h3>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="nv">$rtf</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">PHPRtfLite</span><span class="p">();</span>
<span class="nv">$rtf</span><span class="o">-></span><span class="na">setCharset</span><span class="p">(</span><span class="s1">'Latin1'</span><span class="p">);</span> <span class="c1">// use Latin1 instead of UTF-8</span>
</pre></div>
</div>
</div>
<div class="section" id="hyphenation">
<h3>Hyphenation<a class="headerlink" href="#hyphenation" title="Permalink to this headline">¶</a></h3>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="nv">$rtf</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">PHPRtfLite</span><span class="p">();</span>
<span class="nv">$rtf</span><span class="o">-></span><span class="na">setHyphenation</span><span class="p">();</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Document settings</a><ul>
<li><a class="reference internal" href="#page-orientation">Page orientation</a></li>
<li><a class="reference internal" href="#page-margins">Page margins</a></li>
<li><a class="reference internal" href="#page-size">Page size</a><ul>
<li><a class="reference internal" href="#units-in-rtf">Units in RTF</a></li>
<li><a class="reference internal" href="#character-set-text-input">Character set (text input)</a></li>
<li><a class="reference internal" href="#hyphenation">Hyphenation</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="getting-started.html"
title="previous chapter">Getting started</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="sections.html"
title="next chapter">Sections</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/document-settings.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="sections.html" title="Sections"
>next</a> |</li>
<li class="right" >
<a href="getting-started.html" title="Getting started"
>previous</a> |</li>
<li><a href="index.html">PHPRtfLite v1.x documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2012, sigmaz.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>