extensions/source/logging/loggerconfig.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: loggerconfig.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef EXTENSIONS_LOGGERCONFIG_HXX
  32 #define EXTENSIONS_LOGGERCONFIG_HXX
  33
  34 /** === begin UNO includes === **/
  35 #include <com/sun/star/logging/XLogger.hpp>
  36 /** === end UNO includes === **/
  37
  38 namespace comphelper
  39 {
  40     class ComponentContext;
  41 }
  42
  43 //........................................................................
  44 namespace logging
  45 {
  46 //........................................................................
  47
  48     /** initializes the given logger from the configuration
  49
  50         The configuration node /org.openoffice.Office.Logging/Settings/<logger_name>
  51         is examined for this. If it does not yet exist, it will be created.
  52
  53         The function creates a default handler and a default formatter, as specified in the
  54         configuration.
  55
  56         This function is currently external to the logger instance. Perhaps it can, on the long
  57         run, be moved to the logger implementation - not sure if it's the best place.
  58     */
  59     void    initializeLoggerFromConfiguration(
  60                 const ::comphelper::ComponentContext& _rContext,
  61                 const ::com::sun::star::uno::Reference< ::com::sun::star::logging::XLogger >& _rxLogger
  62             );
  63
  64 //........................................................................
  65 } // namespace logging
  66 //........................................................................
  67
  68 #endif // EXTENSIONS_LOGGERCONFIG_HXX