offapi/com/sun/star/logging/FileHandler.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   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/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  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 .
  18  */
  19
  20
  21 module com { module sun { module star { module logging {
  22
  23 interface XLogHandler;
  24
  25
  26 /** specifies a component implementing a log handler whose output
  27     channel is a file.
  28
  29     <p>The handler will use the <code>Encoding</code> attribute of XLogHandler
  30     to determine how to encode strings before actually writing them to the output
  31     file.</p>
  32
  33     @see XLogHandler::Encoding
  34
  35     @since OOo 2.3
  36  */
  37 service FileHandler : XLogHandler
  38 {
  39     /** creates a log handler whose output is directed to a file given by URL.
  40
  41         @param FileURL
  42             the URL of the file to be created. This URL is resolved using the
  43             ::com::sun::star::util::PathSubstitution service. That
  44             is, it is allowed to include placeholders such as <code>$(userurl)</code>.
  45     */
  46     create( [in] string FileURL );
  47
  48     /** creates an instance of the log handler, using generic settings
  49
  50         @param Settings
  51             contains the initial settings for the log handler
  52
  53             <p>The following settings are recognized and supported:
  54             <ul><li><code>Encoding</code> - denotes the initial value of the XLogHandler::Encoding</li>
  55                 <li><code>Formatter</code> - denotes the initial value of the XLogHandler::Formatter</li>
  56                 <li><code>Level</code> - denotes the initial value of the XLogHandler::Level</li>
  57             </ul></p>
  58
  59             <p>Additionally, a setting name <code>FileURL</code> is recognized. It must be of type
  60             string, and denotes the file URL to which the handler's output should be directed.</p>
  61
  62             <p>At least the URL argument must be present in the settings.</p>
  63
  64         @throws ::com::sun::star::lang::IllegalArgumentException
  65             if `Settings` contains settings whose value is of the wrong type.
  66     */
  67     createWithSettings( [in] sequence< ::com::sun::star::beans::NamedValue > Settings )
  68         raises ( ::com::sun::star::lang::IllegalArgumentException );
  69 };
  70
  71
  72 }; }; }; };
  73
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */