extensions/source/logging/loggerconfig.hxx

   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 INCLUDED_EXTENSIONS_SOURCE_LOGGING_LOGGERCONFIG_HXX
  21 #define INCLUDED_EXTENSIONS_SOURCE_LOGGING_LOGGERCONFIG_HXX
  22
  23 #include <com/sun/star/logging/XLogger.hpp>
  24 #include <com/sun/star/uno/XComponentContext.hpp>
  25
  26
  27 namespace logging
  28 {
  29
  30
  31     /** initializes the given logger from the configuration
  32
  33         The configuration node /org.openoffice.Office.Logging/Settings/<logger_name>
  34         is examined for this. If it does not yet exist, it will be created.
  35
  36         The function creates a default handler and a default formatter, as specified in the
  37         configuration.
  38
  39         This function is currently external to the logger instance. Perhaps it can, on the long
  40         run, be moved to the logger implementation - not sure if it's the best place.
  41     */
  42     void    initializeLoggerFromConfiguration(
  43                 const css::uno::Reference<css::uno::XComponentContext>& _rContext,
  44                 const ::com::sun::star::uno::Reference< ::com::sun::star::logging::XLogger >& _rxLogger
  45             );
  46
  47
  48 } // namespace logging
  49
  50
  51 #endif // INCLUDED_EXTENSIONS_SOURCE_LOGGING_LOGGERCONFIG_HXX
  52
  53 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */