xref: /aoo42x/main/offapi/com/sun/star/logging/PlainTextFormatter.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_logging_PlainTextFormatter_idl__
#define __com_sun_star_logging_PlainTextFormatter_idl__

//=============================================================================

module com { module sun { module star { module logging {

interface XLogFormatter;

//=============================================================================

/** specifies a service which formats log records as single line plain text

    <p>Every log record, as passed to <member>XLogFormatter::format</member>, will
    be formatted into a single text line, assembling the sequence number, the thread ID,
    the time of the logged event, the source class/method name (if applicable), and the
    log message.</p>

    @since OOo 2.3
 */
service PlainTextFormatter : XLogFormatter
{
    /// creates a PlainTextFormatter instance
    create();
};

//=============================================================================

}; }; }; };

//=============================================================================

#endif