summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/logging/XSimpleLogRing.idl
blob: de117c26a128c3e799b1efd014c90f51103d52ff (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
/* -*- 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_XSimpleLogRing_idl__
#define __com_sun_star_logging_XSimpleLogRing_idl__

#include <com/sun/star/uno/XInterface.idl>

//=============================================================================

module com { module sun { module star { module logging {

//=============================================================================

/** a simple log ring allowing to collect a limited number of last events

    <p>
    The intention of this interface is to provide a simple possibility
    for developer to collect the most important events without affecting
    the performance. For this reasons the messages related API is quite
    simple, the strings should be produced by the preprocessor mainly.
    </p>

    @since OOo 3.2
 */
interface XSimpleLogRing
{
    /** allows to add a message to the logger
     */
    void logString( [in] string aMessage );

    /** allows to get the collected messages from the logger

        <p>
        It is up to logger implementation to provide only the limited
        number of last messages.
        </p>
     */
    sequence< string > getCollectedLog();
};

//=============================================================================

}; }; }; };

//=============================================================================

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */