Apache Log4cxx  Version 1.8.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
82#if LOG4CXX_ABI_VERSION <= 15
89#endif
98 void setOption(const LogString& option, const LogString& value) override;
99
100 using Layout::format;
105
112
118
122 bool ignoresThrowable() const override;
123
124}; // class HtmlLayout
126} // namespace log4cxx
127
128#endif // _LOG4CXX_HTML_LAYOUT_H
This layout outputs events in a HTML table.
Definition htmllayout.h:32
void setTitle(const LogString &title1)
The Title option takes a String value.
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 activateOptions(helpers::Pool &p) override
Definition htmllayout.h:88
void appendHeader(LogString &output, LOG4CXX_NS::helpers::Pool &p) override
Append a HTML document header and start a HTML table with column headings that align with the output ...
void appendFooter(LogString &output, LOG4CXX_NS::helpers::Pool &p) override
Terminate the HTML table and the HTML document.
void setLocationInfo(bool locationInfoFlag)
The LocationInfo option takes a boolean value.
void format(LogString &output, const spi::LoggingEventPtr &event, helpers::Pool &p) const override
Append the attributes of event as a HTML table row onto output.
Extend this abstract class to create your own log layout format.
Definition layout.h:38
void appendFooter(LogString &output)
Append the footer for the layout format.
void format(LogString &output, const spi::LoggingEventPtr &event) const
Implement this method to create your own layout format.
void appendHeader(LogString &output)
Append the header for the layout format.
#define LOG4CXX_FORMAT_LAYOUT_FORMAL_PARAMETERS
Definition layout.h:59
#define LOG4CXX_APPEND_FOOTER_FORMAL_PARAMETERS
Definition layout.h:109
#define LOG4CXX_APPEND_HEADER_FORMAL_PARAMETERS
Definition layout.h:87
std::basic_string< logchar > LogString
Definition logstring.h:60
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
#define LOG4CXX_ACTIVATE_OPTIONS_FORMAL_PARAMETERS
Activate the options that were previously set with calls to option setters.
Definition optionhandler.h:53