offapi/com/sun/star/logging/ConsoleHandler.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 #ifndef __com_sun_star_logging_ConsoleHandler_idl__
  21 #define __com_sun_star_logging_ConsoleHandler_idl__
  22
  23 #include <com/sun/star/lang/IllegalArgumentException.idl>
  24 #include <com/sun/star/beans/NamedValue.idl>
  25
  26
  27 module com { module sun { module star { module logging {
  28
  29 interface XConsoleHandler;
  30
  31
  32 /** specifies a component implementing a log handler whose output
  33     channel is the processes console.
  34
  35     @since OOo 2.3
  36  */
  37 service ConsoleHandler : XConsoleHandler
  38 {
  39     /// creates a <code>ConsoleHandler</code>
  40     create();
  41
  42     /** creates an instance of the log handler, using generic settings
  43
  44         @param Settings
  45             contains the initial settings for the log handler
  46
  47             <p>The following settings are recognized and supported:
  48             <ul><li><code>Encoding</code> - denotes the initial value of the XLogHandler::Encoding</li>
  49                 <li><code>Formatter</code> - denotes the initial value of the XLogHandler::Formatter</li>
  50                 <li><code>Level</code> - denotes the initial value of the XLogHandler::Level</li>
  51                 <li><code>Threshold</code> - denotes the initial value of the XConsoleHandler::Threshold</li>
  52             </ul></p>
  53
  54         @throws ::com::sun::star::lang::IllegalArgumentException
  55             if `Settings` contains arguments with names other than in the list above, or
  56             settings whose value is of the wrong type.
  57     */
  58     createWithSettings( [in] sequence< ::com::sun::star::beans::NamedValue > Settings )
  59         raises ( ::com::sun::star::lang::IllegalArgumentException );
  60 };
  61
  62
  63 }; }; }; };
  64
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */