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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
--><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Apache log4cxx: FormattingInfo Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="namespacelog4cxx.html">log4cxx</a>::<a class="el" href="namespacelog4cxx_1_1pattern.html">pattern</a>::<a class="el" href="classlog4cxx_1_1pattern_1_1_formatting_info.html">FormattingInfo</a></div>
<h1>FormattingInfo Class Reference</h1><!-- doxytag: class="log4cxx::pattern::FormattingInfo" --><!-- doxytag: inherits="log4cxx::helpers::ObjectImpl" -->Inherits <a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html">ObjectImpl</a>.
<p>
<a href="classlog4cxx_1_1pattern_1_1_formatting_info-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Modifies the output of a pattern converter for a specified minimum and maximum width and alignment.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_formatting_info.html#f7d3e531d797cfaf2ae025c2337269a2">FormattingInfo</a> (const bool leftAlign, const int minLength, const int maxLength)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates new instance. <a href="#f7d3e531d797cfaf2ae025c2337269a2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_formatting_info.html#d34c7d74611cae9cc6082f46fee1f5d0">isLeftAligned</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine if left aligned. <a href="#d34c7d74611cae9cc6082f46fee1f5d0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_formatting_info.html#2cffeacf99fb5b1e4885749f2bde3d69">getMinLength</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get minimum length. <a href="#2cffeacf99fb5b1e4885749f2bde3d69"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_formatting_info.html#5a8945adb1aeef0526f2ec7aef3c8b8a">getMaxLength</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get maximum length. <a href="#5a8945adb1aeef0526f2ec7aef3c8b8a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_formatting_info.html#51ffecdd65e6e4607d56785d475ed225">format</a> (const int fieldStart, <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &buffer) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adjust the content of the buffer based on the specified lengths and alignment. <a href="#51ffecdd65e6e4607d56785d475ed225"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">FormattingInfoPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_formatting_info.html#96729ac9d2dfe8423b55b7b9c744c965">getDefault</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets default instance. <a href="#96729ac9d2dfe8423b55b7b9c744c965"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="f7d3e531d797cfaf2ae025c2337269a2"></a><!-- doxytag: member="log4cxx::pattern::FormattingInfo::FormattingInfo" ref="f7d3e531d797cfaf2ae025c2337269a2" args="(const bool leftAlign, const int minLength, const int maxLength)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classlog4cxx_1_1pattern_1_1_formatting_info.html">FormattingInfo</a> </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const bool </td>
<td class="mdname" nowrap> <em>leftAlign</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const int </td>
<td class="mdname" nowrap> <em>minLength</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const int </td>
<td class="mdname" nowrap> <em>maxLength</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Creates new instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>leftAlign</em> </td><td>left align if true. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>minLength</em> </td><td>minimum length. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>maxLength</em> </td><td>maximum length. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="51ffecdd65e6e4607d56785d475ed225"></a><!-- doxytag: member="log4cxx::pattern::FormattingInfo::format" ref="51ffecdd65e6e4607d56785d475ed225" args="(const int fieldStart, LogString &buffer) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void format </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const int </td>
<td class="mdname" nowrap> <em>fieldStart</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="mdname" nowrap> <em>buffer</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Adjust the content of the buffer based on the specified lengths and alignment.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>fieldStart</em> </td><td>start of field in buffer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>buffer to be modified. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="96729ac9d2dfe8423b55b7b9c744c965"></a><!-- doxytag: member="log4cxx::pattern::FormattingInfo::getDefault" ref="96729ac9d2dfe8423b55b7b9c744c965" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">static <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">FormattingInfoPtr</a> getDefault </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Gets default instance.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>default instance. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="5a8945adb1aeef0526f2ec7aef3c8b8a"></a><!-- doxytag: member="log4cxx::pattern::FormattingInfo::getMaxLength" ref="5a8945adb1aeef0526f2ec7aef3c8b8a" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int getMaxLength </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get maximum length.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>maximum length. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="2cffeacf99fb5b1e4885749f2bde3d69"></a><!-- doxytag: member="log4cxx::pattern::FormattingInfo::getMinLength" ref="2cffeacf99fb5b1e4885749f2bde3d69" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int getMinLength </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get minimum length.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>minimum length. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="d34c7d74611cae9cc6082f46fee1f5d0"></a><!-- doxytag: member="log4cxx::pattern::FormattingInfo::isLeftAligned" ref="d34c7d74611cae9cc6082f46fee1f5d0" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool isLeftAligned </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Determine if left aligned.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>true if left aligned. </dd></dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="formattinginfo_8h.html">formattinginfo.h</a></ul>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
</BODY>
</HTML>
|
