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