75 lines
2.9 KiB
Text
75 lines
2.9 KiB
Text
/* -*- 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 .
|
|
*/
|
|
|
|
|
|
module com { module sun { module star { module logging {
|
|
|
|
interface XLogHandler;
|
|
|
|
|
|
/** specifies a component implementing a log handler whose output
|
|
channel is a file.
|
|
|
|
<p>The handler will use the <code>Encoding</code> attribute of XLogHandler
|
|
to determine how to encode strings before actually writing them to the output
|
|
file.</p>
|
|
|
|
@see XLogHandler::Encoding
|
|
|
|
@since OOo 2.3
|
|
*/
|
|
service FileHandler : XLogHandler
|
|
{
|
|
/** creates a log handler whose output is directed to a file given by URL.
|
|
|
|
@param FileURL
|
|
the URL of the file to be created. This URL is resolved using the
|
|
::com::sun::star::util::PathSubstitution service. That
|
|
is, it is allowed to include placeholders such as <code>$(userurl)</code>.
|
|
*/
|
|
create( [in] string FileURL );
|
|
|
|
/** 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>
|
|
</ul></p>
|
|
|
|
<p>Additionally, a setting name <code>FileURL</code> is recognized. It must be of type
|
|
string, and denotes the file URL to which the handler's output should be directed.</p>
|
|
|
|
<p>At least the URL argument must be present in the settings.</p>
|
|
|
|
@throws ::com::sun::star::lang::IllegalArgumentException
|
|
if `Settings` contains settings whose value is of the wrong type.
|
|
*/
|
|
createWithSettings( [in] sequence< ::com::sun::star::beans::NamedValue > Settings )
|
|
raises ( ::com::sun::star::lang::IllegalArgumentException );
|
|
};
|
|
|
|
|
|
}; }; }; };
|
|
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|