File: classlog4cpp_1_1Layout.html

package info (click to toggle)
log4cpp-doc 1.0-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 8,528 kB
  • sloc: makefile: 10
file content (106 lines) | stat: -rw-r--r-- 6,992 bytes parent folder | download | duplicates (5) 
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
 
<!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::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.5.2 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</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>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;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 &lt;<a class="el" href="Layout_8hh-source.html">Layout.hh</a>&gt;</code>
<p>
Inheritance diagram for log4cpp::Layout:<p><center><img src="classlog4cpp_1_1Layout__inherit__graph.gif" border="0" usemap="#log4cpp_1_1Layout__inherit__map" alt="Inheritance graph"></center>
<map name="log4cpp_1_1Layout__inherit__map">
<area shape="rect" href="classlog4cpp_1_1BasicLayout.html" title="BasicLayout is a simple fixed format Layout implementation." alt="" coords="5,80,144,107"><area shape="rect" href="classlog4cpp_1_1PassThroughLayout.html" title="log4cpp::PassThroughLayout" alt="" coords="168,80,347,107"><area shape="rect" href="classlog4cpp_1_1PatternLayout.html" title="PatternLayout is a simple fixed format Layout implementation." alt="" coords="371,80,517,107"><area shape="rect" href="classlog4cpp_1_1SimpleLayout.html" title="BasicLayout is a simple fixed format Layout implementation." alt="" coords="541,80,688,107"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1Layout.html#5b80135e76bdd99ae51d4d487eb31657">~Layout</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor for <a class="el" href="classlog4cpp_1_1Layout.html" title="Extend this abstract class to create your own log layout format.">Layout</a>.  <a href="#5b80135e76bdd99ae51d4d487eb31657"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</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> &amp;event)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Formats the <a class="el" href="structlog4cpp_1_1LoggingEvent.html" title="The internal representation of logging events.">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 &amp; 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>&nbsp;)&nbsp;</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" title="Extend this abstract class to create your own log layout format.">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 &amp;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> &amp;&nbsp;</td>
          <td class="paramname"> <em>event</em>          </td>
          <td>&nbsp;)&nbsp;</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" title="The internal representation of logging events.">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>&nbsp;</td><td>The <a class="el" href="structlog4cpp_1_1LoggingEvent.html" title="The internal representation of logging events.">LoggingEvent</a>. </td></tr>
  </table>
</dl>
<dl class="return" 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="text-align: right;"><small>Generated on Mon Sep 3 11:55:05 2007 for log4cpp by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
</body>
</html>