summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/logging/ConsoleHandler.idl
blob: 981cac56f2ff9b69a0118bf64be91fcf2a714349 (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
/* -*- 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_ConsoleHandler_idl__
#define __com_sun_star_logging_ConsoleHandler_idl__

#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/beans/NamedValue.idl>


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

interface XConsoleHandler;


/** specifies a component implementing a log handler whose output
    channel is the processes console.

    @since OOo 2.3
 */
service ConsoleHandler : XConsoleHandler
{
    /// creates a <code>ConsoleHandler</code>
    create();

    /** creates an instance of the log handler, using generic settings

        @param Settings
            contains the initial settings for the log handler

            <p>The following settings are recognized and supported:
            <ul><li><code>Encoding</code> - denotes the initial value of the XLogHandler::Encoding</li>
                <li><code>Formatter</code> - denotes the initial value of the XLogHandler::Formatter</li>
                <li><code>Level</code> - denotes the initial value of the XLogHandler::Level</li>
                <li><code>Threshold</code> - denotes the initial value of the XConsoleHandler::Threshold</li>
            </ul></p>

        @throws ::com::sun::star::lang::IllegalArgumentException
            if `Settings` contains arguments with names other than in the list above, or
            settings whose value is of the wrong type.
    */
    createWithSettings( [in] sequence< ::com::sun::star::beans::NamedValue > Settings )
        raises ( ::com::sun::star::lang::IllegalArgumentException );
};


}; }; }; };


#endif

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