<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>log4cpp: log4cpp::LayoutAppender Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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 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="navpath"><a class="el" href="namespacelog4cpp.html">log4cpp</a>::<a class="el" href="classlog4cpp_1_1LayoutAppender.html">LayoutAppender</a>
</div>
</div>
<div class="contents">
<h1>log4cpp::LayoutAppender Class Reference</h1><!-- doxytag: class="log4cpp::LayoutAppender" --><!-- doxytag: inherits="log4cpp::AppenderSkeleton" --><a class="el" href="classlog4cpp_1_1LayoutAppender.html" title="LayoutAppender is a common superclass for all Appenders that require a Layout.">LayoutAppender</a> is a common superclass for all Appenders that require a <a class="el" href="classlog4cpp_1_1Layout.html" title="Extend this abstract class to create your own log layout format.">Layout</a>.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="LayoutAppender_8hh_source.html">LayoutAppender.hh</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for log4cpp::LayoutAppender:</div>
<div class="dynsection">
<p><center><img src="classlog4cpp_1_1LayoutAppender.png" usemap="#log4cpp::LayoutAppender_map" border="0" alt=""></center>
<map name="log4cpp::LayoutAppender_map">
<area href="classlog4cpp_1_1AppenderSkeleton.html" alt="log4cpp::AppenderSkeleton" shape="rect" coords="624,56,822,80">
<area href="classlog4cpp_1_1Appender.html" alt="log4cpp::Appender" shape="rect" coords="624,0,822,24">
<area href="classlog4cpp_1_1BufferingAppender.html" alt="log4cpp::BufferingAppender" shape="rect" coords="0,168,198,192">
<area href="classlog4cpp_1_1FileAppender.html" alt="log4cpp::FileAppender" shape="rect" coords="208,168,406,192">
<area href="classlog4cpp_1_1OstreamAppender.html" alt="log4cpp::OstreamAppender" shape="rect" coords="416,168,614,192">
<area href="classlog4cpp_1_1RemoteSyslogAppender.html" alt="log4cpp::RemoteSyslogAppender" shape="rect" coords="624,168,822,192">
<area href="classlog4cpp_1_1StringQueueAppender.html" alt="log4cpp::StringQueueAppender" shape="rect" coords="832,168,1030,192">
<area href="classlog4cpp_1_1SyslogAppender.html" alt="log4cpp::SyslogAppender" shape="rect" coords="1040,168,1238,192">
<area href="classlog4cpp_1_1Win32DebugAppender.html" alt="log4cpp::Win32DebugAppender" shape="rect" coords="1248,168,1446,192">
<area href="classlog4cpp_1_1RollingFileAppender.html" alt="log4cpp::RollingFileAppender" shape="rect" coords="208,224,406,248">
</map>
</div>
<p>
<a href="classlog4cpp_1_1LayoutAppender-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classlog4cpp_1_1BasicLayout.html">BasicLayout</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1LayoutAppender.html#188b3a9a2dd9f718f250f95efaa43724">DefaultLayoutType</a></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="classlog4cpp_1_1LayoutAppender.html#31d50b4e476c70bd99e3c9dbd07e6a79">LayoutAppender</a> (const std::string &name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1LayoutAppender.html#da501d953eb1e980840866880ba0afb9">~LayoutAppender</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1LayoutAppender.html#da1cff85c6ef25177da226dc3eabe65b">requiresLayout</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the appender requires a layout. <a href="#da1cff85c6ef25177da226dc3eabe65b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1LayoutAppender.html#a12073260a58276f9f43a75cb7b93b68">setLayout</a> (<a class="el" href="classlog4cpp_1_1Layout.html">Layout</a> *layout=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the <a class="el" href="classlog4cpp_1_1Layout.html" title="Extend this abstract class to create your own log layout format.">Layout</a> for this appender. <a href="#a12073260a58276f9f43a75cb7b93b68"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classlog4cpp_1_1Layout.html">Layout</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1LayoutAppender.html#2215bc27417d200bd510f2f5d91fa0ff">_getLayout</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the layout of the appender. <a href="#2215bc27417d200bd510f2f5d91fa0ff"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classlog4cpp_1_1LayoutAppender.html" title="LayoutAppender is a common superclass for all Appenders that require a Layout.">LayoutAppender</a> is a common superclass for all Appenders that require a <a class="el" href="classlog4cpp_1_1Layout.html" title="Extend this abstract class to create your own log layout format.">Layout</a>. <hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="188b3a9a2dd9f718f250f95efaa43724"></a><!-- doxytag: member="log4cpp::LayoutAppender::DefaultLayoutType" ref="188b3a9a2dd9f718f250f95efaa43724" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classlog4cpp_1_1BasicLayout.html">BasicLayout</a> <a class="el" href="classlog4cpp_1_1BasicLayout.html">log4cpp::LayoutAppender::DefaultLayoutType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="31d50b4e476c70bd99e3c9dbd07e6a79"></a><!-- doxytag: member="log4cpp::LayoutAppender::LayoutAppender" ref="31d50b4e476c70bd99e3c9dbd07e6a79" args="(const std::string &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">log4cpp::LayoutAppender::LayoutAppender </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="da501d953eb1e980840866880ba0afb9"></a><!-- doxytag: member="log4cpp::LayoutAppender::~LayoutAppender" ref="da501d953eb1e980840866880ba0afb9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">log4cpp::LayoutAppender::~LayoutAppender </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2215bc27417d200bd510f2f5d91fa0ff"></a><!-- doxytag: member="log4cpp::LayoutAppender::_getLayout" ref="2215bc27417d200bd510f2f5d91fa0ff" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cpp_1_1Layout.html">Layout</a> & log4cpp::LayoutAppender::_getLayout </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the layout of the appender.
<p>
This method is the <a class="el" href="classlog4cpp_1_1Layout.html" title="Extend this abstract class to create your own log layout format.">Layout</a> accessor for subclasses of <a class="el" href="classlog4cpp_1_1LayoutAppender.html" title="LayoutAppender is a common superclass for all Appenders that require a Layout.">LayoutAppender</a>. <dl class="return" compact><dt><b>Returns:</b></dt><dd>the <a class="el" href="classlog4cpp_1_1Layout.html" title="Extend this abstract class to create your own log layout format.">Layout</a>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="da1cff85c6ef25177da226dc3eabe65b"></a><!-- doxytag: member="log4cpp::LayoutAppender::requiresLayout" ref="da1cff85c6ef25177da226dc3eabe65b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool log4cpp::LayoutAppender::requiresLayout </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the appender requires a layout.
<p>
All LayoutAppenders do, therefore this method returns true for all subclasses.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true. </dd></dl>
<p>Implements <a class="el" href="classlog4cpp_1_1AppenderSkeleton.html#a1893ab330aeb11369f82db550b35429">log4cpp::AppenderSkeleton</a>.</p>
</div>
</div><p>
<a class="anchor" name="a12073260a58276f9f43a75cb7b93b68"></a><!-- doxytag: member="log4cpp::LayoutAppender::setLayout" ref="a12073260a58276f9f43a75cb7b93b68" args="(Layout *layout=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void log4cpp::LayoutAppender::setLayout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4cpp_1_1Layout.html">Layout</a> * </td>
<td class="paramname"> <em>layout</em> = <code>NULL</code> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the <a class="el" href="classlog4cpp_1_1Layout.html" title="Extend this abstract class to create your own log layout format.">Layout</a> for this appender.
<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>layout</em> </td><td>The layout to use. </td></tr>
</table>
</dl>
<p>Implements <a class="el" href="classlog4cpp_1_1AppenderSkeleton.html#5d1136572a006239935c4264beb07065">log4cpp::AppenderSkeleton</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="LayoutAppender_8hh_source.html">LayoutAppender.hh</a><li><a class="el" href="LayoutAppender_8cpp.html">LayoutAppender.cpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Jul 26 19:34:50 2009 for log4cpp by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
