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