| <!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"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Apache log4cxx: log4cxx::pattern::FormattingInfo Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(initResizable); |
| </script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| <link href="customdoxygen.css" rel="stylesheet" type="text/css"/> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Apache log4cxx |
|  <span id="projectnumber">Version 0.13.0</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </script> |
| <div id="main-nav"></div> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| $(document).ready(function(){initNavTree('classlog4cxx_1_1pattern_1_1FormattingInfo.html','');}); |
| </script> |
| <div id="doc-content"> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classlog4cxx_1_1pattern_1_1FormattingInfo-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">log4cxx::pattern::FormattingInfo Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Modifies the output of a pattern converter for a specified minimum and maximum width and alignment. |
| <a href="classlog4cxx_1_1pattern_1_1FormattingInfo.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="formattinginfo_8h_source.html">formattinginfo.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for log4cxx::pattern::FormattingInfo:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classlog4cxx_1_1pattern_1_1FormattingInfo.png" usemap="#log4cxx::pattern::FormattingInfo_map" alt=""/> |
| <map id="log4cxx::pattern::FormattingInfo_map" name="log4cxx::pattern::FormattingInfo_map"> |
| <area href="classlog4cxx_1_1helpers_1_1Object.html" title="base class for java-like objects. " alt="log4cxx::helpers::Object" shape="rect" coords="0,0,186,24"/> |
| </map> |
| </div></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:aed3a727eed498cd652eac78e4d5d682d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1FormattingInfo.html#aed3a727eed498cd652eac78e4d5d682d">FormattingInfo</a> (const bool leftAlign, const int minLength, const int maxLength)</td></tr> |
| <tr class="memdesc:aed3a727eed498cd652eac78e4d5d682d"><td class="mdescLeft"> </td><td class="mdescRight">Creates new instance. <a href="#aed3a727eed498cd652eac78e4d5d682d">More...</a><br /></td></tr> |
| <tr class="separator:aed3a727eed498cd652eac78e4d5d682d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8e203cddad47be1da81a14867c9699a4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1FormattingInfo.html#a8e203cddad47be1da81a14867c9699a4">isLeftAligned</a> () const</td></tr> |
| <tr class="memdesc:a8e203cddad47be1da81a14867c9699a4"><td class="mdescLeft"> </td><td class="mdescRight">Determine if left aligned. <a href="#a8e203cddad47be1da81a14867c9699a4">More...</a><br /></td></tr> |
| <tr class="separator:a8e203cddad47be1da81a14867c9699a4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afbe2c3649fa618f9588474148114e20f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1FormattingInfo.html#afbe2c3649fa618f9588474148114e20f">getMinLength</a> () const</td></tr> |
| <tr class="memdesc:afbe2c3649fa618f9588474148114e20f"><td class="mdescLeft"> </td><td class="mdescRight">Get minimum length. <a href="#afbe2c3649fa618f9588474148114e20f">More...</a><br /></td></tr> |
| <tr class="separator:afbe2c3649fa618f9588474148114e20f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4e93d1448ee0a4641dfbb4466900a225"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1FormattingInfo.html#a4e93d1448ee0a4641dfbb4466900a225">getMaxLength</a> () const</td></tr> |
| <tr class="memdesc:a4e93d1448ee0a4641dfbb4466900a225"><td class="mdescLeft"> </td><td class="mdescRight">Get maximum length. <a href="#a4e93d1448ee0a4641dfbb4466900a225">More...</a><br /></td></tr> |
| <tr class="separator:a4e93d1448ee0a4641dfbb4466900a225"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa5c770465b2ee9766f93ab0643ffc37c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1FormattingInfo.html#aa5c770465b2ee9766f93ab0643ffc37c">format</a> (const int fieldStart, <a class="el" href="namespacelog4cxx.html#aa2308ed05fef2a1366066cb38b177e94">LogString</a> &buffer) const</td></tr> |
| <tr class="memdesc:aa5c770465b2ee9766f93ab0643ffc37c"><td class="mdescLeft"> </td><td class="mdescRight">Adjust the content of the buffer based on the specified lengths and alignment. <a href="#aa5c770465b2ee9766f93ab0643ffc37c">More...</a><br /></td></tr> |
| <tr class="separator:aa5c770465b2ee9766f93ab0643ffc37c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classlog4cxx_1_1helpers_1_1Object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classlog4cxx_1_1helpers_1_1Object')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classlog4cxx_1_1helpers_1_1Object.html">log4cxx::helpers::Object</a></td></tr> |
| <tr class="memitem:a8ba23411233a652fac44a619e6356115 inherit pub_methods_classlog4cxx_1_1helpers_1_1Object"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1Object.html#a8ba23411233a652fac44a619e6356115">~Object</a> ()</td></tr> |
| <tr class="separator:a8ba23411233a652fac44a619e6356115 inherit pub_methods_classlog4cxx_1_1helpers_1_1Object"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9dac08272167c9af4c7d81e9e205a9de inherit pub_methods_classlog4cxx_1_1helpers_1_1Object"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1Object.html#a9dac08272167c9af4c7d81e9e205a9de">instanceof</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1Class.html">Class</a> &clazz) const =0</td></tr> |
| <tr class="separator:a9dac08272167c9af4c7d81e9e205a9de inherit pub_methods_classlog4cxx_1_1helpers_1_1Object"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4a24185c7ef795bd6ac70d69c22ca7d9 inherit pub_methods_classlog4cxx_1_1helpers_1_1Object"><td class="memItemLeft" align="right" valign="top">virtual const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1Object.html#a4a24185c7ef795bd6ac70d69c22ca7d9">cast</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1Class.html">Class</a> &clazz) const =0</td></tr> |
| <tr class="separator:a4a24185c7ef795bd6ac70d69c22ca7d9 inherit pub_methods_classlog4cxx_1_1helpers_1_1Object"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a27c0b250533cffb8d5cd71834275170e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespacelog4cxx_1_1pattern.html#a649a4a8c3440bc72f57c2f8061abac8c">FormattingInfoPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1FormattingInfo.html#a27c0b250533cffb8d5cd71834275170e">getDefault</a> ()</td></tr> |
| <tr class="memdesc:a27c0b250533cffb8d5cd71834275170e"><td class="mdescLeft"> </td><td class="mdescRight">Gets default instance. <a href="#a27c0b250533cffb8d5cd71834275170e">More...</a><br /></td></tr> |
| <tr class="separator:a27c0b250533cffb8d5cd71834275170e"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">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><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="aed3a727eed498cd652eac78e4d5d682d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aed3a727eed498cd652eac78e4d5d682d">◆ </a></span>FormattingInfo()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">log4cxx::pattern::FormattingInfo::FormattingInfo </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 class="params"><dt>Parameters</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> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="aa5c770465b2ee9766f93ab0643ffc37c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa5c770465b2ee9766f93ab0643ffc37c">◆ </a></span>format()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void log4cxx::pattern::FormattingInfo::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#aa2308ed05fef2a1366066cb38b177e94">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 class="params"><dt>Parameters</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 id="a27c0b250533cffb8d5cd71834275170e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a27c0b250533cffb8d5cd71834275170e">◆ </a></span>getDefault()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="namespacelog4cxx_1_1pattern.html#a649a4a8c3440bc72f57c2f8061abac8c">FormattingInfoPtr</a> log4cxx::pattern::FormattingInfo::getDefault </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets default instance. </p> |
| <dl class="section return"><dt>Returns</dt><dd>default instance. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a4e93d1448ee0a4641dfbb4466900a225"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4e93d1448ee0a4641dfbb4466900a225">◆ </a></span>getMaxLength()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int log4cxx::pattern::FormattingInfo::getMaxLength </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get maximum length. </p> |
| <dl class="section return"><dt>Returns</dt><dd>maximum length. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="afbe2c3649fa618f9588474148114e20f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afbe2c3649fa618f9588474148114e20f">◆ </a></span>getMinLength()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int log4cxx::pattern::FormattingInfo::getMinLength </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get minimum length. </p> |
| <dl class="section return"><dt>Returns</dt><dd>minimum length. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a8e203cddad47be1da81a14867c9699a4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8e203cddad47be1da81a14867c9699a4">◆ </a></span>isLeftAligned()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool log4cxx::pattern::FormattingInfo::isLeftAligned </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Determine if left aligned. </p> |
| <dl class="section return"><dt>Returns</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_source.html">formattinginfo.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- HTML footer for doxygen 1.8.13--> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <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_1FormattingInfo.html">FormattingInfo</a></li> |
| <li class="footer">Generated by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> |
| <li class="center"> |
| Copyright © 2003-2022 <a href="https://www.apache.org/">Apache Software Foundation</a>. All Rights Reserved. <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a><br/> |
| Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, and the Apache Logging project logo are trademarks of The Apache Software Foundation.<br/> |
| </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
