ksayit/src/ksayit.h

   1 //Added by qt3to4:
   2 #include <QByteArray>
   3 #include <QCloseEvent>
   4 /***************************************************************************
   5                           ksayit.h  -  description
   6                              -------------------
   7     begin                : Son Aug 10 13:26:57 EDT 2003
   8     copyright            : (C) 2003 by Robert Vogl
   9     email                : voglrobe@saphir
  10  ***************************************************************************/
  11
  12 /***************************************************************************
  13  *                                                                         *
  14  *   This program is free software; you can redistribute it and/or modify  *
  15  *   it under the terms of the GNU General Public License as published by  *
  16  *   the Free Software Foundation; either version 2 of the License, or     *
  17  *   (at your option) any later version.                                   *
  18  *                                                                         *
  19  ***************************************************************************/
  20
  21 #ifndef KSAYIT_H
  22 #define KSAYIT_H
  23
  24 #include <config.h>
  25
  26 using namespace std;
  27
  28 // include files for Qt
  29 #include <QStringList>
  30 #include <QClipboard>
  31
  32 // include files for KDE
  33 #include <kapplication.h>
  34 #include <kmainwindow.h>
  35 #include <kaction.h>
  36
  37 #include <kurl.h>
  38 #include <kbookmarkmanager.h>
  39 #include <kbookmarkmenu.h>
  40
  41 // App specific includes
  42
  43 // appended to $HOME
  44 #define KSAYIT_BOOKMARKXMLFILE "/.ksayitbookmarks.xml"
  45
  46 // forward declaration of the KSayIt classes
  47 class KSayItViewImpl;
  48 class DocTreeViewImpl;
  49 class KSayItSystemTray;
  50 // class FXPluginHandler;
  51 // class EffectStack;
  52 class KTTSDLib;
  53 class KSayItBookmarkHandler;
  54
  55 /**
  56   * The base class for KSayIt application windows. It sets up the main
  57   * window and reads the config file as well as providing a menubar, toolbar
  58   * and statusbar. An instance of KSayItView creates the center view.
  59   * KSayItApp reimplements the methods that KMainWindow provides for main window handling and supports
  60   * full session management as well as using KActions.
  61   * @see KMainWindow
  62   * @see KApplication
  63   * @see KConfig
  64   *
  65   * @author Robert Vogl
  66   */
  67 class KSayItApp : public KMainWindow
  68 {
  69   Q_OBJECT
  70 //   K_DCOP
  71
  72 public:
  73     /** construtor of KSayItApp, calls all init functions to create the application.
  74      */
  75     KSayItApp(QWidget* parent=0, const char* name=0, Qt::WFlags f=0,
  76         const QByteArray &objID=0);
  77     ~KSayItApp();
  78
  79 // TODO: Replace with DBUS.
  80 // k_dcop:
  81 //    /** DCOP interface for say operation
  82 //    \param msg The text to speak.
  83 //     */
  84 //    ASYNC dcopSayText(QString msg);
  85 //
  86 //    /** DCOP interface for stop operation
  87 //     */
  88 //    ASYNC dcopStop();
  89 //
  90 //    /** DCOP interface to say DocBook file
  91 //     */
  92 //    ASYNC dcopSayXmlFile(KUrl url);
  93
  94
  95 signals:
  96     /** emitted when the Configuration was modified
  97      */
  98     void signalConfigChanged();
  99
 100 private slots:
 101     /** Puts the given text on the Job-Stack of KTTSD.
 102      * \param text The text to say.
 103      */
 104     void slotSetText(const QString &text);
 105
 106     /** Called from the ListView widget after one or many
 107      * 'setText'-Calls. Starts to say the text.
 108      */
 109     void slotSayNode();
 110
 111     /** Called when a node in the treeview was clicked and
 112      * new content in the edit window must be shown.
 113      * \str The new content of the EditView.
 114      */
 115     void slotTreeViewChanged(const QString &str);
 116
 117     /** save general Options like all bar positions and status as well as the geometry to
 118      * the configuration file.
 119      */
 120     void slotSaveOptions();
 121
 122     /** closes the windows , then quits the application.
 123      */
 124     void slotFileQuit();
 125
 126     /** changes the statusbar contents for the standard label permanently, used to indicate
 127      * current actions.
 128      * @param text the text that is displayed in the statusbar
 129      */
 130     void slotStatusMsg(const QString &text);
 131
 132     /** opens the Preferences-Dialog.
 133      */
 134     void slotPreferences();
 135
 136     /** activated if "say" from tray was clicked.
 137      */
 138     void slotSayClipboard();
 139
 140     /** activated if "say" from app-window was clicked.
 141      */
 142     void slotSayText();
 143
 144     /** activated if "shut up" was clicked.
 145      */
 146     void slotStopActivated();
 147
 148     /** activated if "pause" was clicked.
 149      */
 150     void slotPauseActivated();
 151
 152     /** activated if "next sentence" was clicked.
 153      */
 154     void slotNextSentenceActivated();
 155
 156     /** activated if "previous sentence" was clicked.
 157      */
 158     void slotPrevSentenceActivated();
 159
 160     /** called if text processing was finished.
 161      */
 162     void slotFinished();
 163
 164     /** called to enable the copy/cut action, if text is selected in the TextEdit-View
 165      \param enable Enable actions if true, disable actions if false.
 166      */
 167     void slotEnableCopyCut(bool enable);
 168
 169     /** sets the Caption of the MainWindow */
 170     void slotSetCaption(const QString &caption);
 171
 172     /** called when the Text was changed.
 173      * \param empty True if the TextEdit view is empty.
 174      */
 175     void slotTextChanged(bool empty);
 176
 177     /** enabled/disables the textedit window;
 178      * \param enable true=enabled, false=disabled
 179      */
 180     void slotEnableTextedit(bool enable);
 181
 182     /** toggles the statusbar
 183      */
 184     void slotToggleStatusBar();
 185
 186     /** Called when the ToolBar shall be configured by the user.
 187      */
 188     void slotConfigureToolbar();
 189
 190     /** Called to add a bookmark.
 191      */
 192     void slotAddBookmark();
 193
 194     /** Called to delete a bookmark
 195      */
 196     void slotDeleteBookmark(const QString &url, const QString &title);
 197
 198     /** Called to edit bookmarks.
 199      */
 200     void slotEditBookmarks();
 201
 202     /** Called from slotConfigureToolbar() if we have a new ToolBar-configuration.
 203      */
 204     void slotNewToolbarConfig();
 205
 206     /** called whenever the content of the clipboard changes.
 207      *  Checks if the content of the Clipboard is of type text/plain.
 208      *  Disables and enables the SystemTray-object.
 209      */
 210     void slotClipboardChanged();
 211
 212     /** Deletes the content of the Textview.
 213      */
 214     void slotClear();
 215
 216     /** Hides the MainWindow
 217      */
 218     void slotCloseMainWindow();
 219
 220     /** Dialog to edit the Key associations
 221      */
 222     void slotEditKeys();
 223
 224     /** Open file action
 225      */
 226     void slotFileOpen();
 227
 228     /** Save file
 229      */
 230     void slotFileSave();
 231
 232     /** Save file as
 233      */
 234     void slotFileSaveAs();
 235
 236     /** Called, when the TTS Library has finished processing.
 237      */
 238     void slotTTSFinished();
 239
 240     /** Edit mode switched on/off.
 241      */
 242     void slotEditToggled();
 243
 244     /**
 245      * Catches the signal from the TreeView object
 246      * and forwards it to the BookmarkHandler object.
 247      */
 248     void slotNotifyBookmarkHandler(const QString &ID, const QString &title);
 249
 250     /**
 251      * Copies the content of the current bookmark file to the
 252      * file designated by \p newname and install a new
 253      * BookmarkHandler.
 254      * \param newname The name of the new bookmark file.
 255      */
 256     void slotChangeBookmarkFilename(const QString &newname);
 257
 258     /** Loads bookmark file corresponding to the given file.
 259      * \param newname The name of the new file.
 260      */
 261     void slotSetBookmarkFilename(const QString &newname);
 262
 263 public:
 264     /**
 265      * Selects the item with the given ID in the TreeView.
 266      * \param ID The ID of the item to select.
 267      * \param title The title of the bookmark.
 268      * \returns <tt>QString()</tt>, if the operation was successfull,
 269      * an error message, if the ID was not found.
 270      */
 271     QString setItemByBookmark( const QString &ID, const QString &title );
 272
 273 private: // Methods
 274     /** read general Options again and initialize all variables.
 275      */
 276     void readOptions();
 277
 278     /** initializes the KActions of the application */
 279     void initActions();
 280
 281     /** sets up the statusbar for the main window by initialzing a statuslabel.
 282      */
 283     void initStatusBar();
 284
 285     /**
 286      */
 287     void initBookmarkManager(const QString &filename);
 288
 289     /** creates the centerwidget of the KTMainWindow instance and sets it as the view.
 290      */
 291     void initView();
 292
 293     /** resets the editor. Do not create an empty document.
 294      */
 295     void resetView();
 296
 297     /** start to say the text on the KTTSD's Job-Stack.
 298      */
 299     void sayActivated();
 300
 301     /** reimplemented from baseclass
 302      */
 303     virtual void closeEvent(QCloseEvent *ce);
 304
 305     /** disable/enable Actions.
 306      * \param actions An OR'ed integer of enum ACTIONS. A '1' is supposed
 307      * as 'Action enabled'.
 308      */
 309     void setActions(int actions);
 310
 311     /**
 312      * Returns the absolute pathname of the given bookmarkfile.
 313      * This is the first KDE resource directory \p (share/apps) in which
 314      * the user has write permissions. The relative path is
 315      * \p ksayit/ksayit_bookmarks/.
 316      * \param filename The name of the bookmark file.
 317      * \returns The absolute pathname of the given bookmark file.
 318      * Returns \p QString() if the operation was not successfull.
 319      */
 320     QString getBookmarkDir(const QString &filename);
 321
 322
 323 private:
 324     KConfig *config;
 325     KSayItViewImpl *view;
 326     KSayItSystemTray *tray;
 327     // EffectStack *es;
 328     DocTreeViewImpl *treeview;
 329     KBookmarkManager *bkManager;
 330     KSayItBookmarkHandler *bkHandler;
 331     KBookmarkMenu *bkMenu;
 332
 333     // KAction pointers
 334     KToggleAction *statusBarAction;
 335     KAction *say;
 336     KAction *pause;
 337     KAction *shutup;
 338     KAction *next_sentence;
 339     KAction *prev_sentence;
 340     KAction *clear;
 341     KAction *copy;
 342     KAction *cut;
 343     KAction *paste;
 344     KAction *open;
 345     KAction *save;
 346     KAction *saveAs;
 347     KAction *preferences;
 348     KToggleAction *edit;
 349     KActionMenu *bookmarkmenu;
 350
 351     // Misc stuff
 352     QClipboard *cb;
 353     QString clip;
 354     KTTSDLib *m_kttslib;
 355     // FXPluginHandler *m_fxpluginhandler;
 356     bool m_ap_saying;
 357     bool m_ap_paused;
 358     bool m_textview_empty;
 359     bool m_enableChangeNotifications;
 360     QString m_currentBookmarkFile;
 361
 362 };
 363
 364 #endif // KSAYIT_H