libosmscout  1.1.1
Public Types | Public Slots | Signals | Public Member Functions | Properties | List of all members
osmscout::AvailableVoicesModel Class Reference

#include <libosmscout-client-qt/include/osmscout/AvailableVoicesModel.h>

Inheritance diagram for osmscout::AvailableVoicesModel:
Inheritance graph
[legend]
Collaboration diagram for osmscout::AvailableVoicesModel:
Collaboration graph
[legend]

Public Types

enum  Roles {
  NameRole = Qt::UserRole, LangRole = Qt::UserRole + 1, GenderRole = Qt::UserRole + 2, LicenseRole = Qt::UserRole + 3,
  DirectoryRole = Qt::UserRole + 4, AuthorRole = Qt::UserRole + 5, DescriptionRole = Qt::UserRole + 6, StateRole = Qt::UserRole + 7
}
 
enum  VoiceState { Available, Downloading, Downloaded }
 

Public Slots

void listDownloaded (const VoiceProvider &provider, QNetworkReply *)
 
void reload ()
 
void onVoiceStateChanged (const AvailableVoice &voice)
 

Signals

void loadingChanged ()
 

Public Member Functions

 AvailableVoicesModel ()
 
virtual ~AvailableVoicesModel ()
 
virtual Q_INVOKABLE int rowCount (const QModelIndex &parent=QModelIndex()) const
 
virtual Q_INVOKABLE QVariant data (const QModelIndex &index, int role) const
 
virtual QHash< int, QByteArray > roleNames () const
 
virtual Q_INVOKABLE Qt::ItemFlags flags (const QModelIndex &index) const
 
Q_INVOKABLE void download (const QModelIndex &index)
 
Q_INVOKABLE void remove (const QModelIndex &index)
 
Q_INVOKABLE QString stateStr (VoiceState state) const
 
bool isLoading ()
 
QString getFetchError ()
 

Properties

bool loading
 
QString fetchError
 

Detailed Description

List model with voices available by configured providers (see Settings::GetVoiceProviders). Every voice provider have to expose list of voices by json. Json format exammple:

[
 {
   "lang": "American English",
   "gender": "female",
   "name": "Alex",
   "license": "CC-By-SA 3.0",
   "dir": "American English - Alex (female)",
   "author": "Alex Spehr",
   "description": "American English speaker"
 } 
]

Member Enumeration Documentation

◆ Roles

Enumerator
NameRole 
LangRole 
GenderRole 
LicenseRole 
DirectoryRole 
AuthorRole 
DescriptionRole 
StateRole 

◆ VoiceState

Enumerator
Available 
Downloading 
Downloaded 

Constructor & Destructor Documentation

◆ AvailableVoicesModel()

osmscout::AvailableVoicesModel::AvailableVoicesModel ( )

◆ ~AvailableVoicesModel()

virtual osmscout::AvailableVoicesModel::~AvailableVoicesModel ( )
virtual

Member Function Documentation

◆ data()

virtual Q_INVOKABLE QVariant osmscout::AvailableVoicesModel::data ( const QModelIndex &  index,
int  role 
) const
virtual

◆ download()

Q_INVOKABLE void osmscout::AvailableVoicesModel::download ( const QModelIndex &  index)

◆ flags()

virtual Q_INVOKABLE Qt::ItemFlags osmscout::AvailableVoicesModel::flags ( const QModelIndex &  index) const
virtual

◆ getFetchError()

QString osmscout::AvailableVoicesModel::getFetchError ( )
inline

◆ isLoading()

bool osmscout::AvailableVoicesModel::isLoading ( )
inline

◆ listDownloaded

void osmscout::AvailableVoicesModel::listDownloaded ( const VoiceProvider provider,
QNetworkReply *   
)
slot

◆ loadingChanged

void osmscout::AvailableVoicesModel::loadingChanged ( )
signal

◆ onVoiceStateChanged

void osmscout::AvailableVoicesModel::onVoiceStateChanged ( const AvailableVoice voice)
slot

◆ reload

void osmscout::AvailableVoicesModel::reload ( )
slot

◆ remove()

Q_INVOKABLE void osmscout::AvailableVoicesModel::remove ( const QModelIndex &  index)

◆ roleNames()

virtual QHash<int, QByteArray> osmscout::AvailableVoicesModel::roleNames ( ) const
virtual

◆ rowCount()

virtual Q_INVOKABLE int osmscout::AvailableVoicesModel::rowCount ( const QModelIndex &  parent = QModelIndex()) const
virtual

◆ stateStr()

Q_INVOKABLE QString osmscout::AvailableVoicesModel::stateStr ( VoiceState  state) const

Property Documentation

◆ fetchError

QString osmscout::AvailableVoicesModel::fetchError
read

◆ loading

bool osmscout::AvailableVoicesModel::loading
read

The documentation for this class was generated from the following file: