<!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/xhtml;charset=UTF-8"/>
<title>Apache log4cxx: FormattingInfo Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache log4cxx <span id="projectnumber">Version 0.10.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classlog4cxx_1_1pattern_1_1_formatting_info.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<h1>FormattingInfo Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::pattern::FormattingInfo" --><!-- doxytag: inherits="log4cxx::helpers::ObjectImpl" -->
<p>Modifies the output of a pattern converter for a specified minimum and maximum width and alignment.
<a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html">log4cxx::helpers::ObjectImpl</a>.</p>
<p><a href="classlog4cxx_1_1pattern_1_1_formatting_info-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_formatting_info.html#af7d3e531d797cfaf2ae025c2337269a2">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="#af7d3e531d797cfaf2ae025c2337269a2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_formatting_info.html#ad34c7d74611cae9cc6082f46fee1f5d0">isLeftAligned</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine if left aligned. <a href="#ad34c7d74611cae9cc6082f46fee1f5d0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_formatting_info.html#a2cffeacf99fb5b1e4885749f2bde3d69">getMinLength</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get minimum length. <a href="#a2cffeacf99fb5b1e4885749f2bde3d69"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_formatting_info.html#a5a8945adb1aeef0526f2ec7aef3c8b8a">getMaxLength</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get maximum length. <a href="#a5a8945adb1aeef0526f2ec7aef3c8b8a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_formatting_info.html#a51ffecdd65e6e4607d56785d475ed225">format</a> (const int fieldStart, <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">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="#a51ffecdd65e6e4607d56785d475ed225"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" 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#a96729ac9d2dfe8423b55b7b9c744c965">getDefault</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets default instance. <a href="#a96729ac9d2dfe8423b55b7b9c744c965"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Modifies the output of a pattern converter for a specified minimum and maximum width and alignment. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af7d3e531d797cfaf2ae025c2337269a2"></a><!-- doxytag: member="log4cxx::pattern::FormattingInfo::FormattingInfo" ref="af7d3e531d797cfaf2ae025c2337269a2" args="(const bool leftAlign, const int minLength, const int maxLength)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1pattern_1_1_formatting_info.html">FormattingInfo</a> </td>
<td>(</td>
<td class="paramtype">const bool </td>
<td class="paramname"><em>leftAlign</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>minLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>maxLength</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates new instance. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">leftAlign</td><td>left align if true. </td></tr>
<tr><td class="paramname">minLength</td><td>minimum length. </td></tr>
<tr><td class="paramname">maxLength</td><td>maximum length. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a51ffecdd65e6e4607d56785d475ed225"></a><!-- doxytag: member="log4cxx::pattern::FormattingInfo::format" ref="a51ffecdd65e6e4607d56785d475ed225" args="(const int fieldStart, LogString &buffer) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void format </td>
<td>(</td>
<td class="paramtype">const int </td>
<td class="paramname"><em>fieldStart</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>buffer</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adjust the content of the buffer based on the specified lengths and alignment. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">fieldStart</td><td>start of field in buffer. </td></tr>
<tr><td class="paramname">buffer</td><td>buffer to be modified. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a96729ac9d2dfe8423b55b7b9c744c965"></a><!-- doxytag: member="log4cxx::pattern::FormattingInfo::getDefault" ref="a96729ac9d2dfe8423b55b7b9c744c965" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">FormattingInfoPtr</a> getDefault </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets default instance. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>default instance. </dd></dl>
</div>
</div>
<a class="anchor" id="a5a8945adb1aeef0526f2ec7aef3c8b8a"></a><!-- doxytag: member="log4cxx::pattern::FormattingInfo::getMaxLength" ref="a5a8945adb1aeef0526f2ec7aef3c8b8a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int getMaxLength </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get maximum length. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>maximum length. </dd></dl>
</div>
</div>
<a class="anchor" id="a2cffeacf99fb5b1e4885749f2bde3d69"></a><!-- doxytag: member="log4cxx::pattern::FormattingInfo::getMinLength" ref="a2cffeacf99fb5b1e4885749f2bde3d69" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int getMinLength </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get minimum length. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>minimum length. </dd></dl>
</div>
</div>
<a class="anchor" id="ad34c7d74611cae9cc6082f46fee1f5d0"></a><!-- doxytag: member="log4cxx::pattern::FormattingInfo::isLeftAligned" ref="ad34c7d74611cae9cc6082f46fee1f5d0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isLeftAligned </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determine if left aligned. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if left aligned. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="formattinginfo_8h.html">formattinginfo.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacelog4cxx.html">log4cxx</a> </li>
<li class="navelem"><a class="el" href="namespacelog4cxx_1_1pattern.html">pattern</a> </li>
<li class="navelem"><a class="el" href="classlog4cxx_1_1pattern_1_1_formatting_info.html">FormattingInfo</a> </li>
<!--
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>
