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