Debian Codegraph @

vcl/unx/gtk3_kde5/gtk3_kde5_filepicker.cxx

raw
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 #include <QUrl>
21 #include <KFileWidget>
22
23 #include "gtk3_kde5_filepicker.hxx"
24
25 #include <com/sun/star/lang/IllegalArgumentException.hpp>
26 #include <cppuhelper/supportsservice.hxx>
27 #include <com/sun/star/ui/dialogs/TemplateDescription.hpp>
28 #include <com/sun/star/ui/dialogs/CommonFilePickerElementIds.hpp>
29 #include <com/sun/star/ui/dialogs/ExtendedFilePickerElementIds.hpp>
30
31 #include <sal/log.hxx>
32 #include <vcl/svapp.hxx>
33 #include "FPServiceInfo.hxx"
34
35 #undef Region
36
37 #include <fpicker/strings.hrc>
38
39 using namespace ::com::sun::star;
40 using namespace ::com::sun::star::ui::dialogs;
41 using namespace ::com::sun::star::ui::dialogs::TemplateDescription;
42 using namespace ::com::sun::star::ui::dialogs::ExtendedFilePickerElementIds;
43 using namespace ::com::sun::star::ui::dialogs::CommonFilePickerElementIds;
44 using namespace ::com::sun::star::lang;
45 using namespace ::com::sun::star::beans;
46 using namespace ::com::sun::star::uno;
47
48 Gtk3KDE5FilePicker::Gtk3KDE5FilePicker(const uno::Reference<uno::XComponentContext>&)
49 : Gtk3KDE5FilePicker_Base(_helperMutex)
50 {
51 setMultiSelectionMode(false);
52
53 // tdf#124598 dummy KWidget use to make gtk3_kde5 VCL plugin link against KIO libraries
54 QString sDummyStr;
55 QUrl aUrl = KFileWidget::getStartUrl(QUrl(), sDummyStr);
56 aUrl.setPath("/dev/null");
57 }
58
59 Gtk3KDE5FilePicker::~Gtk3KDE5FilePicker() = default;
60
61 void SAL_CALL
62 Gtk3KDE5FilePicker::addFilePickerListener(const uno::Reference<XFilePickerListener>& xListener)
63 {
64 SolarMutexGuard aGuard;
65 m_xListener = xListener;
66 }
67
68 void SAL_CALL
69 Gtk3KDE5FilePicker::removeFilePickerListener(const uno::Reference<XFilePickerListener>&)
70 {
71 SolarMutexGuard aGuard;
72 m_xListener.clear();
73 }
74
75 void SAL_CALL Gtk3KDE5FilePicker::setTitle(const OUString& title)
76 {
77 m_ipc.sendCommand(Commands::SetTitle, title);
78 }
79
80 sal_Int16 SAL_CALL Gtk3KDE5FilePicker::execute()
81 {
82 SolarMutexGuard g;
83 return m_ipc.execute();
84 }
85
86 void SAL_CALL Gtk3KDE5FilePicker::setMultiSelectionMode(sal_Bool multiSelect)
87 {
88 m_ipc.sendCommand(Commands::SetMultiSelectionMode, bool(multiSelect));
89 }
90
91 void SAL_CALL Gtk3KDE5FilePicker::setDefaultName(const OUString& name)
92 {
93 m_ipc.sendCommand(Commands::SetDefaultName, name);
94 }
95
96 void SAL_CALL Gtk3KDE5FilePicker::setDisplayDirectory(const OUString& dir)
97 {
98 m_ipc.sendCommand(Commands::SetDisplayDirectory, dir);
99 }
100
101 OUString SAL_CALL Gtk3KDE5FilePicker::getDisplayDirectory()
102 {
103 auto id = m_ipc.sendCommand(Commands::GetDisplayDirectory);
104 OUString dir;
105 m_ipc.readResponse(id, dir);
106 return dir;
107 }
108
109 uno::Sequence<OUString> SAL_CALL Gtk3KDE5FilePicker::getFiles()
110 {
111 uno::Sequence<OUString> seq = getSelectedFiles();
112 if (seq.getLength() > 1)
113 seq.realloc(1);
114 return seq;
115 }
116
117 uno::Sequence<OUString> SAL_CALL Gtk3KDE5FilePicker::getSelectedFiles()
118 {
119 auto id = m_ipc.sendCommand(Commands::GetSelectedFiles);
120 uno::Sequence<OUString> seq;
121 m_ipc.readResponse(id, seq);
122 return seq;
123 }
124
125 void SAL_CALL Gtk3KDE5FilePicker::appendFilter(const OUString& title, const OUString& filter)
126 {
127 m_ipc.sendCommand(Commands::AppendFilter, title, filter);
128 }
129
130 void SAL_CALL Gtk3KDE5FilePicker::setCurrentFilter(const OUString& title)
131 {
132 m_ipc.sendCommand(Commands::SetCurrentFilter, title);
133 }
134
135 OUString SAL_CALL Gtk3KDE5FilePicker::getCurrentFilter()
136 {
137 auto id = m_ipc.sendCommand(Commands::GetCurrentFilter);
138 OUString filter;
139 m_ipc.readResponse(id, filter);
140 return filter;
141 }
142
143 void SAL_CALL Gtk3KDE5FilePicker::appendFilterGroup(const OUString& /*rGroupTitle*/,
144 const uno::Sequence<beans::StringPair>& filters)
145 {
146 const sal_uInt16 length = filters.getLength();
147 for (sal_uInt16 i = 0; i < length; ++i)
148 {
149 beans::StringPair aPair = filters[i];
150 appendFilter(aPair.First, aPair.Second);
151 }
152 }
153
154 void SAL_CALL Gtk3KDE5FilePicker::setValue(sal_Int16 controlId, sal_Int16 nControlAction,
155 const uno::Any& value)
156 {
157 if (value.has<bool>())
158 {
159 m_ipc.sendCommand(Commands::SetValue, controlId, nControlAction, value.get<bool>());
160 }
161 else
162 {
163 SAL_INFO("vcl.gtkkde5", "set value of unhandled type " << controlId);
164 }
165 }
166
167 uno::Any SAL_CALL Gtk3KDE5FilePicker::getValue(sal_Int16 controlId, sal_Int16 nControlAction)
168 {
169 if (CHECKBOX_AUTOEXTENSION == controlId)
170 // We ignore this one and rely on QFileDialog to provide the function.
171 // Always return false, to pretend we do not support this, otherwise
172 // LO core would try to be smart and cut the extension in some places,
173 // interfering with QFileDialog's handling of it. QFileDialog also
174 // saves the value of the setting, so LO core is not needed for that either.
175 return uno::Any(false);
176
177 auto id = m_ipc.sendCommand(Commands::GetValue, controlId, nControlAction);
178
179 bool value = false;
180 m_ipc.readResponse(id, value);
181
182 return uno::Any(value);
183 }
184
185 void SAL_CALL Gtk3KDE5FilePicker::enableControl(sal_Int16 controlId, sal_Bool enable)
186 {
187 m_ipc.sendCommand(Commands::EnableControl, controlId, bool(enable));
188 }
189
190 void SAL_CALL Gtk3KDE5FilePicker::setLabel(sal_Int16 controlId, const OUString& label)
191 {
192 m_ipc.sendCommand(Commands::SetLabel, controlId, label);
193 }
194
195 OUString SAL_CALL Gtk3KDE5FilePicker::getLabel(sal_Int16 controlId)
196 {
197 auto id = m_ipc.sendCommand(Commands::GetLabel, controlId);
198 OUString label;
199 m_ipc.readResponse(id, label);
200 return label;
201 }
202
203 void Gtk3KDE5FilePicker::addCustomControl(sal_Int16 controlId)
204 {
205 TranslateId resId;
206
207 switch (controlId)
208 {
209 case CHECKBOX_AUTOEXTENSION:
210 resId = STR_SVT_FILEPICKER_AUTO_EXTENSION;
211 break;
212 case CHECKBOX_PASSWORD:
213 resId = STR_SVT_FILEPICKER_PASSWORD;
214 break;
215 case CHECKBOX_FILTEROPTIONS:
216 resId = STR_SVT_FILEPICKER_FILTER_OPTIONS;
217 break;
218 case CHECKBOX_READONLY:
219 resId = STR_SVT_FILEPICKER_READONLY;
220 break;
221 case CHECKBOX_LINK:
222 resId = STR_SVT_FILEPICKER_INSERT_AS_LINK;
223 break;
224 case CHECKBOX_PREVIEW:
225 resId = STR_SVT_FILEPICKER_SHOW_PREVIEW;
226 break;
227 case CHECKBOX_SELECTION:
228 resId = STR_SVT_FILEPICKER_SELECTION;
229 break;
230 case CHECKBOX_GPGENCRYPTION:
231 resId = STR_SVT_FILEPICKER_GPGENCRYPT;
232 break;
233 case PUSHBUTTON_PLAY:
234 resId = STR_SVT_FILEPICKER_PLAY;
235 break;
236 case LISTBOX_VERSION:
237 resId = STR_SVT_FILEPICKER_VERSION;
238 break;
239 case LISTBOX_TEMPLATE:
240 resId = STR_SVT_FILEPICKER_TEMPLATES;
241 break;
242 case LISTBOX_IMAGE_TEMPLATE:
243 resId = STR_SVT_FILEPICKER_IMAGE_TEMPLATE;
244 break;
245 case LISTBOX_IMAGE_ANCHOR:
246 resId = STR_SVT_FILEPICKER_IMAGE_ANCHOR;
247 break;
248 case LISTBOX_VERSION_LABEL:
249 case LISTBOX_TEMPLATE_LABEL:
250 case LISTBOX_IMAGE_TEMPLATE_LABEL:
251 case LISTBOX_IMAGE_ANCHOR_LABEL:
252 case LISTBOX_FILTER_SELECTOR:
253 break;
254 }
255
256 switch (controlId)
257 {
258 case CHECKBOX_AUTOEXTENSION:
259 case CHECKBOX_PASSWORD:
260 case CHECKBOX_FILTEROPTIONS:
261 case CHECKBOX_READONLY:
262 case CHECKBOX_LINK:
263 case CHECKBOX_PREVIEW:
264 case CHECKBOX_SELECTION:
265 case CHECKBOX_GPGENCRYPTION:
266 {
267 // the checkbox is created even for CHECKBOX_AUTOEXTENSION to simplify
268 // code, but the checkbox is hidden and ignored
269 bool hidden = controlId == CHECKBOX_AUTOEXTENSION;
270
271 m_ipc.sendCommand(Commands::AddCheckBox, controlId, hidden, getResString(resId));
272
273 break;
274 }
275 case PUSHBUTTON_PLAY:
276 case LISTBOX_VERSION:
277 case LISTBOX_TEMPLATE:
278 case LISTBOX_IMAGE_TEMPLATE:
279 case LISTBOX_IMAGE_ANCHOR:
280 case LISTBOX_VERSION_LABEL:
281 case LISTBOX_TEMPLATE_LABEL:
282 case LISTBOX_IMAGE_TEMPLATE_LABEL:
283 case LISTBOX_IMAGE_ANCHOR_LABEL:
284 case LISTBOX_FILTER_SELECTOR:
285 break;
286 }
287 }
288
289 void SAL_CALL Gtk3KDE5FilePicker::initialize(const uno::Sequence<uno::Any>& args)
290 {
291 // parameter checking
292 uno::Any arg;
293 if (args.getLength() == 0)
294 {
295 throw lang::IllegalArgumentException("no arguments", static_cast<XFilePicker2*>(this), 1);
296 }
297
298 arg = args[0];
299
300 if ((arg.getValueType() != cppu::UnoType<sal_Int16>::get())
301 && (arg.getValueType() != cppu::UnoType<sal_Int8>::get()))
302 {
303 throw lang::IllegalArgumentException("invalid argument type",
304 static_cast<XFilePicker2*>(this), 1);
305 }
306
307 sal_Int16 templateId = -1;
308 arg >>= templateId;
309
310 bool saveDialog = false;
311 switch (templateId)
312 {
313 case FILEOPEN_SIMPLE:
314 break;
315
316 case FILESAVE_SIMPLE:
317 saveDialog = true;
318 break;
319
320 case FILESAVE_AUTOEXTENSION:
321 saveDialog = true;
322 addCustomControl(CHECKBOX_AUTOEXTENSION);
323 break;
324
325 case FILESAVE_AUTOEXTENSION_PASSWORD:
326 {
327 saveDialog = true;
328 addCustomControl(CHECKBOX_PASSWORD);
329 addCustomControl(CHECKBOX_GPGENCRYPTION);
330 break;
331 }
332 case FILESAVE_AUTOEXTENSION_PASSWORD_FILTEROPTIONS:
333 {
334 saveDialog = true;
335 addCustomControl(CHECKBOX_AUTOEXTENSION);
336 addCustomControl(CHECKBOX_PASSWORD);
337 addCustomControl(CHECKBOX_GPGENCRYPTION);
338 addCustomControl(CHECKBOX_FILTEROPTIONS);
339 break;
340 }
341 case FILESAVE_AUTOEXTENSION_SELECTION:
342 saveDialog = true;
343 addCustomControl(CHECKBOX_AUTOEXTENSION);
344 addCustomControl(CHECKBOX_SELECTION);
345 break;
346
347 case FILESAVE_AUTOEXTENSION_TEMPLATE:
348 saveDialog = true;
349 addCustomControl(CHECKBOX_AUTOEXTENSION);
350 addCustomControl(LISTBOX_TEMPLATE);
351 break;
352
353 case FILEOPEN_LINK_PREVIEW_IMAGE_TEMPLATE:
354 addCustomControl(CHECKBOX_LINK);
355 addCustomControl(CHECKBOX_PREVIEW);
356 addCustomControl(LISTBOX_IMAGE_TEMPLATE);
357 break;
358
359 case FILEOPEN_LINK_PREVIEW_IMAGE_ANCHOR:
360 addCustomControl(CHECKBOX_LINK);
361 addCustomControl(CHECKBOX_PREVIEW);
362 addCustomControl(LISTBOX_IMAGE_ANCHOR);
363 break;
364
365 case FILEOPEN_PLAY:
366 addCustomControl(PUSHBUTTON_PLAY);
367 break;
368
369 case FILEOPEN_LINK_PLAY:
370 addCustomControl(CHECKBOX_LINK);
371 addCustomControl(PUSHBUTTON_PLAY);
372 break;
373
374 case FILEOPEN_READONLY_VERSION:
375 addCustomControl(CHECKBOX_READONLY);
376 addCustomControl(LISTBOX_VERSION);
377 break;
378
379 case FILEOPEN_READONLY_VERSION_FILTEROPTIONS:
380 addCustomControl(CHECKBOX_READONLY);
381 addCustomControl(LISTBOX_VERSION);
382 addCustomControl(CHECKBOX_FILTEROPTIONS);
383 break;
384
385 case FILEOPEN_LINK_PREVIEW:
386 addCustomControl(CHECKBOX_LINK);
387 addCustomControl(CHECKBOX_PREVIEW);
388 break;
389
390 case FILEOPEN_PREVIEW:
391 addCustomControl(CHECKBOX_PREVIEW);
392 break;
393
394 default:
395 SAL_INFO("vcl.gtkkde5", "unknown templates " << templateId);
396 return;
397 }
398
399 setTitle(getResString(saveDialog ? STR_FILEDLG_SAVE : STR_FILEDLG_OPEN));
400
401 m_ipc.sendCommand(Commands::Initialize, saveDialog);
402 }
403
404 void SAL_CALL Gtk3KDE5FilePicker::cancel()
405 {
406 // TODO
407 }
408
409 void Gtk3KDE5FilePicker::disposing(const lang::EventObject& rEvent)
410 {
411 uno::Reference<XFilePickerListener> xFilePickerListener(rEvent.Source, uno::UNO_QUERY);
412
413 if (xFilePickerListener.is())
414 {
415 removeFilePickerListener(xFilePickerListener);
416 }
417 }
418
419 OUString SAL_CALL Gtk3KDE5FilePicker::getImplementationName() { return FILE_PICKER_IMPL_NAME; }
420
421 sal_Bool SAL_CALL Gtk3KDE5FilePicker::supportsService(const OUString& ServiceName)
422 {
423 return cppu::supportsService(this, ServiceName);
424 }
425
426 uno::Sequence<OUString> SAL_CALL Gtk3KDE5FilePicker::getSupportedServiceNames()
427 {
428 return { "com.sun.star.ui.dialogs.FilePicker", "com.sun.star.ui.dialogs.SystemFilePicker",
429 "com.sun.star.ui.dialogs.Gtk3KDE5FilePicker" };
430 }
431
432 void Gtk3KDE5FilePicker::filterChanged()
433 {
434 FilePickerEvent aEvent;
435 aEvent.ElementId = LISTBOX_FILTER;
436 SAL_INFO("vcl.gtkkde5", "filter changed");
437 if (m_xListener.is())
438 m_xListener->controlStateChanged(aEvent);
439 }
440
441 void Gtk3KDE5FilePicker::selectionChanged()
442 {
443 FilePickerEvent aEvent;
444 SAL_INFO("vcl.gtkkde5", "file selection changed");
445 if (m_xListener.is())
446 m_xListener->fileSelectionChanged(aEvent);
447 }
448
449 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */