fpicker/source/office/fpinteraction.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: fpinteraction.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SVTOOLS_FILEPICKER_INTERACTION_HXX
  32 #define SVTOOLS_FILEPICKER_INTERACTION_HXX
  33
  34 #include <cppuhelper/implbase1.hxx>
  35 #include <com/sun/star/task/XInteractionHandler.hpp>
  36
  37 //........................................................................
  38 namespace svt
  39 {
  40 //........................................................................
  41
  42     //====================================================================
  43     //= OFilePickerInteractionHandler
  44     //====================================================================
  45     typedef ::cppu::WeakImplHelper1     <       ::com::sun::star::task::XInteractionHandler
  46                                     >   OFilePickerInteractionHandler_Base;
  47
  48     /** a InteractionHandler implementation which extends another handler with some customizability
  49     */
  50     class OFilePickerInteractionHandler : public OFilePickerInteractionHandler_Base
  51     {
  52     public:
  53         /** flags, which indicates special handled interactions
  54             These values will be used combained as flags - so they must
  55             in range [2^n]!
  56          */
  57         enum EInterceptedInteractions
  58         {
  59             E_NOINTERCEPTION = 0,
  60             E_DOESNOTEXIST   = 1
  61             // next values [2,4,8,16 ...]!
  62         };
  63
  64     protected:
  65         ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler > m_xMaster        ; // our master handler
  66         ::com::sun::star::uno::Any                                                      m_aException     ; // the last handled request
  67         sal_Bool                                                                        m_bUsed          ; // indicates using of this interaction handler instance
  68         EInterceptedInteractions                                                        m_eInterceptions ; // enable/disable interception of some special interactions
  69
  70     public:
  71         OFilePickerInteractionHandler( const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& _rxMaster );
  72
  73         // some generic functions
  74         void     enableInterceptions( EInterceptedInteractions eInterceptions );
  75         sal_Bool wasUsed            () const;
  76         void     resetUseState      ();
  77         void     forgetRequest      ();
  78
  79         // functions to analyze last cached request
  80         sal_Bool wasAccessDenied() const;
  81
  82     protected:
  83         // XInteractionHandler
  84         virtual void SAL_CALL handle( const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionRequest >& _rxRequest ) throw (::com::sun::star::uno::RuntimeException);
  85
  86     private:
  87         ~OFilePickerInteractionHandler();
  88     };
  89
  90 //........................................................................
  91 }       // namespace svt
  92 //........................................................................
  93
  94 #endif // SVTOOLS_FILEPICKER_INTERACTION_HXX
  95