1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef EXTENSIONS_LOGGERCONFIG_HXX
25 #define EXTENSIONS_LOGGERCONFIG_HXX
26 
27 /** === begin UNO includes === **/
28 #include <com/sun/star/logging/XLogger.hpp>
29 /** === end UNO includes === **/
30 
31 namespace comphelper
32 {
33     class ComponentContext;
34 }
35 
36 //........................................................................
37 namespace logging
38 {
39 //........................................................................
40 
41     /** initializes the given logger from the configuration
42 
43         The configuration node /org.openoffice.Office.Logging/Settings/<logger_name>
44         is examined for this. If it does not yet exist, it will be created.
45 
46         The function creates a default handler and a default formatter, as specified in the
47         configuration.
48 
49         This function is currently external to the logger instance. Perhaps it can, on the long
50         run, be moved to the logger implementation - not sure if it's the best place.
51     */
52     void    initializeLoggerFromConfiguration(
53                 const ::comphelper::ComponentContext& _rContext,
54                 const ::com::sun::star::uno::Reference< ::com::sun::star::logging::XLogger >& _rxLogger
55             );
56 
57 //........................................................................
58 } // namespace logging
59 //........................................................................
60 
61 #endif // EXTENSIONS_LOGGERCONFIG_HXX
62