Apache Log4cxx  Version 2.0.0
Loading...
Searching...
No Matches
htmllayout.h
Go to the documentation of this file.
1/*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18#ifndef _LOG4CXX_HTML_LAYOUT_H
19#define _LOG4CXX_HTML_LAYOUT_H
20
21#include <log4cxx/layout.h>
23
24
25
26namespace LOG4CXX_NS
27{
31class LOG4CXX_EXPORT HTMLLayout : public Layout
32{
33 private:
34 LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(HTMLLayoutPrivate, m_priv)
35
36 public:
42
45
57 void setLocationInfo(bool locationInfoFlag);
58
62 bool getLocationInfo() const;
63
69 void setTitle(const LogString& title1);
70
74 const LogString& getTitle() const;
75
79 LogString getContentType() const override;
80
90 void setOption(const LogString& option, const LogString& value) override;
91
92 using Layout::format;
96 void format( LogString& output, const spi::LoggingEventPtr& event ) const override;
97
98 using Layout::appendHeader;
103 void appendHeader( LogString& output ) override;
104
105 using Layout::appendFooter;
109 void appendFooter( LogString& output ) override;
110
114 bool ignoresThrowable() const override;
115
116}; // class HtmlLayout
118} // namespace log4cxx
119
120#endif // _LOG4CXX_HTML_LAYOUT_H
This layout outputs events in a HTML table.
Definition htmllayout.h:32
void appendHeader(LogString &output) override
Append a HTML document header and start a HTML table with column headings that align with the output ...
void setTitle(const LogString &title1)
The Title option takes a String value.
void format(LogString &output, const spi::LoggingEventPtr &event) const override
Append the attributes of event as a HTML table row onto output.
LogString getContentType() const override
Returns the content type output by this layout, i.e "text/html".
bool ignoresThrowable() const override
The HTML layout handles the throwable contained in logging events.
void setOption(const LogString &option, const LogString &value) override
Set option to value.
bool getLocationInfo() const
Returns the current value of the LocationInfo option.
const LogString & getTitle() const
Returns the current value of the Title option.
void appendFooter(LogString &output) override
Terminate the HTML table and the HTML document.
void activateOptions() override
Activate the options that were previously set with calls to option setters.
void setLocationInfo(bool locationInfoFlag)
The LocationInfo option takes a boolean value.
Extend this abstract class to create your own log layout format.
Definition layout.h:33
Definition appender.h:30
std::basic_string< logchar > LogString
Definition logstring.h:51
LOG4CXX_PTR_DEF(Appender)
#define LOG4CXX_CAST_ENTRY(Interface)
Definition object.h:154
#define END_LOG4CXX_CAST_MAP()
Definition object.h:148
#define DECLARE_LOG4CXX_OBJECT(object)
Definition object.h:41
#define LOG4CXX_CAST_ENTRY_CHAIN(Interface)
Definition object.h:160
#define BEGIN_LOG4CXX_CAST_MAP()
Definition object.h:142