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 INCLUDED_FPICKER_SOURCE_OFFICE_FPINTERACTION_HXX
  21 #define INCLUDED_FPICKER_SOURCE_OFFICE_FPINTERACTION_HXX
  22
  23 #include <cppuhelper/implbase.hxx>
  24 #include <com/sun/star/task/XInteractionHandler.hpp>
  25
  26
  27 namespace svt
  28 {
  29
  30
  31     //= OFilePickerInteractionHandler
  32
  33     typedef ::cppu::WeakImplHelper <   css::task::XInteractionHandler
  34                                     >   OFilePickerInteractionHandler_Base;
  35
  36     /** an InteractionHandler implementation which extends another handler with some customizability
  37     */
  38     class OFilePickerInteractionHandler final : public OFilePickerInteractionHandler_Base
  39     {
  40     public:
  41         /** flags, which indicates special handled interactions
  42             These values will be used combined as flags - so they must
  43             in range [2^n]!
  44          */
  45         enum EInterceptedInteractions
  46         {
  47             E_NOINTERCEPTION = 0,
  48             E_DOESNOTEXIST   = 1
  49             // next values [2,4,8,16 ...]!
  50         };
  51
  52     private:
  53         css::uno::Reference< css::task::XInteractionHandler > m_xMaster;    // our master handler
  54         css::uno::Any                                         m_aException; // the last handled request
  55         bool                                                  m_bUsed;      // indicates using of this interaction handler instance
  56         EInterceptedInteractions                              m_eInterceptions; // enable/disable interception of some special interactions
  57
  58     public:
  59         explicit OFilePickerInteractionHandler( const css::uno::Reference< css::task::XInteractionHandler >& _rxMaster );
  60
  61         // some generic functions
  62         void     enableInterceptions( EInterceptedInteractions eInterceptions );
  63         bool wasUsed            () const { return m_bUsed; }
  64         void     resetUseState      ();
  65         void     forgetRequest      ();
  66
  67         // functions to analyze last cached request
  68         bool wasAccessDenied() const;
  69
  70     private:
  71         // XInteractionHandler
  72         virtual void SAL_CALL handle( const css::uno::Reference< css::task::XInteractionRequest >& _rxRequest ) override;
  73
  74         virtual ~OFilePickerInteractionHandler() override;
  75     };
  76
  77
  78 }   // namespace svt
  79
  80
  81 #endif // INCLUDED_FPICKER_SOURCE_OFFICE_FPINTERACTION_HXX
  82
  83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */