diff options
| -rw-r--r-- | fpicker/source/win32/filepicker/VistaFilePickerImpl.hxx | 317 |
1 files changed, 317 insertions, 0 deletions
diff --git a/fpicker/source/win32/filepicker/VistaFilePickerImpl.hxx b/fpicker/source/win32/filepicker/VistaFilePickerImpl.hxx new file mode 100644 index 000000000000..801e13f9ebb3 --- /dev/null +++ b/fpicker/source/win32/filepicker/VistaFilePickerImpl.hxx @@ -0,0 +1,317 @@ +/************************************************************************* + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: VistaFilePickerImpl.hxx,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: rt $ $Date: 2008-03-12 07:33:13 $ + * + * The Contents of this file are made available subject to + * the terms of GNU Lesser General Public License Version 2.1. + * + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2005 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + ************************************************************************/ + +#ifndef FPICKER_WIN32_VISTA_FILEPICKERIMPL_HXX +#define FPICKER_WIN32_VISTA_FILEPICKERIMPL_HXX + +//----------------------------------------------------------------------------- +// includes +//----------------------------------------------------------------------------- + +#include "platform_vista.h" +#include "asyncrequests.hxx" +#include "comptr.hxx" +#include "vistatypes.h" +#include "FilterContainer.hxx" +#include "VistaFilePickerEventHandler.hxx" + +#include <com/sun/star/uno/Sequence.hxx> + +#include <comphelper/sequenceashashmap.hxx> +#include <cppuhelper/interfacecontainer.h> +#include <cppuhelper/basemutex.hxx> +#include <osl/thread.hxx> +#include <osl/conditn.hxx> +#include <rtl/ustring.hxx> + +#if defined _MSC_VER +#pragma warning(push, 1) +#endif +#include <shobjidl.h> +#if defined _MSC_VER +#pragma warning(pop) +#endif + +//----------------------------------------------------------------------------- +// namespace +//----------------------------------------------------------------------------- + +#ifdef css + #error "Clash on using CSS as namespace define." +#else + #define css ::com::sun::star +#endif + +namespace fpicker{ +namespace win32{ +namespace vista{ + +//----------------------------------------------------------------------------- +// types, const etcpp +//----------------------------------------------------------------------------- + +static const ::sal_Int32 FEATURE_AUTOEXTENSION = 1; +static const ::sal_Int32 FEATURE_PASSWORD = 2; +static const ::sal_Int32 FEATURE_FILTEROPTIONS = 4; +static const ::sal_Int32 FEATURE_SELECTION = 8; +static const ::sal_Int32 FEATURE_TEMPLATE = 16; +static const ::sal_Int32 FEATURE_LINK = 32; +static const ::sal_Int32 FEATURE_PREVIEW = 64; +static const ::sal_Int32 FEATURE_IMAGETEMPLATE = 128; +static const ::sal_Int32 FEATURE_PLAY = 256; +static const ::sal_Int32 FEATURE_READONLY = 512; +static const ::sal_Int32 FEATURE_VERSION = 1024; + +static const ::rtl::OUString PROP_PICKER_LISTENER = ::rtl::OUString::createFromAscii("picker_listener" ); // [XFilePickerListenert] +static const ::rtl::OUString PROP_DIALOG_SHOW_RESULT = ::rtl::OUString::createFromAscii("dialog_show_result" ); // [sal_Bool] true=OK, false=CANCEL +static const ::rtl::OUString PROP_SELECTED_FILES = ::rtl::OUString::createFromAscii("selected_files" ); // [seq< OUString >] contains all user selected files (can be empty!) +static const ::rtl::OUString PROP_MULTISELECTION_MODE = ::rtl::OUString::createFromAscii("multiselection_mode"); // [sal_Bool] true=ON, false=OFF +static const ::rtl::OUString PROP_TITLE = ::rtl::OUString::createFromAscii("title" ); // [OUString] +static const ::rtl::OUString PROP_DIRECTORY = ::rtl::OUString::createFromAscii("directory" ); // [OUString] +static const ::rtl::OUString PROP_FEATURES = ::rtl::OUString::createFromAscii("features" ); // [sal_Int32] +static const ::rtl::OUString PROP_FILTER_TITLE = ::rtl::OUString::createFromAscii("filter_title" ); // [OUString] +static const ::rtl::OUString PROP_FILTER_VALUE = ::rtl::OUString::createFromAscii("filter_value" ); // [OUString] + +static const ::rtl::OUString PROP_CONTROL_ID = ::rtl::OUString::createFromAscii("control_id" ); // [sal_Int16] +static const ::rtl::OUString PROP_CONTROL_ACTION = ::rtl::OUString::createFromAscii("control_action" ); // [sal_Int16] +static const ::rtl::OUString PROP_CONTROL_VALUE = ::rtl::OUString::createFromAscii("control_value" ); // [Any] +static const ::rtl::OUString PROP_CONTROL_LABEL = ::rtl::OUString::createFromAscii("control_label" ); // [OUString] +static const ::rtl::OUString PROP_CONTROL_ENABLE = ::rtl::OUString::createFromAscii("control_enable" ); // [sal_Bool] true=ON, false=OFF + +//----------------------------------------------------------------------------- +/** native implementation of the file picker on Vista and upcoming windows versions. + * This dialog uses COM internaly. Further it marshall every request so it will + * be executed within it's own STA thread ! + */ +//----------------------------------------------------------------------------- +class VistaFilePickerImpl : private ::cppu::BaseMutex + , public RequestHandler +{ + public: + + //--------------------------------------------------------------------- + /** 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_SET_MULTISELECTION_MODE, + E_SET_TITLE, + E_SET_DIRECTORY, + 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 + }; + + public: + + //--------------------------------------------------------------------- + // ctor/dtor - nothing special + //--------------------------------------------------------------------- + VistaFilePickerImpl(); + virtual ~VistaFilePickerImpl(); + + //--------------------------------------------------------------------- + // RequestHandler + //--------------------------------------------------------------------- + + virtual void before(); + virtual void doRequest(const RequestRef& rRequest); + virtual void after(); + + private: + + //--------------------------------------------------------------------- + /// implementation of request E_ADD_FILEPICKER_LISTENER + void impl_sta_addFilePickerListener(const RequestRef& rRequest); + + //--------------------------------------------------------------------- + /// implementation of request E_REMOVE_FILEPICKER_LISTENER + void impl_sta_removeFilePickerListener(const RequestRef& rRequest); + + //--------------------------------------------------------------------- + /// implementation of request E_APPEND_FILTER + void impl_sta_appendFilter(const RequestRef& rRequest); + + //--------------------------------------------------------------------- + /// implementation of request E_SET_CURRENT_FILTER + void impl_sta_setCurrentFilter(const RequestRef& rRequest); + + //--------------------------------------------------------------------- + /// implementation of request E_GET_CURRENT_FILTER + void impl_sta_getCurrentFilter(const RequestRef& rRequest); + + //--------------------------------------------------------------------- + /// implementation of request E_CREATE_OPEN_DIALOG + void impl_sta_CreateOpenDialog(const RequestRef& rRequest); + + //--------------------------------------------------------------------- + /// implementation of request E_CREATE_SAVE_DIALOG + void impl_sta_CreateSaveDialog(const RequestRef& rRequest); + + //--------------------------------------------------------------------- + /// implementation of request E_SET_MULTISELECTION_MODE + void impl_sta_SetMultiSelectionMode(const RequestRef& rRequest); + + //--------------------------------------------------------------------- + /// implementation of request E_SET_TITLE + void impl_sta_SetTitle(const RequestRef& rRequest); + + //--------------------------------------------------------------------- + /// implementation of request E_SET_DIRECTORY + void impl_sta_SetDirectory(const RequestRef& rRequest); + + //--------------------------------------------------------------------- + /// implementation of request E_GET_SELECTED_FILES + void impl_sta_getSelectedFiles(const RequestRef& rRequest); + + //--------------------------------------------------------------------- + /// implementation of request E_SHOW_DIALOG_MODAL + void impl_sta_ShowDialogModal(const RequestRef& rRequest); + + //--------------------------------------------------------------------- + /// implementation of request E_SET_CONTROL_VALUE + void impl_sta_SetControlValue(const RequestRef& rRequest); + + //--------------------------------------------------------------------- + /// implementation of request E_GET_CONTROL_VALUE + void impl_sta_GetControlValue(const RequestRef& rRequest); + + //--------------------------------------------------------------------- + /// implementation of request E_SET_CONTROL_LABEL + void impl_sta_SetControlLabel(const RequestRef& rRequest); + + //--------------------------------------------------------------------- + /// implementation of request E_GET_CONTROL_LABEL + void impl_sta_GetControlLabel(const RequestRef& rRequest); + + //--------------------------------------------------------------------- + /// implementation of request E_ENABLE_CONTROL + void impl_sta_EnableControl(const RequestRef& rRequest); + + //--------------------------------------------------------------------- + /** create all needed (optional!) UI controls adressed by the field nFeatures. + * The given number nFeatures is used as a flag field. Use const values FEATURE_XXX + * to adress it. + * + * Internal new controls will be added to the dialog. Every control can be accessed + * by it's 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 wich must be enabled. + */ + void impl_sta_enableFeatures(::sal_Int32 nFeatures); + + //--------------------------------------------------------------------- + /** returns an interface, which can be used to customize the internaly used + * COM dialog. + * + * Because we use two member (open/save dialog) internaly, this method + * ask the current active one for it's 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(); + + private: + + //--------------------------------------------------------------------- + /// COM object representing a file open dialog + TFileOpenDialog m_iDialogOpen; + + //--------------------------------------------------------------------- + /// COM object representing a file save dialog + TFileSaveDialog m_iDialogSave; + + //--------------------------------------------------------------------- + /// knows the return state of the last COM call + HRESULT m_hLastResult; + + //--------------------------------------------------------------------- + /// @todo document me + CFilterContainer m_lFilters; + + //--------------------------------------------------------------------- + /** cache last selected list of files + * Because those list must be retrieved directly after closing the dialog + * (and only in case it was finished successfully) we cache it internaly. + * Because the outside provided UNO API decouple showing the dialog + * and asking for results .-) + */ + css::uno::Sequence< ::rtl::OUString > m_lLastFiles; + + //--------------------------------------------------------------------- + /** help us to handle dialog events and provide them to interested office + * listener. + */ + TFileDialogEvents m_iEventHandler; + + //--------------------------------------------------------------------- + /// @todo document me + ::sal_Bool m_bInExecute; +}; + +} // namespace vista +} // namespace win32 +} // namespace fpicker + +#undef css + +#endif // FPICKER_WIN32_VISTA_FILEPICKERIMPL_HXX |