Voice.h

Go to the documentation of this file.

#ifndef OSMSCOUT_CLIENT_QT_VOICE_H
#define OSMSCOUT_CLIENT_QT_VOICE_H
/*
  OSMScout - a Qt backend for libosmscout and libosmscout-map
  Copyright (C) 2020 Lukas Karas

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
*/

#include <osmscout/ClientQtImportExport.h>
#include <osmscout/VoiceProvider.h>

#include <QObject>
#include <QDir>

namespace osmscout {

class OSMSCOUT_CLIENT_QT_API AvailableVoice : public QObject {
  Q_OBJECT

  Q_PROPERTY(bool valid READ isValid() CONSTANT)

  Q_PROPERTY(QString lang READ getLang() CONSTANT)
  Q_PROPERTY(QString gender READ getGender() CONSTANT)
  Q_PROPERTY(QString name READ getName() CONSTANT)
  Q_PROPERTY(QString license READ getLicense() CONSTANT)
  Q_PROPERTY(QString directory READ getDirectory() CONSTANT)
  Q_PROPERTY(QString author READ getAuthor() CONSTANT)
  Q_PROPERTY(QString description   READ getDescription() CONSTANT)

private:
  bool valid{false};

  VoiceProvider provider;

  QString lang;
  QString gender;
  QString name;
  QString license;
  QString directory;
  QString author;
  QString description;

public:
  AvailableVoice() = default;

  AvailableVoice(const VoiceProvider &provider,
                 const QString &lang,
                 const QString &gender,
                 const QString &name,
                 const QString &license,
                 const QString &directory,
                 const QString &author,
                 const QString &description);

  AvailableVoice(const AvailableVoice& o);

  ~AvailableVoice() override = default;

  inline VoiceProvider getProvider() const
  {
    return provider;
  }

  inline QString getLang() const
  {
    return lang;
  }
  inline QString getGender() const
  {
    return gender;
  }
  inline QString getName() const
  {
    return name;
  }
  inline QString getLicense() const
  {
    return license;
  }
  inline QString getDirectory() const
  {
    return directory;
  }
  inline QString getAuthor() const
  {
    return author;
  }
  inline QString getDescription() const
  {
    return description;
  }

  inline bool isValid() const
  {
    return valid;
  }
};

class OSMSCOUT_CLIENT_QT_API Voice
{
public:
  Voice() = default;
  explicit Voice(QDir dir);
  ~Voice() = default;

  Voice(const Voice &other) = default;
  Voice &operator=(const Voice &other) = default;

  Voice(Voice &&other) = default;
  Voice &operator=(Voice &&other) = default;

  QDir getDir() const
  {
    return dir;
  }

  inline QString getLang() const
  {
    return lang;
  }

  inline QString getGender() const
  {
    return gender;
  }

  inline QString getName() const
  {
    return name;
  }

  inline QString getLicense() const
  {
    return license;
  }

  inline QString getAuthor() const
  {
    return author;
  }

  inline QString getDescription() const
  {
    return description;
  }

  inline bool isValid() const
  {
    return valid;
  }

  bool deleteVoice();

  static QStringList files();

private:
  QDir dir;
  bool valid{false};
  bool metadata{false};

  QString lang;
  QString gender;
  QString name;
  QString license;
  QString author;
  QString description;
};

}

#endif //OSMSCOUT_CLIENT_QT_VOICE_H