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