fpicker/source/win32/VistaFilePickerEventHandler.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_WIN32_FILEPICKER_VISTAFILEPICKEREVENTHANDLER_HXX
  21 #define INCLUDED_FPICKER_SOURCE_WIN32_FILEPICKER_VISTAFILEPICKEREVENTHANDLER_HXX
  22
  23 #include <shobjidl.h>
  24
  25 #include "comptr.hxx"
  26 #include "vistatypes.h"
  27 #include "IVistaFilePickerInternalNotify.hxx"
  28
  29 #include <com/sun/star/ui/dialogs/XFilePickerListener.hpp>
  30 #include <com/sun/star/uno/Reference.hxx>
  31
  32 #include <cppuhelper/basemutex.hxx>
  33 #include <cppuhelper/interfacecontainer.h>
  34 #include <osl/interlck.h>
  35
  36 namespace fpicker{
  37 namespace win32{
  38 namespace vista{
  39
  40
  41 // types, const etcpp.
  42
  43
  44 /** todo document me
  45  */
  46 class VistaFilePickerEventHandler : public ::cppu::BaseMutex
  47                                   , public IFileDialogEvents
  48                                   , public IFileDialogControlEvents
  49 {
  50     public:
  51
  52
  53         // ctor/dtor
  54
  55
  56         explicit VistaFilePickerEventHandler(IVistaFilePickerInternalNotify* pInternalNotify);
  57         virtual ~VistaFilePickerEventHandler();
  58
  59
  60         // IUnknown
  61
  62         virtual HRESULT STDMETHODCALLTYPE QueryInterface(REFIID rIID    ,
  63                                                          void** ppObject) override;
  64         virtual ULONG STDMETHODCALLTYPE AddRef() override;
  65         virtual ULONG STDMETHODCALLTYPE Release() override;
  66
  67
  68         // IFileDialogEvents
  69
  70
  71         STDMETHODIMP OnFileOk(IFileDialog* pDialog) override;
  72
  73         STDMETHODIMP OnFolderChanging(IFileDialog* pDialog,
  74                                       IShellItem*  pFolder) override;
  75
  76         STDMETHODIMP OnFolderChange(IFileDialog* pDialog) override;
  77
  78         STDMETHODIMP OnSelectionChange(IFileDialog* pDialog) override;
  79
  80         STDMETHODIMP OnShareViolation(IFileDialog*                 pDialog  ,
  81                                       IShellItem*                  pItem    ,
  82                                       FDE_SHAREVIOLATION_RESPONSE* pResponse) override;
  83
  84         STDMETHODIMP OnTypeChange(IFileDialog* pDialog) override;
  85
  86         STDMETHODIMP OnOverwrite(IFileDialog*            pDialog  ,
  87                                  IShellItem*             pItem    ,
  88                                  FDE_OVERWRITE_RESPONSE* pResponse) override;
  89
  90
  91         // IFileDialogControlEvents
  92
  93
  94         STDMETHODIMP OnItemSelected(IFileDialogCustomize* pCustomize,
  95                                     DWORD                 nIDCtl    ,
  96                                     DWORD                 nIDItem   ) override;
  97
  98         STDMETHODIMP OnButtonClicked(IFileDialogCustomize* pCustomize,
  99                                      DWORD                 nIDCtl    ) override;
 100
 101         STDMETHODIMP OnCheckButtonToggled(IFileDialogCustomize* pCustomize,
 102                                           DWORD                 nIDCtl    ,
 103                                           BOOL                  bChecked  ) override;
 104
 105         STDMETHODIMP OnControlActivating(IFileDialogCustomize* pCustomize,
 106                                          DWORD                 nIDCtl    ) override;
 107
 108
 109         // XFilePickerNotifier
 110
 111         /// @throws css::uno::RuntimeException
 112         virtual void addFilePickerListener( const css::uno::Reference< css::ui::dialogs::XFilePickerListener >& xListener );
 113
 114         /// @throws css::uno::RuntimeException
 115         virtual void removeFilePickerListener( const css::uno::Reference< css::ui::dialogs::XFilePickerListener >& xListener );
 116
 117
 118         // native interface
 119
 120
 121         /** start listening for file picker events on the given file open dialog COM object.
 122          *
 123          *  The broadcaster will be cached internally so deregistration will be easy.
 124          *  Further all needed information is capsulated within this class (e.g. the listener handler).
 125          *  Nobody outside must know such information.
 126          *
 127          *  Nothing will happen if an inconsistent state will be detected
 128          *  (means: double registration will be ignored).
 129          *
 130          *  @param  pBroadcaster
 131          *          reference to the dialog, where we should start listening.
 132          */
 133         void startListening( const TFileDialog& pBroadcaster );
 134
 135
 136         /** stop listening for file picker events on the internally cached dialog COM object.
 137          *
 138          *  The COM dialog provided on the startListening() call was cached internally.
 139          *  And now it's used to deregister this listener. Doing so the also internally cached
 140          *  listener handle is used. If listener was not already registered - nothing will happen.
 141          */
 142         void stopListening();
 143
 144     public:
 145
 146         enum EEventType
 147         {
 148             E_FILE_SELECTION_CHANGED,
 149             E_DIRECTORY_CHANGED,
 150             E_HELP_REQUESTED,
 151             E_CONTROL_STATE_CHANGED,
 152             E_DIALOG_SIZE_CHANGED
 153         };
 154
 155     private:
 156
 157
 158         /// @todo document me
 159         void impl_sendEvent(  EEventType eEventType,
 160                             ::sal_Int16  nControlID);
 161
 162     private:
 163
 164
 165         /// ref count for AddRef/Release()
 166         oslInterlockedCount m_nRefCount;
 167
 168
 169         /// unique handle for this listener provided by the broadcaster on registration time
 170         DWORD m_nListenerHandle;
 171
 172
 173         /// cached file dialog instance (there we listen for events)
 174         TFileDialog m_pDialog;
 175
 176
 177         IVistaFilePickerInternalNotify* m_pInternalNotify;
 178
 179
 180         /** used to inform file picker listener asynchronously.
 181          *  Those listener must be called asynchronously .. because
 182          *  every request will block the caller thread. Mostly that will be
 183          *  the main thread of the office. Further the global SolarMutex will
 184          *  be locked during this time. If we call our listener back now synchronously ..
 185          *  we will block on SolarMutex.acquire() forever .-))
 186          */
 187         ::cppu::OMultiTypeInterfaceContainerHelper m_lListener;
 188 };
 189
 190 } // namespace vista
 191 } // namespace win32
 192 } // namespace fpicker
 193
 194 #endif // INCLUDED_FPICKER_SOURCE_WIN32_FILEPICKER_VISTAFILEPICKEREVENTHANDLER_HXX
 195
 196 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */