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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   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
  29 #ifndef __com_sun_star_logging_XCsvLogFormatter_idl__
  30 #define __com_sun_star_logging_XCsvLogFormatter_idl__
  31
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #include <com/sun/star/logging/XLogFormatter.idl>
  34
  35 //=============================================================================
  36
  37 module com { module sun { module star { module logging {
  38
  39 //=============================================================================
  40
  41 /** specifies the interface used for formatting log records for RFC4180 CSV
  42     output
  43
  44     @see XLogFormatter, XLogHandler
  45
  46     @since OOo 3.0
  47 */
  48 interface XCsvLogFormatter : XLogFormatter
  49 {
  50     /** Defines if the EventNo should be logged */
  51     [attribute] boolean LogEventNo;
  52     /** Defines if the ThreadId should be logged */
  53     [attribute] boolean LogThread;
  54     /** Defines if the Timestamp should be logged */
  55     [attribute] boolean LogTimestamp;
  56     /** Defines if the Source should be logged */
  57     [attribute] boolean LogSource;
  58     /** Defines the names of the additional columns
  59         this defaults to only one row titled "message".
  60         if this is set to more than one column, the
  61         messages need to be preformatted using
  62         <code>formatMultiColumn</code>*/
  63     [attribute] sequence< string >  Columnnames;
  64     /** if the CsvLogFormatter is set to have more than one
  65         column, any logged information has to be send through this
  66         method before calling log(). E.g.:
  67
  68         <code>XLoggerInstance.log(1000, XCsvLogFormatterInstance.formatMultiColumn(column_data))</code>
  69     */
  70     string formatMultiColumn( [in] sequence< string > column_data);
  71 };
  72
  73 //=============================================================================
  74
  75 }; }; }; };
  76
  77 //=============================================================================
  78
  79 #endif
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */