1
0
Fork 0
libreoffice/fpicker/source/win32/VistaFilePickerImpl.hxx
Daniel Baumann 8e63e14cf6
Adding upstream version 4:25.2.3.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
2025-06-22 16:20:04 +02:00

311 lines
10 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 "platform_vista.h"
#include <shobjidl.h>
#include "requests.hxx"
#include "vistatypes.h"
#include "FilterContainer.hxx"
#include "VistaFilePickerEventHandler.hxx"
#include "IVistaFilePickerInternalNotify.hxx"
#include "resourceprovider.hxx"
#include <cppuhelper/interfacecontainer.h>
#include <osl/thread.hxx>
#include <osl/conditn.hxx>
#include <rtl/ustring.hxx>
namespace fpicker{
namespace win32{
namespace vista{
// types, const etcpp
const ::sal_Int32 FEATURE_AUTOEXTENSION = 1;
const ::sal_Int32 FEATURE_PASSWORD = 2;
const ::sal_Int32 FEATURE_FILTEROPTIONS = 4;
const ::sal_Int32 FEATURE_SELECTION = 8;
const ::sal_Int32 FEATURE_TEMPLATE = 16;
const ::sal_Int32 FEATURE_LINK = 32;
const ::sal_Int32 FEATURE_PREVIEW = 64;
const ::sal_Int32 FEATURE_IMAGETEMPLATE = 128;
const ::sal_Int32 FEATURE_PLAY = 256;
const ::sal_Int32 FEATURE_READONLY = 512;
const ::sal_Int32 FEATURE_VERSION = 1024;
const ::sal_Int32 FEATURE_GPGPASSWORD = 2048;
const ::sal_Int32 FEATURE_IMAGEANCHOR = 4096;
const ::sal_Int32 FEATURE_GPGSIGN = 8192;
inline constexpr OUString PROP_PICKER_LISTENER(u"picker_listener"_ustr ); // [XFilePickerListenert]
inline constexpr OUString PROP_DIALOG_SHOW_RESULT(u"dialog_show_result"_ustr ); // [sal_Bool] true=OK, false=CANCEL
inline constexpr OUString PROP_SELECTED_FILES(u"selected_files"_ustr ); // [seq< OUString >] contains all user selected files (can be empty!)
inline constexpr OUString PROP_MULTISELECTION_MODE(u"multiselection_mode"_ustr); // [sal_Bool] true=ON, false=OFF
inline constexpr OUString PROP_TITLE(u"title"_ustr ); // [OUString]
inline constexpr OUString PROP_FILENAME(u"filename"_ustr ); // [OUString]
inline constexpr OUString PROP_DIRECTORY(u"directory"_ustr ); // [OUString]
inline constexpr OUString PROP_FEATURES(u"features"_ustr ); // [sal_Int32]
inline constexpr OUString PROP_TEMPLATE_DESCR(u"templatedescription"_ustr); // [sal_Int32]
inline constexpr OUString PROP_FILTER_TITLE(u"filter_title"_ustr ); // [OUString]
inline constexpr OUString PROP_FILTER_VALUE(u"filter_value"_ustr ); // [OUString]
inline constexpr OUString PROP_FILTER_GROUP(u"filter-group"_ustr ); // [seq< css:beans::StringPair >] contains a group of filters
inline constexpr OUString PROP_CONTROL_ID(u"control_id"_ustr ); // [sal_Int16]
inline constexpr OUString PROP_CONTROL_ACTION(u"control_action"_ustr ); // [sal_Int16]
inline constexpr OUString PROP_CONTROL_VALUE(u"control_value"_ustr ); // [Any]
inline constexpr OUString PROP_CONTROL_LABEL(u"control_label"_ustr ); // [OUString]
inline constexpr OUString PROP_CONTROL_ENABLE(u"control_enable"_ustr ); // [sal_Bool] true=ON, false=OFF
inline constexpr OUString PROP_PARENT_WINDOW(u"ParentWindow"_ustr); //[css::awt::XWindow] preferred parent window
inline constexpr OUString STRING_SEPARATOR(u"------------------------------------------"_ustr );
class TDialogImplBase;
/** native implementation of the file picker on Vista and upcoming windows versions.
* This dialog uses COM internally. Further it marshall every request so it will
* be executed on the main thread which is an STA thread !
*/
class VistaFilePickerImpl : public IVistaFilePickerInternalNotify
{
public:
// Workaround made to get input in Template Listbox
css::uno::Sequence< OUString > m_lItems;
/** used for marshalling requests.
* Will be used to map requests to the right implementations.
*/
enum ERequest
{
E_NO_REQUEST,
E_ADD_PICKER_LISTENER,
E_REMOVE_PICKER_LISTENER,
E_APPEND_FILTER,
E_SET_CURRENT_FILTER,
E_GET_CURRENT_FILTER,
E_CREATE_OPEN_DIALOG,
E_CREATE_SAVE_DIALOG,
E_CREATE_FOLDER_PICKER,
E_SET_MULTISELECTION_MODE,
E_SET_TITLE,
E_SET_FILENAME,
E_GET_DIRECTORY,
E_SET_DIRECTORY,
E_SET_DEFAULT_NAME,
E_GET_SELECTED_FILES,
E_SHOW_DIALOG_MODAL,
E_SET_CONTROL_VALUE,
E_GET_CONTROL_VALUE,
E_SET_CONTROL_LABEL,
E_GET_CONTROL_LABEL,
E_ENABLE_CONTROL,
E_APPEND_FILTERGROUP
};
public:
// ctor/dtor - nothing special
VistaFilePickerImpl();
virtual ~VistaFilePickerImpl();
// RequestHandler
void doRequest(Request& rRequest);
// IVistaFilePickerInternalNotify
virtual void onAutoExtensionChanged (bool bChecked) override;
virtual bool onFileTypeChanged( UINT nTypeIndex ) override;
virtual void onDirectoryChanged() override;
private:
OUString GetDirectory();
/// implementation of request E_ADD_FILEPICKER_LISTENER
void impl_sta_addFilePickerListener(Request& rRequest);
/// implementation of request E_REMOVE_FILEPICKER_LISTENER
void impl_sta_removeFilePickerListener(Request& rRequest);
/// implementation of request E_APPEND_FILTER
void impl_sta_appendFilter(Request& rRequest);
/// implementation of request E_APPEND_FILTERGROUP
void impl_sta_appendFilterGroup(Request& rRequest);
/// implementation of request E_SET_CURRENT_FILTER
void impl_sta_setCurrentFilter(Request& rRequest);
/// implementation of request E_GET_CURRENT_FILTER
void impl_sta_getCurrentFilter(Request& rRequest);
/// implementation of request E_CREATE_OPEN_DIALOG
void impl_sta_CreateOpenDialog(Request& rRequest);
/// implementation of request E_CREATE_SAVE_DIALOG
void impl_sta_CreateSaveDialog(Request& rRequest);
/// implementation of request E_CREATE_FOLDER_PICKER
void impl_sta_CreateFolderPicker(Request& rRequest);
/// implementation of request E_SET_MULTISELECTION_MODE
void impl_sta_SetMultiSelectionMode(Request& rRequest);
/// implementation of request E_SET_TITLE
void impl_sta_SetTitle(Request& rRequest);
/// implementation of request E_SET_FILENAME
void impl_sta_SetFileName(Request& rRequest);
/// implementation of request E_SET_DIRECTORY
void impl_sta_SetDirectory(Request& rRequest);
/// implementation of request E_GET_DIRECTORY
void impl_sta_GetDirectory(Request& rRequest);
/// implementation of request E_SET_DEFAULT_NAME
void impl_sta_SetDefaultName(Request& rRequest);
/// implementation of request E_GET_SELECTED_FILES
void impl_sta_getSelectedFiles(Request& rRequest);
/// implementation of request E_SHOW_DIALOG_MODAL
void impl_sta_ShowDialogModal(Request& rRequest);
/// implementation of request E_SET_CONTROL_VALUE
void impl_sta_SetControlValue(Request& rRequest);
/// implementation of request E_GET_CONTROL_VALUE
void impl_sta_GetControlValue(Request& rRequest);
/// implementation of request E_SET_CONTROL_LABEL
void impl_sta_SetControlLabel(Request& rRequest);
/// implementation of request E_GET_CONTROL_LABEL
static void impl_sta_GetControlLabel(Request& rRequest);
/// implementation of request E_ENABLE_CONTROL
void impl_sta_EnableControl(Request& rRequest);
/** create all needed (optional!) UI controls addressed by the field nFeatures.
* The given number nFeatures is used as a flag field. Use const values FEATURE_XXX
* to address it.
*
* Internal new controls will be added to the dialog. Every control can be accessed
* by its own control id. Those control ID must be one of the const set
* css::ui::dialogs::ExtendedFilePickerElementIds.
*
* @see setControlValue()
* @see getControlValue()
* @see setControlLabel()
* @see getControlLabel()
* @see enableControl()
*
* @param nFeatures
* flag field(!) knows all features which must be enabled.
*/
void impl_sta_enableFeatures(::sal_Int32 nFeatures, ::sal_Int32 nTemplate);
/** returns an interface, which can be used to customize the internally used
* COM dialog.
*
* Because we use two member (open/save dialog) internally, this method
* ask the current active one for its customization interface.
*
* @return the customization interface for the current used dialog.
* Must not be null.
*/
TFileDialogCustomize impl_getCustomizeInterface();
TFileDialog impl_getBaseDialogInterface();
/// fill filter list of internal used dialog.
void impl_sta_setFiltersOnDialog();
void impl_SetDefaultExtension( const OUString& currentFilter );
private:
template <class TDialogImplClass> void impl_sta_CreateDialog();
void impl_sta_InitDialog(Request& rRequest, DWORD nOrFlags);
/// object representing a file dialog
std::shared_ptr<TDialogImplBase> m_pDialog;
/// @todo document me
CFilterContainer m_lFilters;
/** help us to handle dialog events and provide them to interested office
* listener.
*/
TFileDialogEvents m_iEventHandler;
/// @todo document me
bool m_bInExecute;
bool m_bWasExecuted;
// handle to parent window
HWND m_hParentWindow;
OUString m_sDirectory;
OUString m_sFilename;
};
} // namespace vista
} // namespace win32
} // namespace fpicker
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */