offapi/com/sun/star/logging/CsvLogFormatter.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_CsvLogFormatter_idl__
  21 #define __com_sun_star_logging_CsvLogFormatter_idl__
  22
  23
  24 module com { module sun { module star { module logging {
  25
  26 interface XCsvLogFormatter;
  27
  28
  29 /** specifies a service which formats log records for RFC4180-style CSV-Files
  30
  31     <p>Every log record, as passed to XCsvLogFormatter::format(),
  32     will be formatted into a single row for a CSV file.
  33     The sequence number, the thread ID, the time of the logged event,
  34     the source class/method name will get logged alongside the message, if this
  35     is not disabled. The Formatter also supports logging an arbitrary number of
  36     user-defined columns. If the Formatter is configured to have more than one
  37     (user-defined) column the data to log has to be preformatted with the
  38     formatMultiColumn method.</p>
  39
  40     @since OOo 3.0
  41  */
  42 service CsvLogFormatter : XCsvLogFormatter
  43 {
  44     /// creates a CsvLogFormatter instance
  45     create();
  46 };
  47
  48
  49 }; }; }; };
  50
  51
  52 #endif
  53
  54 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */