xref: /AOO41X/main/fpicker/source/office/fpinteraction.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 SVTOOLS_FILEPICKER_INTERACTION_HXX
29*cdf0e10cSrcweir #define SVTOOLS_FILEPICKER_INTERACTION_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <cppuhelper/implbase1.hxx>
32*cdf0e10cSrcweir #include <com/sun/star/task/XInteractionHandler.hpp>
33*cdf0e10cSrcweir 
34*cdf0e10cSrcweir //........................................................................
35*cdf0e10cSrcweir namespace svt
36*cdf0e10cSrcweir {
37*cdf0e10cSrcweir //........................................................................
38*cdf0e10cSrcweir 
39*cdf0e10cSrcweir 	//====================================================================
40*cdf0e10cSrcweir 	//= OFilePickerInteractionHandler
41*cdf0e10cSrcweir 	//====================================================================
42*cdf0e10cSrcweir 	typedef ::cppu::WeakImplHelper1	<	::com::sun::star::task::XInteractionHandler
43*cdf0e10cSrcweir 									>	OFilePickerInteractionHandler_Base;
44*cdf0e10cSrcweir 
45*cdf0e10cSrcweir 	/** a InteractionHandler implementation which extends another handler with some customizability
46*cdf0e10cSrcweir 	*/
47*cdf0e10cSrcweir 	class OFilePickerInteractionHandler : public OFilePickerInteractionHandler_Base
48*cdf0e10cSrcweir 	{
49*cdf0e10cSrcweir     public:
50*cdf0e10cSrcweir         /** flags, which indicates special handled interactions
51*cdf0e10cSrcweir             These values will be used combained as flags - so they must
52*cdf0e10cSrcweir             in range [2^n]!
53*cdf0e10cSrcweir          */
54*cdf0e10cSrcweir         enum EInterceptedInteractions
55*cdf0e10cSrcweir         {
56*cdf0e10cSrcweir             E_NOINTERCEPTION = 0,
57*cdf0e10cSrcweir             E_DOESNOTEXIST   = 1
58*cdf0e10cSrcweir             // next values [2,4,8,16 ...]!
59*cdf0e10cSrcweir         };
60*cdf0e10cSrcweir 
61*cdf0e10cSrcweir 	protected:
62*cdf0e10cSrcweir         ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler > m_xMaster        ; // our master handler
63*cdf0e10cSrcweir         ::com::sun::star::uno::Any                                                      m_aException     ; // the last handled request
64*cdf0e10cSrcweir         sal_Bool                                                                        m_bUsed          ; // indicates using of this interaction handler instance
65*cdf0e10cSrcweir         EInterceptedInteractions                                                        m_eInterceptions ; // enable/disable interception of some special interactions
66*cdf0e10cSrcweir 
67*cdf0e10cSrcweir 	public:
68*cdf0e10cSrcweir         OFilePickerInteractionHandler( const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& _rxMaster );
69*cdf0e10cSrcweir 
70*cdf0e10cSrcweir         // some generic functions
71*cdf0e10cSrcweir         void     enableInterceptions( EInterceptedInteractions eInterceptions );
72*cdf0e10cSrcweir         sal_Bool wasUsed            () const;
73*cdf0e10cSrcweir         void     resetUseState      ();
74*cdf0e10cSrcweir         void     forgetRequest      ();
75*cdf0e10cSrcweir 
76*cdf0e10cSrcweir         // functions to analyze last cached request
77*cdf0e10cSrcweir         sal_Bool wasAccessDenied() const;
78*cdf0e10cSrcweir 
79*cdf0e10cSrcweir 	protected:
80*cdf0e10cSrcweir 		// XInteractionHandler
81*cdf0e10cSrcweir 		virtual void SAL_CALL handle( const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionRequest >& _rxRequest ) throw (::com::sun::star::uno::RuntimeException);
82*cdf0e10cSrcweir 
83*cdf0e10cSrcweir 	private:
84*cdf0e10cSrcweir 		~OFilePickerInteractionHandler();
85*cdf0e10cSrcweir 	};
86*cdf0e10cSrcweir 
87*cdf0e10cSrcweir //........................................................................
88*cdf0e10cSrcweir }	// namespace svt
89*cdf0e10cSrcweir //........................................................................
90*cdf0e10cSrcweir 
91*cdf0e10cSrcweir #endif // SVTOOLS_FILEPICKER_INTERACTION_HXX
92*cdf0e10cSrcweir 
93