LibreOffice Module fpicker (master) 1
OfficeFilePicker.hxx
Go to the documentation of this file.
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#pragma once
20
22#include <com/sun/star/ui/dialogs/XFilePickerControlAccess.hpp>
23#include <com/sun/star/ui/dialogs/XFilePreview.hpp>
24#include <com/sun/star/ui/dialogs/XFilePicker3.hpp>
25#include <com/sun/star/ui/dialogs/XFilePickerListener.hpp>
26#include <com/sun/star/ui/dialogs/XAsynchronousExecutableDialog.hpp>
27#include <com/sun/star/lang/XServiceInfo.hpp>
28#include <com/sun/star/lang/XEventListener.hpp>
29
30
31#include "commonpicker.hxx"
32#include "pickercallbacks.hxx"
33
34#include <vector>
35
36class Dialog;
37struct FilterEntry;
39enum class PickerFlags;
40
41typedef ::std::vector< FilterEntry > FilterList; // can be maintained more effectively
42typedef ::std::vector< ElementEntry_Impl > ElementList;
43
44typedef css::beans::StringPair UnoFilterEntry;
45typedef css::uno::Sequence< UnoFilterEntry > UnoFilterList; // can be transported more effectively
46
47// class SvtFilePicker ---------------------------------------------------
48
49typedef ::cppu::ImplHelper5 < css::ui::dialogs::XFilePicker3
50 , css::ui::dialogs::XFilePickerControlAccess
51 , css::ui::dialogs::XFilePreview
52 , css::lang::XServiceInfo
53 , css::ui::dialogs::XAsynchronousExecutableDialog
55
59{
60protected:
61 std::unique_ptr<FilterList>
63 std::unique_ptr<ElementList>
65
67 sal_Int16 m_nServiceType;
70
73
75 css::uno::Sequence< OUString >
77
78 css::uno::Reference< css::ui::dialogs::XFilePickerListener >
80 css::uno::Reference< css::ui::dialogs::XDialogClosedListener >
82
83public:
85 virtual ~SvtFilePicker() override;
86
87
88 // disambiguate XInterface
89
91
92
93 // disambiguate XTypeProvider
94
95 DECLARE_XTYPEPROVIDER( )
96
97
98 // XExecutableDialog functions
99
100 virtual void SAL_CALL setTitle( const OUString& _rTitle ) override;
101 virtual sal_Int16 SAL_CALL execute( ) override;
102
103
104 // XAsynchronousExecutableDialog functions
105
106 virtual void SAL_CALL setDialogTitle( const OUString& _rTitle ) override;
107 virtual void SAL_CALL startExecuteModal( const css::uno::Reference< css::ui::dialogs::XDialogClosedListener >& xListener ) override;
108
109
110 // XFilePicker functions
111
112
113 virtual void SAL_CALL setMultiSelectionMode( sal_Bool bMode ) override;
114 virtual void SAL_CALL setDefaultName( const OUString& aName ) override;
115 virtual void SAL_CALL setDisplayDirectory( const OUString& aDirectory ) override;
116 virtual OUString SAL_CALL getDisplayDirectory() override;
117 virtual css::uno::Sequence< OUString > SAL_CALL getFiles() override;
118 virtual css::uno::Sequence< OUString > SAL_CALL getSelectedFiles() override;
119
120
121 // XFilePickerControlAccess functions
122
123
124 virtual void SAL_CALL setValue( sal_Int16 ElementID, sal_Int16 ControlAction, const css::uno::Any& value ) override;
125 virtual css::uno::Any SAL_CALL getValue( sal_Int16 ElementID, sal_Int16 ControlAction ) override;
126 virtual void SAL_CALL setLabel( sal_Int16 ElementID, const OUString& aValue ) override;
127 virtual OUString SAL_CALL getLabel( sal_Int16 ElementID ) override;
128 virtual void SAL_CALL enableControl( sal_Int16 ElementID, sal_Bool bEnable ) override;
129
130
131 // XFilePickerNotifier functions
132
133
134 virtual void SAL_CALL addFilePickerListener( const css::uno::Reference< css::ui::dialogs::XFilePickerListener >& xListener ) override;
135 virtual void SAL_CALL removeFilePickerListener( const css::uno::Reference< css::ui::dialogs::XFilePickerListener >& xListener ) override;
136
137
138 // XFilePreview functions
139
140
141 virtual css::uno::Sequence< sal_Int16 > SAL_CALL getSupportedImageFormats() override;
142 virtual sal_Int32 SAL_CALL getTargetColorDepth() override;
143 virtual sal_Int32 SAL_CALL getAvailableWidth() override;
144 virtual sal_Int32 SAL_CALL getAvailableHeight() override;
145 virtual void SAL_CALL setImage( sal_Int16 aImageFormat, const css::uno::Any& aImage ) override;
146 virtual sal_Bool SAL_CALL setShowState( sal_Bool bShowState ) override;
147 virtual sal_Bool SAL_CALL getShowState() override;
148
149
150 // XFilterManager functions
151
152
153 virtual void SAL_CALL appendFilter( const OUString& aTitle, const OUString& aFilter ) override;
154 virtual void SAL_CALL setCurrentFilter( const OUString& aTitle ) override;
155 virtual OUString SAL_CALL getCurrentFilter() override;
156
157
158 // XFilterGroupManager functions
159
160 virtual void SAL_CALL appendFilterGroup( const OUString& sGroupTitle, const css::uno::Sequence< css::beans::StringPair >& aFilters ) override;
161
162
163 // these methods are here because they're ambiguous
164
165 virtual void SAL_CALL cancel() override
167 virtual void SAL_CALL dispose() override
168 { ::svt::OCommonPicker::dispose(); }
169 virtual void SAL_CALL addEventListener(const css::uno::Reference<css::lang::XEventListener>& l) override
170 { ::svt::OCommonPicker::addEventListener(l); }
171 virtual void SAL_CALL removeEventListener(const css::uno::Reference<css::lang::XEventListener>& l) override
172 { ::svt::OCommonPicker::removeEventListener(l); }
173
174
175 // XInitialization functions
176
177
178 virtual void SAL_CALL initialize( const css::uno::Sequence< css::uno::Any >& aArguments ) override;
179
180
181 // XServiceInfo functions
182
183
184 /* XServiceInfo */
185 virtual OUString SAL_CALL getImplementationName() override;
186 virtual sal_Bool SAL_CALL supportsService( const OUString& sServiceName ) override;
187 virtual css::uno::Sequence< OUString > SAL_CALL
188 getSupportedServiceNames() override;
189
190protected:
191
192 // OCommonPicker overridables
193
194 virtual std::shared_ptr<SvtFileDialog_Base> implCreateDialog( weld::Window* pParent ) override;
195 virtual sal_Int16 implExecutePicker( ) override;
197 const OUString& _rName,
198 const css::uno::Any& _rValue
199 ) override;
200
201protected:
203 virtual void notify( sal_Int16 _nEventId, sal_Int16 _nControlId ) override;
204
205 bool FilterNameExists( const OUString& rTitle );
206 bool FilterNameExists( const UnoFilterList& _rGroupedFilters );
207
208 void ensureFilterList( const OUString& _rInitialCurrentFilter );
209
210 void prepareExecute( );
211
212 void DialogClosedHdl(sal_Int32 nResult);
213};
214
215// SvtRemoteFilePicker
216
218{
219public:
221
222 virtual std::shared_ptr<SvtFileDialog_Base> implCreateDialog( weld::Window* pParent ) override;
223
224 // disambiguate XInterface
225
227
228 // disambiguate XTypeProvider
229
231
232 /* XServiceInfo */
233 virtual OUString SAL_CALL getImplementationName() override;
234 virtual sal_Bool SAL_CALL supportsService( const OUString& sServiceName ) override;
235 virtual css::uno::Sequence< OUString > SAL_CALL
236 getSupportedServiceNames() override;
237};
238
239/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
css::uno::Sequence< UnoFilterEntry > UnoFilterList
::std::vector< FilterEntry > FilterList
css::uno::Sequence< UnoFilterEntry > UnoFilterList
::cppu::ImplHelper5< css::ui::dialogs::XFilePicker3, css::ui::dialogs::XFilePickerControlAccess, css::ui::dialogs::XFilePreview, css::lang::XServiceInfo, css::ui::dialogs::XAsynchronousExecutableDialog > SvtFilePicker_Base
::std::vector< ElementEntry_Impl > ElementList
css::beans::StringPair UnoFilterEntry
constexpr OUStringLiteral sServiceName
OUString m_aStandardDir
virtual sal_Bool SAL_CALL getShowState() override
virtual void SAL_CALL dispose() override
OUString m_aCurrentFilter
virtual css::uno::Any SAL_CALL getValue(sal_Int16 ElementID, sal_Int16 ControlAction) override
virtual void SAL_CALL addEventListener(const css::uno::Reference< css::lang::XEventListener > &l) override
virtual OUString SAL_CALL getImplementationName() override
virtual void SAL_CALL appendFilter(const OUString &aTitle, const OUString &aFilter) override
virtual void SAL_CALL startExecuteModal(const css::uno::Reference< css::ui::dialogs::XDialogClosedListener > &xListener) override
virtual sal_Int32 SAL_CALL getTargetColorDepth() override
virtual sal_Bool SAL_CALL setShowState(sal_Bool bShowState) override
virtual void notify(sal_Int16 _nEventId, sal_Int16 _nControlId) override
virtual void SAL_CALL setCurrentFilter(const OUString &aTitle) override
virtual OUString SAL_CALL getDisplayDirectory() override
virtual void SAL_CALL enableControl(sal_Int16 ElementID, sal_Bool bEnable) override
virtual void SAL_CALL removeFilePickerListener(const css::uno::Reference< css::ui::dialogs::XFilePickerListener > &xListener) override
virtual void SAL_CALL initialize(const css::uno::Sequence< css::uno::Any > &aArguments) override
virtual OUString SAL_CALL getLabel(sal_Int16 ElementID) override
virtual sal_Int16 implExecutePicker() override
virtual sal_Int16 SAL_CALL execute() override
virtual std::shared_ptr< SvtFileDialog_Base > implCreateDialog(weld::Window *pParent) override
virtual void SAL_CALL setDialogTitle(const OUString &_rTitle) override
virtual sal_Int32 SAL_CALL getAvailableWidth() override
void ensureFilterList(const OUString &_rInitialCurrentFilter)
virtual void SAL_CALL setTitle(const OUString &_rTitle) override
virtual void SAL_CALL setDefaultName(const OUString &aName) override
virtual void SAL_CALL cancel() override
bool FilterNameExists(const OUString &rTitle)
virtual OUString SAL_CALL getCurrentFilter() override
virtual void SAL_CALL setMultiSelectionMode(sal_Bool bMode) override
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override
virtual css::uno::Sequence< OUString > SAL_CALL getSelectedFiles() override
std::unique_ptr< ElementList > m_pElemList
virtual sal_Int32 SAL_CALL getAvailableHeight() override
OUString m_aOldHideDirectory
virtual bool implHandleInitializationArgument(const OUString &_rName, const css::uno::Any &_rValue) override
handle a single argument from the XInitialization::initialize method
void DialogClosedHdl(sal_Int32 nResult)
virtual ~SvtFilePicker() override
css::uno::Reference< css::ui::dialogs::XFilePickerListener > m_xListener
virtual void SAL_CALL setImage(sal_Int16 aImageFormat, const css::uno::Any &aImage) override
virtual void SAL_CALL removeEventListener(const css::uno::Reference< css::lang::XEventListener > &l) override
css::uno::Reference< css::ui::dialogs::XDialogClosedListener > m_xDlgClosedListener
OUString m_aDefaultName
std::unique_ptr< FilterList > m_pFilterList
css::uno::Sequence< OUString > m_aDenyList
OUString m_aOldDisplayDirectory
PickerFlags getPickerFlags() const
virtual css::uno::Sequence< OUString > SAL_CALL getFiles() override
virtual void SAL_CALL setLabel(sal_Int16 ElementID, const OUString &aValue) override
virtual css::uno::Sequence< sal_Int16 > SAL_CALL getSupportedImageFormats() override
virtual void SAL_CALL setValue(sal_Int16 ElementID, sal_Int16 ControlAction, const css::uno::Any &value) override
virtual void SAL_CALL addFilePickerListener(const css::uno::Reference< css::ui::dialogs::XFilePickerListener > &xListener) override
sal_Int16 m_nServiceType
virtual sal_Bool SAL_CALL supportsService(const OUString &sServiceName) override
virtual void SAL_CALL setDisplayDirectory(const OUString &aDirectory) override
virtual void SAL_CALL appendFilterGroup(const OUString &sGroupTitle, const css::uno::Sequence< css::beans::StringPair > &aFilters) override
virtual OUString SAL_CALL getImplementationName() override
virtual sal_Bool SAL_CALL supportsService(const OUString &sServiceName) override
virtual std::shared_ptr< SvtFileDialog_Base > implCreateDialog(weld::Window *pParent) override
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override
implements common functionality for the 2 UNO picker components
virtual void SAL_CALL cancel() override
PickerFlags
unsigned char sal_Bool
#define DECLARE_XTYPEPROVIDER()
#define DECLARE_XINTERFACE()