xref: /AOO41X/main/sd/source/ui/framework/configuration/UpdateRequest.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 SD_FRAMEWORK_UPDATE_REQUEST_HXX
29*cdf0e10cSrcweir #define SD_FRAMEWORK_UPDATE_REQUEST_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include "MutexOwner.hxx"
32*cdf0e10cSrcweir #include <com/sun/star/drawing/framework/XConfigurationChangeRequest.hpp>
33*cdf0e10cSrcweir #include <com/sun/star/container/XNamed.hpp>
34*cdf0e10cSrcweir #include <com/sun/star/drawing/framework/XConfiguration.hpp>
35*cdf0e10cSrcweir #include <cppuhelper/compbase2.hxx>
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir 
38*cdf0e10cSrcweir namespace {
39*cdf0e10cSrcweir 
40*cdf0e10cSrcweir typedef ::cppu::WeakComponentImplHelper2 <
41*cdf0e10cSrcweir       ::com::sun::star::drawing::framework::XConfigurationChangeRequest,
42*cdf0e10cSrcweir       ::com::sun::star::container::XNamed
43*cdf0e10cSrcweir     > UpdateRequestInterfaceBase;
44*cdf0e10cSrcweir 
45*cdf0e10cSrcweir } // end of anonymous namespace.
46*cdf0e10cSrcweir 
47*cdf0e10cSrcweir 
48*cdf0e10cSrcweir 
49*cdf0e10cSrcweir namespace sd { namespace framework {
50*cdf0e10cSrcweir 
51*cdf0e10cSrcweir /** This update request is used to request configuration updates
52*cdf0e10cSrcweir     asynchronous when no other requests are being processed.  When there are
53*cdf0e10cSrcweir     other requests then we can simply wait until the last one is executed:
54*cdf0e10cSrcweir     the configuration is updated when the request queue becomes empty.  This
55*cdf0e10cSrcweir     is use by this implementation as well.  The execute() method does not
56*cdf0e10cSrcweir     really do anything.  This request just triggers the update of the
57*cdf0e10cSrcweir     configuration when it is removed as last request from the queue.
58*cdf0e10cSrcweir */
59*cdf0e10cSrcweir class UpdateRequest
60*cdf0e10cSrcweir     : private MutexOwner,
61*cdf0e10cSrcweir       public UpdateRequestInterfaceBase
62*cdf0e10cSrcweir {
63*cdf0e10cSrcweir public:
64*cdf0e10cSrcweir 	UpdateRequest (void) throw();
65*cdf0e10cSrcweir 	virtual ~UpdateRequest (void) throw();
66*cdf0e10cSrcweir 
67*cdf0e10cSrcweir 
68*cdf0e10cSrcweir     // XConfigurationChangeOperation
69*cdf0e10cSrcweir 
70*cdf0e10cSrcweir     virtual void SAL_CALL execute (
71*cdf0e10cSrcweir         const ::com::sun::star::uno::Reference<
72*cdf0e10cSrcweir             com::sun::star::drawing::framework::XConfiguration>& rxConfiguration)
73*cdf0e10cSrcweir         throw (::com::sun::star::uno::RuntimeException);
74*cdf0e10cSrcweir 
75*cdf0e10cSrcweir 
76*cdf0e10cSrcweir     // XNamed
77*cdf0e10cSrcweir 
78*cdf0e10cSrcweir     /** Return a human readable string representation.  This is used for
79*cdf0e10cSrcweir         debugging purposes.
80*cdf0e10cSrcweir     */
81*cdf0e10cSrcweir     virtual ::rtl::OUString SAL_CALL getName (void)
82*cdf0e10cSrcweir         throw (::com::sun::star::uno::RuntimeException);
83*cdf0e10cSrcweir 
84*cdf0e10cSrcweir     /** This call is ignored because the XNamed interface is (mis)used to
85*cdf0e10cSrcweir         give access to a human readable name for debugging purposes.
86*cdf0e10cSrcweir     */
87*cdf0e10cSrcweir     virtual void SAL_CALL setName (const ::rtl::OUString& rName)
88*cdf0e10cSrcweir         throw (::com::sun::star::uno::RuntimeException);
89*cdf0e10cSrcweir };
90*cdf0e10cSrcweir 
91*cdf0e10cSrcweir } } // end of namespace sd::framework
92*cdf0e10cSrcweir 
93*cdf0e10cSrcweir #endif
94