kttsd/kttsjobmgr/kttsjobmgr.h

   1 /***************************************************** vim:set ts=4 sw=4 sts=4:
   2   A KPart to display running jobs in KTTSD and permit user to stop, rewind,
   3   advance, change Talker, etc.
   4   -------------------
   5   Copyright : (C) 2004 by Gary Cramblitt <garycramblitt@comcast.net>
   6   Copyright : (C) 2009 by Jeremy Whiting <jeremy@scitools.com>
   7   -------------------
   8
   9   This program is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU General Public License as published by
  11   the Free Software Foundation; either version 2 of the License, or
  12   (at your option) any later version.
  13
  14   This program is distributed in the hope that it will be useful,
  15   but WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17   GNU General Public License for more details.
  18
  19   You should have received a copy of the GNU General Public License
  20   along with this program; if not, write to the Free Software
  21   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  22  ******************************************************************************/
  23
  24 #ifndef KTTSJOBMGRPART_H
  25 #define KTTSJOBMGRPART_H
  26
  27 // Qt includes
  28
  29
  30 // KDE includes.
  31 #include <kparts/browserextension.h>
  32
  33 // KTTS includes.
  34 #include "kspeechinterface.h"
  35
  36 class QTreeView;
  37 class KAboutData;
  38 class KPushButton;
  39 class KttsJobMgrBrowserExtension;
  40 class KVBox;
  41 class KTextEdit;
  42 class JobInfo;
  43 class JobInfoListModel;
  44
  45 namespace Ui
  46 {
  47     class kttsjobmgr;
  48 }
  49
  50 class KttsJobMgrPart:
  51     public KParts::ReadOnlyPart
  52 {
  53     Q_OBJECT
  54 public:
  55     KttsJobMgrPart(QWidget *parentWidget, QObject *parent, const QStringList& args=QStringList());
  56     virtual ~KttsJobMgrPart();
  57     static KAboutData* createAboutData();
  58
  59 protected:
  60     virtual bool openFile();
  61     virtual bool closeUrl();
  62
  63     /** Slots connected to DBUS Signals emitted by KTTSD. */
  64 protected Q_SLOTS:
  65     /**
  66     * This signal is emitted when KTTSD starts or restarts after a call to reinit.
  67     */
  68     Q_SCRIPTABLE void kttsdStarted();
  69
  70     /**
  71     * This signal is emitted each time the state of a job changes.
  72     * @param appId              The DBUS sender ID of the application that
  73     *                           submitted the job.
  74     * @param jobNum             Job Number.
  75     * @param state              Job state.  @see KSpeech::JobState.
  76     */
  77     Q_SCRIPTABLE void jobStateChanged(const QString &appId, int jobNum, int state);
  78
  79     /**
  80     * This signal is emitted when a marker is processed.
  81     * Currently only emits mtSentenceBegin and mtSentenceEnd.
  82     * @param appId         The DBUS sender ID of the application that submitted the job.
  83     * @param jobNum        Job Number of the job emitting the marker.
  84     * @param markerType    The type of marker.
  85     *                      Currently either mtSentenceBegin or mtSentenceEnd.
  86     * @param markerData    Data for the marker.
  87     *                      Currently, this is the sequence number of the sentence
  88     *                      begun or ended.  Sequence numbers begin at 1.
  89     */
  90     Q_SCRIPTABLE void marker(const QString &appId, int jobNum, int markerType, const QString &markerData);
  91
  92 private slots:
  93     /**
  94     * This slot is connected to the Job List View clicked signal.
  95     */
  96     void slot_jobListView_clicked();
  97
  98     /**
  99     * Slots connected to buttons.
 100     */
 101     void slot_job_hold();
 102     void slot_job_resume();
 103     void slot_job_restart();
 104     void slot_job_remove();
 105     void slot_job_remove_all();
 106     void slot_job_move();
 107     void slot_job_change_talker();
 108     void slot_speak_clipboard();
 109     void slot_speak_file();
 110     void slot_refresh();
 111     void slot_job_prev_sen();
 112     void slot_job_next_sen();
 113
 114 private:
 115     /**
 116     * Get the Job Number of the currently-selected job in the Job List View.
 117     * @return               Job Number of currently-selected job.
 118     *                       0 if no currently-selected job.
 119     */
 120     int getCurrentJobNum();
 121
 122     /**
 123     * Enables or disables all the job-related buttons.
 124     * @param enable        True to enable the job-related butons.  False to disable.
 125     */
 126     void enableJobActions(bool enable);
 127
 128     /**
 129     * Retrieves JobInfo from KTTSD, creates and fills JobInfo object.
 130     * @param jobNum         Job Number.
 131     */
 132     JobInfo* retrieveJobInfo(int jobNum);
 133
 134     /**
 135     * Refresh display of a single job in the JobListView.
 136     * @param jobNum         Job Number.
 137     */
 138     void refreshJob(int jobNum);
 139
 140     /**
 141     * Fill the Job List.
 142     */
 143     void refreshJobList();
 144
 145     /**
 146     * If nothing selected in Job List View and list not empty, select top item.
 147     * If nothing selected and list is empty, disable job buttons.
 148     */
 149     void autoSelectInJobListView();
 150
 151     /**
 152     * DBUS KSpeech Interface.
 153     */
 154     org::kde::KSpeech* m_kspeech;
 155
 156     /**
 157     * Return the Talker ID corresponding to a Talker Code, retrieving from cached list if present.
 158     * @param talkerCode    Talker Code.
 159     * @return              Talker ID.
 160     */
 161     QString cachedTalkerCodeToTalkerID(const QString& talkerCode);
 162
 163     /**
 164     * Job ListView.
 165     */
 166     JobInfoListModel* m_jobListModel;
 167     KttsJobMgrBrowserExtension *m_extension;
 168     Ui::kttsjobmgr * m_ui;
 169     QList<KPushButton*> m_jobButtons;
 170
 171     /**
 172     * This flag is set to True whenever we want to select the next job that
 173     * is announced in a textSet signal.
 174     */
 175     bool m_selectOnTextSet;
 176
 177     /**
 178     * Cache mapping Talker Codes to Talker IDs.
 179     */
 180     QMap<QString,QString> m_talkerCodesToTalkerIDs;
 181 };
 182
 183 class KttsJobMgrBrowserExtension : public KParts::BrowserExtension
 184 {
 185     Q_OBJECT
 186     friend class KttsJobMgrPart;
 187 public:
 188     KttsJobMgrBrowserExtension(KttsJobMgrPart *parent);
 189     virtual ~KttsJobMgrBrowserExtension();
 190 };
 191
 192 #endif    // KTTSJOBMGRPART_H