<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>log4cpp: log4cpp::Layout 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.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<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="namespacelog4cpp.html">log4cpp</a>::<a class="el" href="classlog4cpp_1_1Layout.html">Layout</a></div>
<h1>log4cpp::Layout Class Reference</h1><!-- doxytag: class="log4cpp::Layout" -->Extend this abstract class to create your own log layout format.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="Layout_8hh-source.html">Layout.hh</a>></code>
<p>
<p>Inheritance diagram for log4cpp::Layout:
<p><center><img src="classlog4cpp_1_1Layout.png" usemap="#log4cpp::Layout_map" border="0" alt=""></center>
<map name="log4cpp::Layout_map">
<area href="classlog4cpp_1_1BasicLayout.html" alt="log4cpp::BasicLayout" shape="rect" coords="0,56,175,80">
<area href="classlog4cpp_1_1PassThroughLayout.html" alt="log4cpp::PassThroughLayout" shape="rect" coords="185,56,360,80">
<area href="classlog4cpp_1_1PatternLayout.html" alt="log4cpp::PatternLayout" shape="rect" coords="370,56,545,80">
<area href="classlog4cpp_1_1SimpleLayout.html" alt="log4cpp::SimpleLayout" shape="rect" coords="555,56,730,80">
</map>
<a href="classlog4cpp_1_1Layout-members.html">List of all members.</a><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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1Layout.html#5b80135e76bdd99ae51d4d487eb31657">~Layout</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor for <a class="el" href="classlog4cpp_1_1Layout.html">Layout</a>. <a href="#5b80135e76bdd99ae51d4d487eb31657"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1Layout.html#b52ceda3222f9102e41720b45ae3a939">format</a> (const <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a> &event)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Formats the <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a> data to a string that appenders can log. <a href="#b52ceda3222f9102e41720b45ae3a939"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Extend this abstract class to create your own log layout format.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="5b80135e76bdd99ae51d4d487eb31657"></a><!-- doxytag: member="log4cpp::Layout::~Layout" ref="5b80135e76bdd99ae51d4d487eb31657" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual log4cpp::Layout::~Layout </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor for <a class="el" href="classlog4cpp_1_1Layout.html">Layout</a>.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b52ceda3222f9102e41720b45ae3a939"></a><!-- doxytag: member="log4cpp::Layout::format" ref="b52ceda3222f9102e41720b45ae3a939" args="(const LoggingEvent &event)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std::string log4cpp::Layout::format </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a> & </td>
<td class="paramname"> <em>event</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Formats the <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a> data to a string that appenders can log.
<p>
Implement this method to create your own layout format. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>event</em> </td><td>The <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a>. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>an appendable string. </dd></dl>
<p>
Implemented in <a class="el" href="classlog4cpp_1_1BasicLayout.html#5cab336d9553c1a0b16ceac157138026">log4cpp::BasicLayout</a>, <a class="el" href="classlog4cpp_1_1PassThroughLayout.html#56c67965111978f8d1b0e36a5765ac23">log4cpp::PassThroughLayout</a>, <a class="el" href="classlog4cpp_1_1PatternLayout.html#29c5e385c9f13fcfccdee71ef7a25354">log4cpp::PatternLayout</a>, and <a class="el" href="classlog4cpp_1_1SimpleLayout.html#e8ce1d7a0f94b5eece7df631cf0f33e2">log4cpp::SimpleLayout</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Layout_8hh-source.html">Layout.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Wed Mar 31 05:56:18 2010 for log4cpp by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
distrib
>
CentOS
>
5
>
i386
>
media
>
os
>
by-pkgid
>
3b1f075ab33bf572e5550d0965af1e71
>
files
>
204
