Apache Log4cxx  Version 1.1.0
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 
26 namespace log4cxx
27 {
31 class 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 
84  void activateOptions(helpers::Pool& /* p */) override {}
85 
89  void setOption(const LogString& option, const LogString& value) override;
90 
91  void format(LogString& output,
92  const spi::LoggingEventPtr& event, helpers::Pool& pool) const override;
93 
97  void appendHeader(LogString& output, helpers::Pool& pool) override;
98 
102  void appendFooter(LogString& output, helpers::Pool& pool) override;
103 
107  bool ignoresThrowable() const override;
108 
109 }; // class HtmlLayout
111 } // namespace log4cxx
112 
113 #endif // _LOG4CXX_HTML_LAYOUT_H
This layout outputs events in a HTML table.
Definition: htmllayout.h:32
void format(LogString &output, const spi::LoggingEventPtr &event, helpers::Pool &pool) const override
Implement this method to create your own layout format.
void appendHeader(LogString &output, helpers::Pool &pool) override
Append appropriate HTML headers.
bool ignoresThrowable() const override
The HTML layout handles the throwable contained in logging events.
void setOption(const LogString &option, const LogString &value) override
Set options.
void appendFooter(LogString &output, helpers::Pool &pool) override
Append the appropriate HTML footers.
Extend this abstract class to create your own log layout format.
Definition: layout.h:34
Definition: pool.h:33
std::shared_ptr< LoggingEvent > LoggingEventPtr
Definition: appender.h:31
Definition: appender.h:27
std::basic_string< logchar > LogString
Definition: logstring.h:60
LOG4CXX_PTR_DEF(Appender)
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:157
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:151
#define DECLARE_LOG4CXX_OBJECT(object)
Definition: object.h:42
#define LOG4CXX_CAST_ENTRY_CHAIN(Interface)
Definition: object.h:163
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:145