xref: /trunk/main/dbaccess/source/ui/app/closeveto.hxx (revision 161f4cd1)
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 DBACCESS_CLOSEVETO_HXX
25 #define DBACCESS_CLOSEVETO_HXX
26 
27 #include "dbaccessdllapi.h"
28 
29 /** === begin UNO includes === **/
30 #include <com/sun/star/uno/XInterface.hpp>
31 /** === end UNO includes === **/
32 
33 #include <boost/scoped_ptr.hpp>
34 
35 //......................................................................................................................
36 namespace dbaui
37 {
38 //......................................................................................................................
39 
40 	//==================================================================================================================
41 	//= CloseVeto
42 	//==================================================================================================================
43     struct CloseVeto_Data;
44     /** will add a XCloseListener to a given component, and veto its closing as long as the <code>CloseVeto</code>
45         instance is alive.
46 
47         If closing has been requested and vetoed while the <code>CloseVeto</code> instance is alive, and the ownership
48         went to the <code>CloseVeto</code> instance, then it will close the component in its dtor.
49     */
50 	class DBACCESS_DLLPRIVATE CloseVeto
51 	{
52     public:
53         CloseVeto( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& i_closeable );
54         ~CloseVeto();
55 
56     private:
57         ::boost::scoped_ptr< CloseVeto_Data >   m_pData;
58 	};
59 
60 //......................................................................................................................
61 } // namespace dbaui
62 //......................................................................................................................
63 
64 #endif // DBACCESS_CLOSEVETO_HXX
65