offapi/com/sun/star/logging/XConsoleHandler.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_XConsoleHandler_idl__
  21 #define __com_sun_star_logging_XConsoleHandler_idl__
  22
  23 #include <com/sun/star/logging/XLogHandler.idl>
  24
  25
  26 module com { module sun { module star { module logging {
  27
  28
  29 /** implemented by a log handler whose output channel is the processes console.
  30
  31     <p>Note that a console handler will ignore its formatter's head and tail, since
  32     it cannot decided whether they should be emitted on <code>stdout</code> or <code>stderr</code>.</p>
  33
  34     @since OOo 2.3
  35  */
  36 interface XConsoleHandler : XLogHandler
  37 {
  38     /** denotes the LogLevel threshold used to determine to which
  39         console the events should be logged.
  40
  41         <p>Events with a level greater or equal to <code>Threshold</code> will be
  42         logged to <code>stderr</code>, all others to <code>stdout</code>.</p>
  43
  44         <p>The default value for this attribute is LogLevel::SEVERE.</p>
  45     */
  46     [attribute] long    Threshold;
  47 };
  48
  49
  50 }; }; }; };
  51
  52
  53 #endif
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */