blob: 255eca2ac0a2333405d9a7ef8b8f62d700c829d9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* 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 .
*/
#ifndef __com_sun_star_logging_XLogFormatter_idl__
#define __com_sun_star_logging_XLogFormatter_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/logging/LogRecord.idl>
module com { module sun { module star { module logging {
/** specifies the interface to be used for formatting log records
@see XLogHandler
@since OOo 2.3
*/
interface XLogFormatter
{
/** returns the header string for the log
<p>This can be used to generate a header string, which by the <type>XLogHandler</type>
is emitted to its output channel before actually logging any concrete
<type>LogRecord</type>.</p>
<p>For instance, a formatter might produce table-like plain text output,
and could return a table-head string (potentially including line breaks)
here.</p>
*/
string getHead();
/** formats the given log record for output
<p>A <type>XLogHandler</type> will call this method to format a given
log record. The resulting string will be emitted to the handler's output
channel, without processing it any further (except possibly encoding it with
the handler's <code>Encoding</code>).</p>
*/
string format( [in] LogRecord Record );
/** returns the footer string for the log
<p>This can be used to generate a footer string, which by the <type>XLogHandler</type>
is emitted to its output channel before it is finally being closed.</p>
*/
string getTail();
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
