vcl/unx/gtk3_kde5/gtk3_kde5_filepicker.cxx

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