File indexing completed on 2024-05-19 04:56:13

 /**
  * \file icoreplatformtools.h
  * Interface for GUI independent platform specific tools.
  *
  * \b Project: Kid3
  * \author Urs Fleisch
  * \date 06 Apr 2013
  *
  * Copyright (C) 2013-2018  Urs Fleisch
  *
  * This file is part of Kid3.
  *
  * Kid3 is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
  *
  * Kid3 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 General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 #pragma once
 
 #include <QList>
 #include <QPair>
 #include "kid3api.h"
 
 class QObject;
 class QString;
 class QWidget;
 class ISettings;
 class CoreTaggedFileIconProvider;
 class Kid3Application;
 
 /**
  * Interface for GUI independent platform specific tools.
  */
 class KID3_CORE_EXPORT ICorePlatformTools {
 public:
   /**
    * Destructor.
    */
   virtual ~ICorePlatformTools();
 
   /**
    * Get application settings.
    * @return settings instance.
    */
   virtual ISettings* applicationSettings() = 0;
 
   /**
    * Get icon provider for tagged files.
    * @return icon provider.
    */
   virtual CoreTaggedFileIconProvider* iconProvider() = 0;
 
   /**
    * Write text to clipboard.
    * @param text text to write
    * @return true if operation is supported.
    */
   virtual bool writeToClipboard(const QString& text) const = 0;
 
   /**
    * Read text from clipboard.
    * @return text, null if operation not supported.
    */
   virtual QString readFromClipboard() const = 0;
 
   /**
    * Create an audio player instance.
    * @param app application context
    * @param dbusEnabled true to enable MPRIS D-Bus interface
    * @return audio player, nullptr if not supported.
    */
   virtual QObject* createAudioPlayer(Kid3Application* app,
                                      bool dbusEnabled) const = 0;
 
   /**
    * Move file or directory to trash.
    *
    * @param path path to file or directory
    *
    * @return true if ok.
    */
   virtual bool moveToTrash(const QString& path) const = 0;
 
   /**
    * Construct a name filter string suitable for file dialogs.
    * @param nameFilters list of description, filter pairs, e.g.
    * [("Images", "*.jpg *.jpeg *.png"), ("All Files", "*")].
    * @return name filter string.
    */
   virtual QString fileDialogNameFilter(
       const QList<QPair<QString, QString> >& nameFilters) const = 0;
 
   /**
    * Get file pattern part of m_nameFilter.
    * @param nameFilter name filter string
    * @return file patterns, e.g. "*.mp3".
    */
   virtual QString getNameFilterPatterns(const QString& nameFilter) const = 0;
 
   /**
    * Display dialog to select an existing file.
    * This default implementation only displays a warning, it is only supported
    * when having a GUI.
    * @param parent parent widget
    * @param caption caption
    * @param dir directory
    * @param filter filter
    * @param selectedFilter the selected filter is returned here
    * @return selected file, empty if canceled.
    */
   virtual QString getOpenFileName(QWidget* parent,
       const QString& caption, const QString& dir, const QString& filter,
       QString* selectedFilter);
 
   /**
    * Display dialog to select a file to save.
    * This default implementation only displays a warning, it is only supported
    * when having a GUI.
    * @param parent parent widget
    * @param caption caption
    * @param dir directory
    * @param filter filter
    * @param selectedFilter the selected filter is returned here
    * @return selected file, empty if canceled.
    */
   virtual QString getSaveFileName(QWidget* parent,
       const QString& caption, const QString& dir, const QString& filter,
       QString* selectedFilter);
 
   /**
    * Display dialog to select an existing directory.
    * This default implementation only displays a warning, it is only supported
    * when having a GUI.
    * @param parent parent widget
    * @param caption caption
    * @param startDir start directory
    * @return selected directory, empty if canceled.
    */
   virtual QString getExistingDirectory(QWidget* parent,
       const QString& caption, const QString& startDir);
 
   /**
    * Check if platform has a graphical user interface.
    * @return true if platform has GUI.
    */
   virtual bool hasGui() const;
 
 protected:
   /**
    * Construct a name filter string suitable for file dialogs.
    * This function can be used to implement fileDialogNameFilter()
    * for QFileDialog.
    * @param nameFilters list of description, filter pairs, e.g.
    * [("Images", "*.jpg *.jpeg *.png"), ("All Files", "*")].
    * @return name filter string.
    */
   static QString qtFileDialogNameFilter(
       const QList<QPair<QString, QString> >& nameFilters);
 
   /**
    * Get file pattern part of m_nameFilter.
    * This function can be used to implement getNameFilterPatterns()
    * for QFileDialog.
    * @param nameFilter name filter string
    * @return file patterns, e.g. "*.mp3".
    */
   static QString qtNameFilterPatterns(const QString& nameFilter);
 };