xref: /aoo4110/main/desktop/source/app/configinit.hxx (revision b1cdbd2c)
1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski #ifndef _DESKTOP_CONFIGINIT_HXX_
23*b1cdbd2cSJim Jagielski #define _DESKTOP_CONFIGINIT_HXX_
24*b1cdbd2cSJim Jagielski 
25*b1cdbd2cSJim Jagielski #include <com/sun/star/lang/XMultiServiceFactory.hpp>
26*b1cdbd2cSJim Jagielski #include <rtl/ustring.hxx>
27*b1cdbd2cSJim Jagielski 
28*b1cdbd2cSJim Jagielski /** creates a ConfigurationProvider instance
29*b1cdbd2cSJim Jagielski Important: exceptions thrown from that method will contain a readily
30*b1cdbd2cSJim Jagielski displayable message.
31*b1cdbd2cSJim Jagielski 
32*b1cdbd2cSJim Jagielski     @return
33*b1cdbd2cSJim Jagielski         The default configuration provider for the application or<br/>
34*b1cdbd2cSJim Jagielski         <NULL/>, if startup was canceled
35*b1cdbd2cSJim Jagielski 
36*b1cdbd2cSJim Jagielski     @throw com::sun::star::configuration::CannotLoadConfigurationException
37*b1cdbd2cSJim Jagielski         if the configuration provider can't be created
38*b1cdbd2cSJim Jagielski 
39*b1cdbd2cSJim Jagielski     @throw com::sun::star::lang::ServiceNotRegisteredException
40*b1cdbd2cSJim Jagielski         if the ConfigurationProvider service is unknwon
41*b1cdbd2cSJim Jagielski 
42*b1cdbd2cSJim Jagielski     @throw com::sun::star::lang::WrappedTargetException
43*b1cdbd2cSJim Jagielski         if the configuration backend could be created,
44*b1cdbd2cSJim Jagielski         but incurred a failure later
45*b1cdbd2cSJim Jagielski 
46*b1cdbd2cSJim Jagielski */
47*b1cdbd2cSJim Jagielski extern
48*b1cdbd2cSJim Jagielski com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory >
49*b1cdbd2cSJim Jagielski     CreateApplicationConfigurationProvider( );
50*b1cdbd2cSJim Jagielski 
51*b1cdbd2cSJim Jagielski //-----------------------------------------------------------------------------
52*b1cdbd2cSJim Jagielski #include <com/sun/star/task/XInteractionHandler.hpp>
53*b1cdbd2cSJim Jagielski 
54*b1cdbd2cSJim Jagielski /**
55*b1cdbd2cSJim Jagielski     sets an InteractionHandler for configuration errors in the current context.
56*b1cdbd2cSJim Jagielski 
57*b1cdbd2cSJim Jagielski   */
58*b1cdbd2cSJim Jagielski     class ConfigurationErrorHandler
59*b1cdbd2cSJim Jagielski     {
60*b1cdbd2cSJim Jagielski     public:
61*b1cdbd2cSJim Jagielski         typedef com::sun::star::uno::Reference< com::sun::star::task::XInteractionHandler > InteractionHandler;
62*b1cdbd2cSJim Jagielski 
63*b1cdbd2cSJim Jagielski         /// Constructor: Uses the default interaction handler
ConfigurationErrorHandler()64*b1cdbd2cSJim Jagielski         ConfigurationErrorHandler()
65*b1cdbd2cSJim Jagielski         : m_pContext(0), m_xHandler()
66*b1cdbd2cSJim Jagielski         {}
67*b1cdbd2cSJim Jagielski 
68*b1cdbd2cSJim Jagielski         /// Constructor: Uses an externally provided interaction handler
ConfigurationErrorHandler(const InteractionHandler & xHandler)69*b1cdbd2cSJim Jagielski         ConfigurationErrorHandler(const InteractionHandler & xHandler)
70*b1cdbd2cSJim Jagielski         : m_pContext(0), m_xHandler( xHandler )
71*b1cdbd2cSJim Jagielski         {}
72*b1cdbd2cSJim Jagielski 
73*b1cdbd2cSJim Jagielski         ~ConfigurationErrorHandler();
74*b1cdbd2cSJim Jagielski 
75*b1cdbd2cSJim Jagielski         static InteractionHandler getDefaultInteractionHandler();
76*b1cdbd2cSJim Jagielski 
77*b1cdbd2cSJim Jagielski         /// installs the handler into the current context
78*b1cdbd2cSJim Jagielski         void activate();
79*b1cdbd2cSJim Jagielski         /// deinstalls the handler from the current context, restoring the previous context
80*b1cdbd2cSJim Jagielski         void deactivate();
81*b1cdbd2cSJim Jagielski     private:
82*b1cdbd2cSJim Jagielski         class Context;
83*b1cdbd2cSJim Jagielski         Context * m_pContext;
84*b1cdbd2cSJim Jagielski         InteractionHandler m_xHandler;
85*b1cdbd2cSJim Jagielski     private:
86*b1cdbd2cSJim Jagielski         // not implemented - suppress copy
87*b1cdbd2cSJim Jagielski         ConfigurationErrorHandler(const ConfigurationErrorHandler&);
88*b1cdbd2cSJim Jagielski         void operator=(const ConfigurationErrorHandler&);
89*b1cdbd2cSJim Jagielski     };
90*b1cdbd2cSJim Jagielski 
91*b1cdbd2cSJim Jagielski //-----------------------------------------------------------------------------
92*b1cdbd2cSJim Jagielski #endif
93