office-gobmx/fpicker/source/win32/VistaFilePicker.hxx
Matt K 1c1226709c tdf#106282 Change Windows File Dialog to run on the main thread
Windows crashes when an IFileDialog object is used on a non-main
thread when cancelling a long search operation, when COM is
initialized as single-threaded apartment for that thread.
Trying to use a non-main thread with COM initialized to
multi-threaded apartment hangs the dialog UI.  The only solution
that works is to run all File Dialogs on the main thread.  This
has a performance penalty on the application while a File Dialog
is open or if multiple dialogs are searching and then cancelled,
but it's better than crashing.  Other applications like Firefox
use only the main thread for File Dialogs, but have additional
processes to avoid the performance penalty.

Change-Id: Icf8a8179dbea19bd3d749a1c2fe8e67dbfc726c6
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/114482
Reviewed-by: Matt K <mattkse@gmail.com>
Reviewed-by: Jan-Marek Glogowski <glogow@fbihome.de>
Reviewed-by: Mike Kaganski <mike.kaganski@collabora.com>
Tested-by: Jenkins
2021-04-22 22:20:55 +02:00

224 lines
6.5 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#pragma once
#include "requests.hxx"
#include "VistaFilePickerImpl.hxx"
#include "VistaFilePickerEventHandler.hxx"
#include <com/sun/star/lang/XInitialization.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/ui/dialogs/XFilePicker3.hpp>
#include <com/sun/star/ui/dialogs/XFilePickerControlAccess.hpp>
#include <com/sun/star/ui/dialogs/XFilePreview.hpp>
#include <com/sun/star/ui/dialogs/XFolderPicker2.hpp>
#include <cppuhelper/compbase.hxx>
#include <cppuhelper/basemutex.hxx>
#include <rtl/ustring.hxx>
namespace fpicker{
namespace win32{
namespace vista{
// types
typedef ::cppu::WeakComponentImplHelper<
css::ui::dialogs::XFilePicker3,
css::ui::dialogs::XFilePickerControlAccess,
css::ui::dialogs::XFilePreview,
css::ui::dialogs::XFolderPicker2,
css::lang::XInitialization,
css::lang::XServiceInfo > TVistaFilePickerBase;
/** Implements the XFilePicker & friends interface(s)
for Windows Vista and upcoming versions.
Note: This will be a UNO wrapper for the real file picker
implementation only. The real implementation is done in class
VistaFilePickerImpl.
*/
class VistaFilePicker : public ::cppu::BaseMutex
, public TVistaFilePickerBase
{
public:
// ctor/dtor
explicit VistaFilePicker( bool bFolderPicker );
virtual ~VistaFilePicker() override;
// XFilePickerNotifier
virtual void SAL_CALL addFilePickerListener( const css::uno::Reference< css::ui::dialogs::XFilePickerListener >& xListener ) override;
virtual void SAL_CALL removeFilePickerListener( const css::uno::Reference< css::ui::dialogs::XFilePickerListener >& xListener ) override;
// XExecutableDialog functions
virtual void SAL_CALL setTitle( const OUString& sTitle ) override;
virtual sal_Int16 SAL_CALL execute( ) override;
// XFilePicker functions
virtual void SAL_CALL setMultiSelectionMode( sal_Bool bMode ) override;
virtual void SAL_CALL setDefaultName( const OUString& sName ) override;
virtual void SAL_CALL setDisplayDirectory( const OUString& sDirectory ) override;
virtual OUString SAL_CALL getDisplayDirectory( ) override;
virtual css::uno::Sequence< OUString > SAL_CALL getFiles( ) override;
// XFilePicker2 functions
virtual css::uno::Sequence< OUString > SAL_CALL getSelectedFiles( ) override;
// XFilterManager functions
virtual void SAL_CALL appendFilter( const OUString& sTitle ,
const OUString& sFilter ) override;
virtual void SAL_CALL setCurrentFilter( const OUString& sTitle ) override;
virtual OUString SAL_CALL getCurrentFilter( ) override;
// XFilterGroupManager functions
virtual void SAL_CALL appendFilterGroup( const OUString& sGroupTitle,
const css::uno::Sequence< css::beans::StringPair >& lFilters ) override;
// XFilePickerControlAccess functions
virtual void SAL_CALL setValue( sal_Int16 nControlId ,
sal_Int16 nControlAction,
const css::uno::Any& aValue ) override;
virtual css::uno::Any SAL_CALL getValue( sal_Int16 nControlId ,
sal_Int16 nControlAction ) override;
virtual void SAL_CALL enableControl( sal_Int16 nControlId,
sal_Bool bEnable ) override;
virtual void SAL_CALL setLabel( sal_Int16 nControlId,
const OUString& sLabel ) override;
virtual OUString SAL_CALL getLabel( sal_Int16 nControlId ) override;
// XFilePreview
virtual css::uno::Sequence< sal_Int16 > SAL_CALL getSupportedImageFormats( ) override;
virtual sal_Int32 SAL_CALL getTargetColorDepth( ) override;
virtual sal_Int32 SAL_CALL getAvailableWidth( ) override;
virtual sal_Int32 SAL_CALL getAvailableHeight( ) override;
virtual void SAL_CALL setImage( sal_Int16 nImageFormat,
const css::uno::Any& aImage ) override;
virtual sal_Bool SAL_CALL setShowState( sal_Bool bShowState ) override;
virtual sal_Bool SAL_CALL getShowState( ) override;
// XInitialization
virtual void SAL_CALL initialize( const css::uno::Sequence< css::uno::Any >& lArguments ) override;
// XCancellable
virtual void SAL_CALL cancel( ) override;
// XEventListener
/// @throws css::uno::RuntimeException
virtual void disposing( const css::lang::EventObject& aEvent );
// XServiceInfo
virtual OUString SAL_CALL getImplementationName( ) override;
virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames( ) override;
// XFolderPicker functions
virtual OUString SAL_CALL getDirectory( ) override;
virtual void SAL_CALL setDescription( const OUString& aDescription ) override;
private:
// prevent copy and assignment
VistaFilePicker( const VistaFilePicker& );
VistaFilePicker& operator=( const VistaFilePicker& );
using WeakComponentImplHelperBase::disposing;
void ensureInit();
private:
css::uno::Sequence< OUString > m_lLastFiles;
VistaFilePickerImpl m_rDialog;
bool m_bInitialized;
const bool m_bFolderPicker;
};
} // namespace vista
} // namespace win32
} // namespace fpicker
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */