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

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