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
107
108
109
|
<!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">
</head><body>
<!-- Generated by Doxygen 1.4.2 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></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>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>
Inheritance diagram for log4cpp::Layout:<p><center><img src="classlog4cpp_1_1Layout__inherit__graph.png" border="0" usemap="#log4cpp_1_1Layout__inherit__map" alt="Inheritance graph"></center>
<map name="log4cpp_1_1Layout__inherit__map">
<area href="classlog4cpp_1_1BasicLayout.html" shape="rect" coords="8,83,154,107" alt="">
<area href="classlog4cpp_1_1PatternLayout.html" shape="rect" coords="178,83,336,107" alt="">
<area href="classlog4cpp_1_1SimpleLayout.html" shape="rect" coords="360,83,514,107" alt="">
</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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1Layout.html#a0">~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="#a0"></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#a1">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="#a1"></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="a0" doxytag="log4cpp::Layout::~Layout"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual log4cpp::Layout::~Layout </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Destructor for <a class="el" href="classlog4cpp_1_1Layout.html">Layout</a>.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a1" doxytag="log4cpp::Layout::format"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual std::string log4cpp::Layout::format </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>event</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<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#a2">log4cpp::BasicLayout</a>, <a class="el" href="classlog4cpp_1_1PatternLayout.html#a2">log4cpp::PatternLayout</a>, and <a class="el" href="classlog4cpp_1_1SimpleLayout.html#a2">log4cpp::SimpleLayout</a>. </td>
</tr>
</table>
<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 Fri Jul 29 14:12:24 2005 for log4cpp by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
</body>
</html>
|
