fpicker/source/office/fpinteraction.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef SVTOOLS_FILEPICKER_INTERACTION_HXX
  21 #define SVTOOLS_FILEPICKER_INTERACTION_HXX
  22
  23 #include <cppuhelper/implbase1.hxx>
  24 #include <com/sun/star/task/XInteractionHandler.hpp>
  25
  26 //........................................................................
  27 namespace svt
  28 {
  29 //........................................................................
  30
  31     //====================================================================
  32     //= OFilePickerInteractionHandler
  33     //====================================================================
  34     typedef ::cppu::WeakImplHelper1 <   ::com::sun::star::task::XInteractionHandler
  35                                     >   OFilePickerInteractionHandler_Base;
  36
  37     /** a InteractionHandler implementation which extends another handler with some customizability
  38     */
  39     class OFilePickerInteractionHandler : public OFilePickerInteractionHandler_Base
  40     {
  41     public:
  42         /** flags, which indicates special handled interactions
  43             These values will be used combained as flags - so they must
  44             in range [2^n]!
  45          */
  46         enum EInterceptedInteractions
  47         {
  48             E_NOINTERCEPTION = 0,
  49             E_DOESNOTEXIST   = 1
  50             // next values [2,4,8,16 ...]!
  51         };
  52
  53     protected:
  54         ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler > m_xMaster        ; // our master handler
  55         ::com::sun::star::uno::Any                                                      m_aException     ; // the last handled request
  56         sal_Bool                                                                        m_bUsed          ; // indicates using of this interaction handler instance
  57         EInterceptedInteractions                                                        m_eInterceptions ; // enable/disable interception of some special interactions
  58
  59     public:
  60         OFilePickerInteractionHandler( const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& _rxMaster );
  61
  62         // some generic functions
  63         void     enableInterceptions( EInterceptedInteractions eInterceptions );
  64         sal_Bool wasUsed            () const;
  65         void     resetUseState      ();
  66         void     forgetRequest      ();
  67
  68         // functions to analyze last cached request
  69         sal_Bool wasAccessDenied() const;
  70
  71     protected:
  72         // XInteractionHandler
  73         virtual void SAL_CALL handle( const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionRequest >& _rxRequest ) throw (::com::sun::star::uno::RuntimeException);
  74
  75     private:
  76         ~OFilePickerInteractionHandler();
  77     };
  78
  79 //........................................................................
  80 }   // namespace svt
  81 //........................................................................
  82
  83 #endif // SVTOOLS_FILEPICKER_INTERACTION_HXX
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */