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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __offapi_com_sun_star_logging_XConsoleHandler_idl__
  29 #define __offapi_com_sun_star_logging_XConsoleHandler_idl__
  30
  31 #ifndef __com_sun_star_logging_XLogHandler_idl__
  32 #include <com/sun/star/logging/XLogHandler.idl>
  33 #endif
  34
  35 //=============================================================================
  36
  37 module com { module sun { module star { module logging {
  38
  39 //=============================================================================
  40
  41 /** implemented by a log handler whose output channel is the processes console.
  42
  43     <p>Note that a console handler will ignore its formatter's head and tail, since
  44     it cannot decided whether they should be emitted on <code>stdout</code> or <code>stderr</code>.</p>
  45
  46     @since OOo 2.3
  47  */
  48 interface XConsoleHandler : XLogHandler
  49 {
  50     /** renotes the <type>LogLevel</type> threshold used to determine to which
  51         console the events should be logged.
  52
  53         <p>Events with a level greater or equal to <code>Threshold</code> will be
  54         logged to <code>stderr</code>, all others to <code>stdout</code>.</p>
  55
  56         <p>The default value for this attribute is <member>LogLevel::SEVERE</member>.</p>
  57     */
  58     [attribute] long    Threshold;
  59 };
  60
  61 //=============================================================================
  62
  63 }; }; }; };
  64
  65 //=============================================================================
  66
  67 #endif