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