imagehelpers.h

Go to the documentation of this file.

/*
 * LibrePCB - Professional EDA for everyone!
 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
 * https://librepcb.org/
 *
 * This program 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 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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/>.
 */
 
#ifndef LIBREPCB_EDITOR_IMAGEHELPERS_H
#define LIBREPCB_EDITOR_IMAGEHELPERS_H
 
/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include <librepcb/core/fileio/filepath.h>
#include <librepcb/core/types/fileproofname.h>
 
#include <QtCore>
 
#include <optional>
 
/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {
 
class TransactionalDirectory;
 
namespace editor {
 
/*******************************************************************************
 *  Class ImageHelpers
 ******************************************************************************/
 
class ImageHelpers final {
  Q_DECLARE_TR_FUNCTIONS(ImageHelpers)
 
public:
  // Types
  enum class Target { Symbol, Project };
 
  // Constructors / Destructor
  ImageHelpers() = delete;
  ImageHelpers(const ImageHelpers& other) = delete;
  ~ImageHelpers() = delete;
 
  // Operator Overloadings
  ImageHelpers& operator=(const ImageHelpers& rhs) = delete;
 
  // Static Methods
 
  static std::optional<FileProofName> findExistingFile(
      const TransactionalDirectory& dir, const QByteArray& data);
 
  static FileProofName getUnusedFileName(const TransactionalDirectory& dir,
                                         QString nameUserInput,
                                         const QString& extension);
 
  static bool execImageChooserDialog(QByteArray& data, QString& format,
                                     QString& basename,
                                     const QString& settingsKey);
 
  static std::optional<FileProofName> findExistingOrAskForNewImageFileName(
      const TransactionalDirectory& dir, Target target, const QByteArray& data,
      const QString& format, const QString& basename, bool& exists);
 
  static bool isImageInClipboard() noexcept;
 
  static bool getImageFromClipboard(QByteArray& data, QString& format,
                                    QString& basename) noexcept;
};
 
/*******************************************************************************
 *  End of File
 ******************************************************************************/
 
}  // namespace editor
}  // namespace librepcb
 
#endif