1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
3 * This file is part of the LibreOffice project.
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
9 * This file incorporates work covered by the following license notice:
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
20 #ifndef __com_sun_star_logging_FileHandler_idl__
21 #define __com_sun_star_logging_FileHandler_idl__
23 #include
<com
/sun
/star
/lang
/IllegalArgumentException.idl
>
24 #include
<com
/sun
/star
/beans
/NamedValue.idl
>
27 module com
{ module sun
{ module star
{ module logging
{
29 interface XLogHandler
;
32 /** specifies a component implementing a log handler whose output
35 <p>The handler will use the <code>Encoding</code> attribute of XLogHandler
36 to determine how to encode strings before actually writing them to the output
39 @see XLogHandler::Encoding
43 service FileHandler
: XLogHandler
45 /** creates a log handler whose output is directed to a file given by URL.
48 the URL of the file to be created. This URL is resolved using the
49 ::com::sun::star::util::PathSubstitution service. That
50 is, it is allowed to include placeholders such as <code>$(userurl)</code>.
52 create
( [in] string FileURL
);
54 /** creates an instance of the log handler, using generic settings
57 contains the initial settings for the log handler
59 <p>The following settings are recognized and supported:
60 <ul><li><code>Encoding</code> - denotes the initial value of the XLogHandler::Encoding</li>
61 <li><code>Formatter</code> - denotes the initial value of the XLogHandler::Formatter</li>
62 <li><code>Level</code> - denotes the initial value of the XLogHandler::Level</li>
65 <p>Additionally, a setting name <code>FileURL</code> is recognized. It must be of type
66 string, and denotes the file URL to which the handler's output should be directed.</p>
68 <p>At least the URL argument must be present in the settings.</p>
70 @throws ::com::sun::star::lang::IllegalArgumentException
71 if `Settings` contains settings whose value is of the wrong type.
73 createWithSettings
( [in] sequence
< ::com
::sun
::star
::beans
::NamedValue
> Settings
)
74 raises
( ::com
::sun
::star
::lang
::IllegalArgumentException
);
83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */