Apache Log4cxx
Version 2.0.0
Toggle main menu visibility
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
>
22
#include <
log4cxx/helpers/iso8601dateformat.h
>
23
24
25
26
namespace
LOG4CXX_NS
27
{
31
class
LOG4CXX_EXPORT
HTMLLayout
:
public
Layout
32
{
33
private
:
34
LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(HTMLLayoutPrivate, m_priv)
35
36
public
:
37
DECLARE_LOG4CXX_OBJECT
(
HTMLLayout
)
38
BEGIN_LOG4CXX_CAST_MAP
()
39
LOG4CXX_CAST_ENTRY
(
HTMLLayout
)
40
LOG4CXX_CAST_ENTRY_CHAIN
(
Layout
)
41
END_LOG4CXX_CAST_MAP
()
42
43
HTMLLayout
();
44
~
HTMLLayout
();
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
81
using
Layout
::
activateOptions
;
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
117
LOG4CXX_PTR_DEF
(
HTMLLayout
);
118
}
// namespace log4cxx
119
120
#endif
// _LOG4CXX_HTML_LAYOUT_H
log4cxx::HTMLLayout
This layout outputs events in a HTML table.
Definition
htmllayout.h:32
log4cxx::HTMLLayout::appendHeader
void appendHeader(LogString &output) override
Append a HTML document header and start a HTML table with column headings that align with the output ...
log4cxx::HTMLLayout::setTitle
void setTitle(const LogString &title1)
The Title option takes a String value.
log4cxx::HTMLLayout::format
void format(LogString &output, const spi::LoggingEventPtr &event) const override
Append the attributes of event as a HTML table row onto output.
log4cxx::HTMLLayout::HTMLLayout
HTMLLayout()
log4cxx::HTMLLayout::getContentType
LogString getContentType() const override
Returns the content type output by this layout, i.e "text/html".
log4cxx::HTMLLayout::ignoresThrowable
bool ignoresThrowable() const override
The HTML layout handles the throwable contained in logging events.
log4cxx::HTMLLayout::setOption
void setOption(const LogString &option, const LogString &value) override
Set option to value.
log4cxx::HTMLLayout::getLocationInfo
bool getLocationInfo() const
Returns the current value of the LocationInfo option.
log4cxx::HTMLLayout::getTitle
const LogString & getTitle() const
Returns the current value of the Title option.
log4cxx::HTMLLayout::appendFooter
void appendFooter(LogString &output) override
Terminate the HTML table and the HTML document.
log4cxx::HTMLLayout::activateOptions
void activateOptions() override
Activate the options that were previously set with calls to option setters.
log4cxx::HTMLLayout::setLocationInfo
void setLocationInfo(bool locationInfoFlag)
The LocationInfo option takes a boolean value.
log4cxx::Layout
Extend this abstract class to create your own log layout format.
Definition
layout.h:33
iso8601dateformat.h
layout.h
log4cxx::spi
Definition
appender.h:30
log4cxx::LogString
std::basic_string< logchar > LogString
Definition
logstring.h:51
log4cxx::LOG4CXX_PTR_DEF
LOG4CXX_PTR_DEF(Appender)
LOG4CXX_CAST_ENTRY
#define LOG4CXX_CAST_ENTRY(Interface)
Definition
object.h:154
END_LOG4CXX_CAST_MAP
#define END_LOG4CXX_CAST_MAP()
Definition
object.h:148
DECLARE_LOG4CXX_OBJECT
#define DECLARE_LOG4CXX_OBJECT(object)
Definition
object.h:41
LOG4CXX_CAST_ENTRY_CHAIN
#define LOG4CXX_CAST_ENTRY_CHAIN(Interface)
Definition
object.h:160
BEGIN_LOG4CXX_CAST_MAP
#define BEGIN_LOG4CXX_CAST_MAP()
Definition
object.h:142
src
main
include
log4cxx
htmllayout.h
Generated by
1.18.0 on
SITE_PUBLISHED_DATE
Copyright © 2017-2026
Apache Software Foundation
. Apache, Chainsaw, log4cxx, Log4j, Log4net, log4php and the Apache logo are
trademarks or registered trademarks
of The Apache Software Foundation.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Privacy Policy
.