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