src/global.h

   1 /*
   2  * Copyright 2015 Ashish Bansal<bansal.ashish096@gmail.com>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the
  16  * Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  18  */
  19
  20 #ifndef GLOBAL_H
  21 #define GLOBAL_H
  22
  23 #include <QList>
  24 #include <QUrl>
  25 #include <QWidget>
  26
  27 class OrgKdeDolphinMainWindowInterface;
  28
  29 namespace Dolphin {
  30     QList<QUrl> validateUris(const QStringList& uriList);
  31
  32     /**
  33      * Returns the home url which is defined in General Settings
  34      */
  35     QUrl homeUrl();
  36
  37     enum class OpenNewWindowFlag {
  38         None = 0,
  39         Select = 1<<1
  40     };
  41     Q_DECLARE_FLAGS(OpenNewWindowFlags, OpenNewWindowFlag)
  42
  43     /**
  44      * Opens a new Dolphin window
  45      */
  46     void openNewWindow(const QList<QUrl> &urls = {}, QWidget *window = nullptr, const OpenNewWindowFlags &flags = OpenNewWindowFlag::None);
  47
  48     /**
  49      * Attaches URLs to an existing Dolphin instance if possible.
  50      * If @p preferredService is a valid dbus service, it will be tried first.
  51      * @p preferredService needs to support the org.kde.dolphin.MainWindow dbus interface with the /dolphin/Dolphin_1 path.
  52      * Returns true if the URLs were successfully attached.
  53      */
  54     bool attachToExistingInstance(const QList<QUrl>& inputUrls, bool openFiles, bool splitView, const QString& preferredService = QString());
  55
  56     /**
  57      * Returns a QVector with all GUI-capable Dolphin instances
  58      */
  59     QVector<QPair<QSharedPointer<OrgKdeDolphinMainWindowInterface>, QStringList>> dolphinGuiInstances(const QString& preferredService);
  60
  61     /**
  62      * TODO: Move this somewhere global to all KDE apps, not just Dolphin
  63      */
  64     const int VERTICAL_SPACER_HEIGHT = 18;
  65     const int LAYOUT_SPACING_SMALL = 2;
  66 }
  67
  68 #endif //GLOBAL_H