site/apidocs/classlog4cxx_1_1_h_t_m_l_layout.html - platform/external/apache-log4cxx - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 <!--

  Licensed to the Apache Software Foundation (ASF) under one or more
  contributor license agreements.  See the NOTICE file distributed with
  this work for additional information regarding copyright ownership.
  The ASF licenses this file to You under the Apache License, Version 2.0
  (the "License"); you may not use this file except in compliance with
  the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

 --><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
 <title>Apache log4cxx: HTMLLayout 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.6 -->
 <div class="tabs">
   <ul>
     <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
     <li><a href="modules.html"><span>Modules</span></a></li>
     <li><a href="namespaces.html"><span>Namespaces</span></a></li>
     <li id="current"><a href="classes.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="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
     <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="namespacelog4cxx.html">log4cxx</a>::<a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html">HTMLLayout</a></div>
 <h1>HTMLLayout Class Reference</h1><!-- doxytag: class="log4cxx::HTMLLayout" --><!-- doxytag: inherits="log4cxx::Layout" -->Inherits <a class="el" href="classlog4cxx_1_1_layout.html">Layout</a>.
 <p>
 <a href="classlog4cxx_1_1_h_t_m_l_layout-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
 This layout outputs events in a HTML table.
 <p>
 <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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#46d8801a3e45a55b344f5290c6ee91eb">HTMLLayout</a> ()</td></tr>

 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#3a5a676600b808a7a742c5610346380c">setLocationInfo</a> (bool locationInfoFlag)</td></tr>

 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The <b>LocationInfo</b> option takes a boolean value.  <a href="#3a5a676600b808a7a742c5610346380c"></a><br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#d70ffd01a630335c8e0465b04f360db4">getLocationInfo</a> () const </td></tr>

 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the current value of the <b>LocationInfo</b> option.  <a href="#d70ffd01a630335c8e0465b04f360db4"></a><br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#39b664891c1c6bf640eed588be1c2265">setTitle</a> (const <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;title1)</td></tr>

 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The <b>Title</b> option takes a String value.  <a href="#39b664891c1c6bf640eed588be1c2265"></a><br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#64093828760efbdd6ddeb94feccfdef1">getTitle</a> () const </td></tr>

 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the current value of the <b>Title</b> option.  <a href="#64093828760efbdd6ddeb94feccfdef1"></a><br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#8d61ef61f2aaf3923ef0a16fc6728dc7">getContentType</a> () const </td></tr>

 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the content type output by this layout, i.e "text/html".  <a href="#8d61ef61f2aaf3923ef0a16fc6728dc7"></a><br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#be1aa95ede9cc9d0609905154129c0ba">activateOptions</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &amp;)</td></tr>

 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">No options to activate.  <a href="#be1aa95ede9cc9d0609905154129c0ba"></a><br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#ee5023c29cca9dc68164b22a01cb7c6e">setOption</a> (const <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;option, const <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;value)</td></tr>

 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set options.  <a href="#ee5023c29cca9dc68164b22a01cb7c6e"></a><br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#79cba5d2db27cc6537de868018b72d9c">format</a> (<a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;output, const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">spi::LoggingEventPtr</a> &amp;event, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &amp;pool) const </td></tr>

 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Implement this method to create your own layout format.  <a href="#79cba5d2db27cc6537de868018b72d9c"></a><br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#396a9f379b832d1b9df431303b0cb93e">appendHeader</a> (<a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;output, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &amp;pool)</td></tr>

 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Append appropriate HTML headers.  <a href="#396a9f379b832d1b9df431303b0cb93e"></a><br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#273cfddfaa1950d22bd104feafb604b3">appendFooter</a> (<a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;output, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &amp;pool)</td></tr>

 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Append the appropriate HTML footers.  <a href="#273cfddfaa1950d22bd104feafb604b3"></a><br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#5796c8d5c4ed8ceae2cb9ebb1db75518">ignoresThrowable</a> () const </td></tr>

 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The HTML layout handles the throwable contained in logging events.  <a href="#5796c8d5c4ed8ceae2cb9ebb1db75518"></a><br></td></tr>
 </table>
 <hr><h2>Constructor &amp; Destructor Documentation</h2>
 <a class="anchor" name="46d8801a3e45a55b344f5290c6ee91eb"></a><!-- doxytag: member="log4cxx::HTMLLayout::HTMLLayout" ref="46d8801a3e45a55b344f5290c6ee91eb" args="()" --><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"><a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html">HTMLLayout</a>           </td>
           <td class="md" valign="top">(&nbsp;</td>
           <td class="mdname1" valign="top" nowrap>          </td>
           <td class="md" valign="top">&nbsp;)&nbsp;</td>
           <td class="md" nowrap></td>
         </tr>
       </table>
     </td>
   </tr>
 </table>
 <table cellspacing="5" cellpadding="0" border="0">
   <tr>
     <td>
       &nbsp;
     </td>
     <td>

 <p>
     </td>
   </tr>
 </table>
 <hr><h2>Member Function Documentation</h2>
 <a class="anchor" name="be1aa95ede9cc9d0609905154129c0ba"></a><!-- doxytag: member="log4cxx::HTMLLayout::activateOptions" ref="be1aa95ede9cc9d0609905154129c0ba" args="(log4cxx::helpers::Pool &amp;)" --><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 void activateOptions           </td>
           <td class="md" valign="top">(&nbsp;</td>
           <td class="md" nowrap valign="top"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &amp;&nbsp;</td>
           <td class="mdname1" valign="top" nowrap>          </td>
           <td class="md" valign="top">&nbsp;)&nbsp;</td>
           <td class="md" nowrap><code> [inline, virtual]</code></td>
         </tr>
       </table>
     </td>
   </tr>
 </table>
 <table cellspacing="5" cellpadding="0" border="0">
   <tr>
     <td>
       &nbsp;
     </td>
     <td>

 <p>
 No options to activate.
 <p>

 <p>
 Implements <a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html#f04d4bfbd66b46083b1aa042fdafbb06">OptionHandler</a>.    </td>
   </tr>
 </table>
 <a class="anchor" name="273cfddfaa1950d22bd104feafb604b3"></a><!-- doxytag: member="log4cxx::HTMLLayout::appendFooter" ref="273cfddfaa1950d22bd104feafb604b3" args="(LogString &amp;output, log4cxx::helpers::Pool &amp;pool)" --><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 void appendFooter           </td>
           <td class="md" valign="top">(&nbsp;</td>
           <td class="md" nowrap valign="top"><a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;&nbsp;</td>
           <td class="mdname" nowrap> <em>output</em>, </td>
         </tr>
         <tr>
           <td class="md" nowrap align="right"></td>
           <td class="md"></td>
           <td class="md" nowrap><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &amp;&nbsp;</td>
           <td class="mdname" nowrap> <em>pool</em></td>
         </tr>
         <tr>
           <td class="md"></td>
           <td class="md">)&nbsp;</td>
           <td class="md" colspan="2"><code> [virtual]</code></td>
         </tr>
       </table>
     </td>
   </tr>
 </table>
 <table cellspacing="5" cellpadding="0" border="0">
   <tr>
     <td>
       &nbsp;
     </td>
     <td>

 <p>
 Append the appropriate HTML footers.
 <p>

 <p>
 Reimplemented from <a class="el" href="classlog4cxx_1_1_layout.html#e8f7d8f894b39b251cada7674bdfe8d2">Layout</a>.    </td>
   </tr>
 </table>
 <a class="anchor" name="396a9f379b832d1b9df431303b0cb93e"></a><!-- doxytag: member="log4cxx::HTMLLayout::appendHeader" ref="396a9f379b832d1b9df431303b0cb93e" args="(LogString &amp;output, log4cxx::helpers::Pool &amp;pool)" --><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 void appendHeader           </td>
           <td class="md" valign="top">(&nbsp;</td>
           <td class="md" nowrap valign="top"><a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;&nbsp;</td>
           <td class="mdname" nowrap> <em>output</em>, </td>
         </tr>
         <tr>
           <td class="md" nowrap align="right"></td>
           <td class="md"></td>
           <td class="md" nowrap><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &amp;&nbsp;</td>
           <td class="mdname" nowrap> <em>pool</em></td>
         </tr>
         <tr>
           <td class="md"></td>
           <td class="md">)&nbsp;</td>
           <td class="md" colspan="2"><code> [virtual]</code></td>
         </tr>
       </table>
     </td>
   </tr>
 </table>
 <table cellspacing="5" cellpadding="0" border="0">
   <tr>
     <td>
       &nbsp;
     </td>
     <td>

 <p>
 Append appropriate HTML headers.
 <p>

 <p>
 Reimplemented from <a class="el" href="classlog4cxx_1_1_layout.html#d1b07d688e39f3a8d71acec8f6d7b878">Layout</a>.    </td>
   </tr>
 </table>
 <a class="anchor" name="79cba5d2db27cc6537de868018b72d9c"></a><!-- doxytag: member="log4cxx::HTMLLayout::format" ref="79cba5d2db27cc6537de868018b72d9c" args="(LogString &amp;output, const spi::LoggingEventPtr &amp;event, log4cxx::helpers::Pool &amp;pool) const " --><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 void format           </td>
           <td class="md" valign="top">(&nbsp;</td>
           <td class="md" nowrap valign="top"><a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;&nbsp;</td>
           <td class="mdname" nowrap> <em>output</em>, </td>
         </tr>
         <tr>
           <td class="md" nowrap align="right"></td>
           <td class="md"></td>
           <td class="md" nowrap>const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">spi::LoggingEventPtr</a> &amp;&nbsp;</td>
           <td class="mdname" nowrap> <em>event</em>, </td>
         </tr>
         <tr>
           <td class="md" nowrap align="right"></td>
           <td class="md"></td>
           <td class="md" nowrap><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &amp;&nbsp;</td>
           <td class="mdname" nowrap> <em>pool</em></td>
         </tr>
         <tr>
           <td class="md"></td>
           <td class="md">)&nbsp;</td>
           <td class="md" colspan="2"> const<code> [virtual]</code></td>
         </tr>
       </table>
     </td>
   </tr>
 </table>
 <table cellspacing="5" cellpadding="0" border="0">
   <tr>
     <td>
       &nbsp;
     </td>
     <td>

 <p>
 Implement this method to create your own layout format.
 <p>

 <p>
 Implements <a class="el" href="classlog4cxx_1_1_layout.html#efcaf353e4b45b21fc47b7e25410f8ff">Layout</a>.    </td>
   </tr>
 </table>
 <a class="anchor" name="8d61ef61f2aaf3923ef0a16fc6728dc7"></a><!-- doxytag: member="log4cxx::HTMLLayout::getContentType" ref="8d61ef61f2aaf3923ef0a16fc6728dc7" args="() const " --><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 <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> getContentType           </td>
           <td class="md" valign="top">(&nbsp;</td>
           <td class="mdname1" valign="top" nowrap>          </td>
           <td class="md" valign="top">&nbsp;)&nbsp;</td>
           <td class="md" nowrap> const<code> [inline, virtual]</code></td>
         </tr>
       </table>
     </td>
   </tr>
 </table>
 <table cellspacing="5" cellpadding="0" border="0">
   <tr>
     <td>
       &nbsp;
     </td>
     <td>

 <p>
 Returns the content type output by this layout, i.e "text/html".
 <p>

 <p>
 Reimplemented from <a class="el" href="classlog4cxx_1_1_layout.html#8d61ef61f2aaf3923ef0a16fc6728dc7">Layout</a>.    </td>
   </tr>
 </table>
 <a class="anchor" name="d70ffd01a630335c8e0465b04f360db4"></a><!-- doxytag: member="log4cxx::HTMLLayout::getLocationInfo" ref="d70ffd01a630335c8e0465b04f360db4" args="() const " --><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">bool getLocationInfo           </td>
           <td class="md" valign="top">(&nbsp;</td>
           <td class="mdname1" valign="top" nowrap>          </td>
           <td class="md" valign="top">&nbsp;)&nbsp;</td>
           <td class="md" nowrap> const<code> [inline]</code></td>
         </tr>
       </table>
     </td>
   </tr>
 </table>
 <table cellspacing="5" cellpadding="0" border="0">
   <tr>
     <td>
       &nbsp;
     </td>
     <td>

 <p>
 Returns the current value of the <b>LocationInfo</b> option.
 <p>
     </td>
   </tr>
 </table>
 <a class="anchor" name="64093828760efbdd6ddeb94feccfdef1"></a><!-- doxytag: member="log4cxx::HTMLLayout::getTitle" ref="64093828760efbdd6ddeb94feccfdef1" args="() const " --><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">const <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a>&amp; getTitle           </td>
           <td class="md" valign="top">(&nbsp;</td>
           <td class="mdname1" valign="top" nowrap>          </td>
           <td class="md" valign="top">&nbsp;)&nbsp;</td>
           <td class="md" nowrap> const<code> [inline]</code></td>
         </tr>
       </table>
     </td>
   </tr>
 </table>
 <table cellspacing="5" cellpadding="0" border="0">
   <tr>
     <td>
       &nbsp;
     </td>
     <td>

 <p>
 Returns the current value of the <b>Title</b> option.
 <p>
     </td>
   </tr>
 </table>
 <a class="anchor" name="5796c8d5c4ed8ceae2cb9ebb1db75518"></a><!-- doxytag: member="log4cxx::HTMLLayout::ignoresThrowable" ref="5796c8d5c4ed8ceae2cb9ebb1db75518" args="() const " --><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 bool ignoresThrowable           </td>
           <td class="md" valign="top">(&nbsp;</td>
           <td class="mdname1" valign="top" nowrap>          </td>
           <td class="md" valign="top">&nbsp;)&nbsp;</td>
           <td class="md" nowrap> const<code> [inline, virtual]</code></td>
         </tr>
       </table>
     </td>
   </tr>
 </table>
 <table cellspacing="5" cellpadding="0" border="0">
   <tr>
     <td>
       &nbsp;
     </td>
     <td>

 <p>
 The HTML layout handles the throwable contained in logging events.
 <p>
 Hence, this method return <code>false</code>.
 <p>
 Implements <a class="el" href="classlog4cxx_1_1_layout.html#7d46cce1553abd1ecb65fe6c5761fbd2">Layout</a>.    </td>
   </tr>
 </table>
 <a class="anchor" name="3a5a676600b808a7a742c5610346380c"></a><!-- doxytag: member="log4cxx::HTMLLayout::setLocationInfo" ref="3a5a676600b808a7a742c5610346380c" args="(bool locationInfoFlag)" --><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">void setLocationInfo           </td>
           <td class="md" valign="top">(&nbsp;</td>
           <td class="md" nowrap valign="top">bool&nbsp;</td>
           <td class="mdname1" valign="top" nowrap> <em>locationInfoFlag</em>          </td>
           <td class="md" valign="top">&nbsp;)&nbsp;</td>
           <td class="md" nowrap><code> [inline]</code></td>
         </tr>
       </table>
     </td>
   </tr>
 </table>
 <table cellspacing="5" cellpadding="0" border="0">
   <tr>
     <td>
       &nbsp;
     </td>
     <td>

 <p>
 The <b>LocationInfo</b> option takes a boolean value.
 <p>
 By default, it is set to false which means there will be no location information output by this layout. If the the option is set to true, then the file name and line number of the statement at the origin of the log statement will be output.<p>
 If you are embedding this layout within an <a class="el" href="classlog4cxx_1_1net_1_1_s_m_t_p_appender.html">SMTPAppender</a> then make sure to set the <b>LocationInfo</b> option of that appender as well.     </td>
   </tr>
 </table>
 <a class="anchor" name="ee5023c29cca9dc68164b22a01cb7c6e"></a><!-- doxytag: member="log4cxx::HTMLLayout::setOption" ref="ee5023c29cca9dc68164b22a01cb7c6e" args="(const LogString &amp;option, const LogString &amp;value)" --><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 void setOption           </td>
           <td class="md" valign="top">(&nbsp;</td>
           <td class="md" nowrap valign="top">const <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;&nbsp;</td>
           <td class="mdname" nowrap> <em>option</em>, </td>
         </tr>
         <tr>
           <td class="md" nowrap align="right"></td>
           <td class="md"></td>
           <td class="md" nowrap>const <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;&nbsp;</td>
           <td class="mdname" nowrap> <em>value</em></td>
         </tr>
         <tr>
           <td class="md"></td>
           <td class="md">)&nbsp;</td>
           <td class="md" colspan="2"><code> [virtual]</code></td>
         </tr>
       </table>
     </td>
   </tr>
 </table>
 <table cellspacing="5" cellpadding="0" border="0">
   <tr>
     <td>
       &nbsp;
     </td>
     <td>

 <p>
 Set options.
 <p>

 <p>
 Implements <a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html#8f2ae2ded63f80c627269c99b20c19ee">OptionHandler</a>.    </td>
   </tr>
 </table>
 <a class="anchor" name="39b664891c1c6bf640eed588be1c2265"></a><!-- doxytag: member="log4cxx::HTMLLayout::setTitle" ref="39b664891c1c6bf640eed588be1c2265" args="(const LogString &amp;title1)" --><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">void setTitle           </td>
           <td class="md" valign="top">(&nbsp;</td>
           <td class="md" nowrap valign="top">const <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;&nbsp;</td>
           <td class="mdname1" valign="top" nowrap> <em>title1</em>          </td>
           <td class="md" valign="top">&nbsp;)&nbsp;</td>
           <td class="md" nowrap><code> [inline]</code></td>
         </tr>
       </table>
     </td>
   </tr>
 </table>
 <table cellspacing="5" cellpadding="0" border="0">
   <tr>
     <td>
       &nbsp;
     </td>
     <td>

 <p>
 The <b>Title</b> option takes a String value.
 <p>
 This option sets the document title of the generated HTML document. <p>
 Defaults to 'Log4cxx Log Messages'.     </td>
   </tr>
 </table>
 <hr>The documentation for this class was generated from the following file:<ul>
 <li><a class="el" href="htmllayout_8h.html">htmllayout.h</a></ul>
 <!--
 Licensed to the Apache Software Foundation (ASF) under one or more
 contributor license agreements.  See the NOTICE file distributed with
 this work for additional information regarding copyright ownership.
 The ASF licenses this file to You under the Apache License, Version 2.0
 (the "License"); you may not use this file except in compliance with
 the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 -->
     </BODY>
 </HTML>