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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef __com_sun_star_logging_XLogFormatter_idl__
  30 #define __com_sun_star_logging_XLogFormatter_idl__
  31
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #include <com/sun/star/logging/LogRecord.idl>
  34
  35 //=============================================================================
  36
  37 module com { module sun { module star { module logging {
  38
  39 //=============================================================================
  40
  41 /** specifies the interface to be used for formatting log records
  42
  43     @see XLogHandler
  44
  45     @since OOo 2.3
  46 */
  47 interface XLogFormatter
  48 {
  49     /** returns the header string for the log
  50
  51         <p>This can be used to generate a header string, which by the <type>XLogHandler</type>
  52         is emitted to its output channel before actually logging any concrete
  53         <type>LogRecord</type>.</p>
  54
  55         <p>For instance, a formatter might produce table-like plain text output,
  56         and could return a table-head string (potentially including line breaks)
  57         here.</p>
  58     */
  59     string  getHead();
  60
  61     /** formats the given log record for output
  62
  63         <p>A <type>XLogHandler</type> will call this method to format a given
  64         log record. The resulting string will be emitted to the handler's output
  65         channel, without processing it any further (except possibly encoding it with
  66         the handler's <code>Encoding</code>).</p>
  67     */
  68     string  format( [in] LogRecord Record );
  69
  70     /** returns the footer string for the log
  71
  72         <p>This can be used to generate a footer string, which by the <type>XLogHandler</type>
  73         is emitted to its output channel before it is finally being closed.</p>
  74     */
  75     string  getTail();
  76 };
  77
  78 //=============================================================================
  79
  80 }; }; }; };
  81
  82 //=============================================================================
  83
  84 #endif
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */