xref: /aoo41x/main/dbaccess/source/ui/app/closeveto.hxx (revision cdf0e10c)
1 /*************************************************************************
2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3  *
4  * Copyright 2000, 2010 Oracle and/or its affiliates.
5  *
6  * OpenOffice.org - a multi-platform office productivity suite
7  *
8  * This file is part of OpenOffice.org.
9  *
10  * OpenOffice.org is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU Lesser General Public License version 3
12  * only, as published by the Free Software Foundation.
13  *
14  * OpenOffice.org is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU Lesser General Public License version 3 for more details
18  * (a copy is included in the LICENSE file that accompanied this code).
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * version 3 along with OpenOffice.org.  If not, see
22  * <http://www.openoffice.org/license.html>
23  * for a copy of the LGPLv3 License.
24  *
25  ************************************************************************/
26 
27 #ifndef DBACCESS_CLOSEVETO_HXX
28 #define DBACCESS_CLOSEVETO_HXX
29 
30 #include "dbaccessdllapi.h"
31 
32 /** === begin UNO includes === **/
33 #include <com/sun/star/uno/XInterface.hpp>
34 /** === end UNO includes === **/
35 
36 #include <boost/scoped_ptr.hpp>
37 
38 //......................................................................................................................
39 namespace dbaui
40 {
41 //......................................................................................................................
42 
43 	//==================================================================================================================
44 	//= CloseVeto
45 	//==================================================================================================================
46     struct CloseVeto_Data;
47     /** will add a XCloseListener to a given component, and veto its closing as long as the <code>CloseVeto</code>
48         instance is alive.
49 
50         If closing has been requested and vetoed while the <code>CloseVeto</code> instance is alive, and the ownership
51         went to the <code>CloseVeto</code> instance, then it will close the component in its dtor.
52     */
53 	class DBACCESS_DLLPRIVATE CloseVeto
54 	{
55     public:
56         CloseVeto( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& i_closeable );
57         ~CloseVeto();
58 
59     private:
60         ::boost::scoped_ptr< CloseVeto_Data >   m_pData;
61 	};
62 
63 //......................................................................................................................
64 } // namespace dbaui
65 //......................................................................................................................
66 
67 #endif // DBACCESS_CLOSEVETO_HXX
68