kmouth/kmouth.cpp

   1 /***************************************************************************
   2                           kmouth.cpp  -  description
   3                              -------------------
   4     begin                : Mon Aug 26 15:41:23 CEST 2002
   5     copyright            : (C) 2002 by Gunnar Schmi Dt
   6     email                : kmouth@schmi-dt.de
   7  ***************************************************************************/
   8
   9 /***************************************************************************
  10  *                                                                         *
  11  *   This program is free software; you can redistribute it and/or modify  *
  12  *   it under the terms of the GNU General Public License as published by  *
  13  *   the Free Software Foundation; either version 2 of the License, or     *
  14  *   (at your option) any later version.                                   *
  15  *                                                                         *
  16  ***************************************************************************/
  17
  18 // include files for QT
  19 #include <QDir>
  20 #include <QPainter>
  21 //Added by qt3to4:
  22 #include <QMenu>
  23 #include <kxmlguifactory.h>
  24 // include files for KDE
  25 #include <kiconloader.h>
  26 #include <kmenubar.h>
  27 #include <kstatusbar.h>
  28 #include <klocale.h>
  29 #include <kconfig.h>
  30 #include <kstdaction.h>
  31 #include <kprinter.h>
  32 #include <kmenu.h>
  33 #include <kstandarddirs.h>
  34 #include <kglobal.h>
  35 #include <ktoolbar.h>
  36 // application specific includes
  37 #include "kmouth.h"
  38 #include "phraselist.h"
  39 #include "phrasebook/phrasebook.h"
  40 #include "phrasebook/phrasebookdialog.h"
  41 #include "optionsdialog.h"
  42 #include "configwizard.h"
  43
  44 #define ID_STATUS_MSG 1
  45
  46 KMouthApp::KMouthApp(QWidget* , const char* name):KMainWindow(0, name)
  47 {
  48    isConfigured = false;
  49    config=KGlobal::config();
  50
  51    ///////////////////////////////////////////////////////////////////
  52    // call inits to invoke all other construction parts
  53    initStatusBar();
  54    initPhraseList();
  55    initActions();
  56    optionsDialog = new OptionsDialog(this);
  57    connect (optionsDialog, SIGNAL(configurationChanged ()),
  58             this, SLOT(slotConfigurationChanged ()));
  59    connect (optionsDialog, SIGNAL(configurationChanged ()),
  60             phraseList, SLOT(configureCompletion ()));
  61
  62    phrases = new KActionCollection (static_cast<QWidget*>(this));
  63
  64    readOptions();
  65    ConfigWizard *wizard = new ConfigWizard (this, "ConfigWizard", config);
  66    if (wizard->configurationNeeded ()) {
  67       if (wizard->requestConfiguration ()) {
  68          isConfigured = true;
  69          saveOptions();
  70          wizard->saveConfig (config);
  71          readOptions();
  72       }
  73       else
  74          isConfigured = false;
  75    }
  76    else
  77       isConfigured = true;
  78    delete wizard;
  79
  80    if (isConfigured) {
  81       phraseList->configureCompletion();
  82    }
  83
  84    ///////////////////////////////////////////////////////////////////
  85    // disable actions at startup
  86    fileSaveAs->setEnabled(false);
  87    filePrint->setEnabled(false);
  88 }
  89
  90 KMouthApp::~KMouthApp()
  91 {
  92
  93 }
  94
  95 bool KMouthApp::configured() {
  96    return isConfigured;
  97 }
  98
  99 void KMouthApp::initActions() {
 100 // The "File" menu
 101    fileOpen = new KAction(i18n("&Open as History..."), "phrasehistory_open", KStdAccel::open(), this, SLOT(slotFileOpen()), actionCollection(),"file_open");
 102    fileOpen->setToolTip(i18n("Opens an existing file as history"));
 103    fileOpen->setWhatsThis (i18n("Opens an existing file as history"));
 104
 105    fileSaveAs = new KAction(i18n("Save &History As..."), "phrasehistory_save", KStdAccel::save(), this, SLOT(slotFileSaveAs()), actionCollection(),"file_save_as");
 106    fileSaveAs->setToolTip(i18n("Saves the actual history as..."));
 107    fileSaveAs->setWhatsThis (i18n("Saves the actual history as..."));
 108
 109    filePrint = new KAction(i18n("&Print History..."), "phrasehistory_print", KStdAccel::print(), this, SLOT(slotFilePrint()), actionCollection(),"file_print");
 110    filePrint->setToolTip(i18n("Prints out the actual history"));
 111    filePrint->setWhatsThis (i18n("Prints out the actual history"));
 112
 113    fileQuit = KStdAction::quit(this, SLOT(slotFileQuit()), actionCollection());
 114    fileQuit->setToolTip(i18n("Quits the application"));
 115    fileQuit->setWhatsThis (i18n("Quits the application"));
 116
 117 // The "Edit" menu
 118    editCut = KStdAction::cut(phraseList, SLOT(cut()), actionCollection());
 119    editCut->setToolTip(i18n("Cuts the selected section and puts it to the clipboard"));
 120    editCut->setWhatsThis (i18n("Cuts the selected section and puts it to the clipboard. If there is some text selected in the edit field it is placed it on the clipboard. Otherwise the selected sentences in the history (if any) are placed on the clipboard."));
 121
 122    editCopy = KStdAction::copy(phraseList, SLOT(copy()), actionCollection());
 123    editCopy->setToolTip(i18n("Copies the selected section to the clipboard"));
 124    editCopy->setWhatsThis (i18n("Copies the selected section to the clipboard. If there is some text selected in the edit field it is copied to the clipboard. Otherwise the selected sentences in the history (if any) are copied to the clipboard."));
 125
 126    editPaste = KStdAction::paste(phraseList, SLOT(paste()), actionCollection());
 127    editPaste->setToolTip(i18n("Pastes the clipboard contents to actual position"));
 128    editPaste->setWhatsThis (i18n("Pastes the clipboard contents at the current cursor position into the edit field."));
 129
 130    editSpeak = new KAction (i18n("&Speak"), "speak", 0, phraseList, SLOT(speak()), actionCollection(),"edit_speak");
 131    editSpeak->setToolTip(i18n("Speaks the currently active sentence(s)"));
 132    editSpeak->setWhatsThis (i18n("Speaks the currently active sentence(s). If there is some text in the edit field it is spoken. Otherwise the selected sentences in the history (if any) are spoken."));
 133
 134 // The "Phrase book" menu
 135    phrasebookEdit = new KAction(i18n("&Edit..."), 0, 0, this, SLOT(slotEditPhrasebook()), actionCollection(),"phrasebook_edit");
 136
 137 // The "Options" menu
 138    viewMenuBar = KStdAction::showMenubar(this, SLOT(slotViewMenuBar()), actionCollection());
 139    // FIXME: Disable so it will compile.
 140    // viewToolBar = KStdAction::showToolbar(this, SLOT(slotViewToolBar()), actionCollection());
 141    // viewToolBar->setToolTip(i18n("Enables/disables the toolbar"));
 142    // viewToolBar->setWhatsThis (i18n("Enables/disables the toolbar"));
 143
 144    viewPhrasebookBar = new KToggleAction (i18n("Show P&hrasebook Bar"), 0, 0, this, SLOT(slotViewPhrasebookBar()), actionCollection(), "showPhrasebookBar");
 145    viewPhrasebookBar->setToolTip(i18n("Enables/disables the phrasebook bar"));
 146    viewPhrasebookBar->setWhatsThis (i18n("Enables/disables the phrasebook bar"));
 147
 148    viewStatusBar = KStdAction::showStatusbar(this, SLOT(slotViewStatusBar()), actionCollection());
 149    viewStatusBar->setToolTip(i18n("Enables/disables the statusbar"));
 150    viewStatusBar->setWhatsThis (i18n("Enables/disables the statusbar"));
 151
 152    configureTTS = new KAction (i18n("&Configure KMouth..."), "configure", 0, this, SLOT(slotConfigureTTS()), actionCollection(), "configureTTS");
 153    configureTTS->setToolTip(i18n("Opens the configuration dialog"));
 154    configureTTS->setWhatsThis (i18n("Opens the configuration dialog"));
 155
 156 // The "Help" menu
 157    // The "Help" menu will automatically get created.
 158
 159 // The popup menu of the list of spoken sentences
 160    phraseListSpeak = new KAction (i18n("&Speak"),  "speak",  0, phraseList, SLOT(speakListSelection()),  actionCollection(), "phraselist_speak");
 161    phraseListSpeak->setToolTip(i18n("Speaks the currently selected phrases in the history"));
 162    phraseListSpeak->setWhatsThis (i18n("Speaks the currently selected phrases in the history"));
 163
 164    phraseListRemove = new KAction (i18n("&Delete"), "editdelete", 0, phraseList, SLOT(removeListSelection()), actionCollection(), "phraselist_remove");
 165    phraseListRemove->setToolTip(i18n("Deletes the currently selected phrases from the history"));
 166    phraseListRemove->setWhatsThis (i18n("Deletes the currently selected phrases from the history"));
 167
 168    phraseListCut = new KAction (i18n("Cu&t"),   "editcut", 0, phraseList, SLOT(cutListSelection()),    actionCollection(), "phraselist_cut");
 169    phraseListCut->setToolTip(i18n("Cuts the currently selected phrases from the history and puts them to the clipboard"));
 170    phraseListCut->setWhatsThis (i18n("Cuts the currently selected phrases from the history and puts them to the clipboard"));
 171
 172    phraseListCopy   = new KAction (i18n("&Copy"), "editcopy", 0, phraseList, SLOT(copyListSelection()),   actionCollection(), "phraselist_copy");
 173    phraseListCut->setToolTip(i18n("Copies the currently selected phrases from the history to the clipboard"));
 174    phraseListCut->setWhatsThis (i18n("Copies the currently selected phrases from the history to the clipboard"));
 175
 176    phraselistSelectAll = new KAction (i18n("Select &All Entries"), 0, 0, phraseList, SLOT(selectAllEntries()), actionCollection(),"phraselist_select_all");
 177    phraselistSelectAll->setToolTip(i18n("Selects all phrases in the history"));
 178    phraselistSelectAll->setWhatsThis (i18n("Selects all phrases in the history"));
 179
 180    phraselistDeselectAll = new KAction (i18n("D&eselect All Entries"), 0, 0, phraseList, SLOT(deselectAllEntries()), actionCollection(),"phraselist_deselect_all");
 181    phraselistDeselectAll->setToolTip(i18n("Deselects all phrases in the history"));
 182    phraselistDeselectAll->setWhatsThis (i18n("Deselects all phrases in the history"));
 183
 184 // The popup menu of the edit field
 185    // The popup menu of the edit field will automatically get created.
 186
 187    // use the absolute path to your kmouthui.rc file for testing purpose in createGUI();
 188    createGUI();
 189 }
 190
 191 void KMouthApp::initStatusBar()
 192 {
 193   ///////////////////////////////////////////////////////////////////
 194   // STATUSBAR
 195   // TODO: add your own items you need for displaying current application status.
 196   statusBar()->insertItem(i18n("Ready."), ID_STATUS_MSG);
 197 }
 198
 199 void KMouthApp::initPhraseList()
 200 {
 201   ////////////////////////////////////////////////////////////////////
 202   // create the main widget here that is managed by KTMainWindow's view-region and
 203   // connect the widget to your document to display document contents.
 204
 205    phraseList = new PhraseList(this);
 206    setCentralWidget(phraseList);
 207 }
 208
 209 void KMouthApp::openDocumentFile(const KUrl& url)
 210 {
 211   slotStatusMsg(i18n("Opening file..."));
 212
 213   phraseList->open (url);
 214   slotStatusMsg(i18n("Ready."));
 215 }
 216
 217 void KMouthApp::saveOptions() {
 218    if (isConfigured) {
 219       config->setGroup("General Options");
 220       config->writeEntry("Geometry", size());
 221       config->writeEntry("Show Menubar", viewMenuBar->isChecked());
 222       // FIXME: Toolbar disabled so it will compile.
 223       // config->writeEntry("Show Toolbar", viewToolBar->isChecked());
 224       config->writeEntry("Show Phrasebook Bar", viewPhrasebookBar->isChecked());
 225       config->writeEntry("Show Statusbar",viewStatusBar->isChecked());
 226       config->writeEntry("ToolBarPos", (int) toolBar("mainToolBar")->barPos());
 227
 228       if (phraseList != 0)
 229          phraseList->saveCompletionOptions(config);
 230       optionsDialog->saveOptions(config);
 231       toolBar("mainToolBar")->saveSettings (config, "mainToolBar");
 232       toolBar("phrasebookBar")->saveSettings (config, "phrasebookBar");
 233    }
 234 }
 235
 236
 237 void KMouthApp::readOptions()
 238 {
 239   config->setGroup("General Options");
 240
 241   // bar status settings
 242   bool bViewMenubar = config->readEntry("Show Menubar", true);
 243   viewMenuBar->setChecked(bViewMenubar);
 244   slotViewMenuBar();
 245
 246   // FIXME: Toolbar disabled so it will compile.
 247   // bool bViewToolbar = config->readEntry("Show Toolbar", QVariant(true)).toBool();
 248   // viewToolBar->setChecked(bViewToolbar);
 249   // slotViewToolBar();
 250
 251   bool bViewPhrasebookbar = config->readEntry("Show Phrasebook Bar", true);
 252   viewPhrasebookBar->setChecked(bViewPhrasebookbar);
 253
 254   bool bViewStatusbar = config->readEntry("Show Statusbar", true);
 255   viewStatusBar->setChecked(bViewStatusbar);
 256   slotViewStatusBar();
 257
 258
 259   // bar position settings
 260   KToolBar::BarPosition toolBarPos;
 261   toolBarPos=(KToolBar::BarPosition) config->readEntry("ToolBarPos", int(KToolBar::Top));
 262   toolBar("mainToolBar")->setBarPos(toolBarPos);
 263
 264   QSize size=config->readEntry("Geometry",QSize());
 265   if(!size.isEmpty())
 266   {
 267     resize(size);
 268   }
 269
 270   optionsDialog->readOptions(config);
 271
 272   toolBar("mainToolBar")->applySettings (config, "mainToolBar");
 273   toolBar("phrasebookBar")->applySettings (config, "phrasebookBar");
 274
 275   QString standardBook = KApplication::kApplication()->dirs()->findResource("appdata", "standard.phrasebook");
 276   if (!standardBook.isEmpty()) {
 277      PhraseBook book;
 278      book.open(KUrl::fromPathOrURL( standardBook ));
 279      slotPhrasebookConfirmed(book);
 280   }
 281   if (phraseList != 0)
 282      phraseList->readCompletionOptions(config);
 283 }
 284
 285 bool KMouthApp::queryClose()
 286 {
 287   return true;
 288 }
 289
 290 bool KMouthApp::queryExit()
 291 {
 292   saveOptions();
 293   return true;
 294 }
 295
 296 void KMouthApp::enableMenuEntries(bool existSelectedEntries, bool existDeselectedEntries) {
 297   bool existEntries = existSelectedEntries | existDeselectedEntries;
 298   fileSaveAs->setEnabled (existEntries);
 299   filePrint->setEnabled (existEntries);
 300
 301   phraselistSelectAll->setEnabled (existDeselectedEntries);
 302
 303   phraselistDeselectAll->setEnabled (existSelectedEntries);
 304   phraseListSpeak->setEnabled (existSelectedEntries);
 305   phraseListRemove->setEnabled (existSelectedEntries);
 306   phraseListCut->setEnabled (existSelectedEntries);
 307   phraseListCopy->setEnabled (existSelectedEntries);
 308 }
 309
 310 /////////////////////////////////////////////////////////////////////
 311 // SLOT IMPLEMENTATION
 312 /////////////////////////////////////////////////////////////////////
 313
 314 void KMouthApp::slotFileOpen() {
 315    slotStatusMsg(i18n("Opening file..."));
 316
 317    phraseList->open();
 318
 319    slotStatusMsg(i18n("Ready."));
 320 }
 321
 322 void KMouthApp::slotFileSaveAs() {
 323    slotStatusMsg(i18n("Saving history with a new filename..."));
 324
 325    phraseList->save();
 326
 327    slotStatusMsg(i18n("Ready."));
 328 }
 329
 330 void KMouthApp::slotFilePrint()
 331 {
 332   slotStatusMsg(i18n("Printing..."));
 333
 334   KPrinter printer;
 335   if (printer.setup(this))
 336   {
 337     phraseList->print(&printer);
 338   }
 339
 340   slotStatusMsg(i18n("Ready."));
 341 }
 342
 343 void KMouthApp::slotFileQuit()
 344 {
 345   slotStatusMsg(i18n("Exiting..."));
 346   saveOptions();
 347   // close the first window, the list makes the next one the first again.
 348   // This ensures that queryClose() is called on each window to ask for closing
 349   KMainWindow* w;
 350   if (!memberList().isEmpty())
 351   {
 352         for (int i = 0; i < memberList().size(); ++i)
 353      {
 354       // only close the window if the closeEvent is accepted. If the user presses Cancel on the saveModified() dialog,
 355       // the window and the application stay open.
 356         w = memberList().at(i);
 357       if(!w->close())
 358          break;
 359 #warning "kde4: how remove it ?.???"
 360       //memberList()->removeRef(w);
 361     }
 362   }
 363 }
 364
 365 void KMouthApp::slotEditPhrasebook () {
 366    PhraseBookDialog *phraseBookDialog = PhraseBookDialog::get();
 367    // As we do not know whether the we are already connected to the slot,
 368    // we first disconnect and then connect again.
 369    disconnect (phraseBookDialog, SIGNAL(phrasebookConfirmed (PhraseBook &)),
 370                this, SLOT(slotPhrasebookConfirmed (PhraseBook &)));
 371    connect (phraseBookDialog, SIGNAL(phrasebookConfirmed (PhraseBook &)),
 372             this, SLOT(slotPhrasebookConfirmed (PhraseBook &)));
 373
 374    // As we do not know whether the phrase book edit window is already open,
 375    // we first open and then raise it, so that it is surely the top window.
 376    phraseBookDialog->show();
 377    phraseBookDialog->raise();
 378 }
 379
 380 void KMouthApp::slotViewMenuBar() {
 381    slotStatusMsg(i18n("Toggling menubar..."));
 382
 383    if(!viewMenuBar->isChecked())
 384       menuBar()->hide();
 385    else
 386       menuBar()->show();
 387
 388   slotStatusMsg(i18n("Ready."));
 389 }
 390
 391 void KMouthApp::slotViewToolBar()
 392 {
 393   slotStatusMsg(i18n("Toggling toolbar..."));
 394   ///////////////////////////////////////////////////////////////////
 395   // turn Toolbar on or off
 396   if(!viewToolBar->isChecked())
 397   {
 398     toolBar("mainToolBar")->hide();
 399   }
 400   else
 401   {
 402     toolBar("mainToolBar")->show();
 403   }
 404
 405   slotStatusMsg(i18n("Ready."));
 406 }
 407
 408 void KMouthApp::slotViewPhrasebookBar()
 409 {
 410   slotStatusMsg(i18n("Toggling phrasebook bar..."));
 411   ///////////////////////////////////////////////////////////////////
 412   // turn Toolbar on or off
 413   if(!viewPhrasebookBar->isChecked())
 414   {
 415     toolBar("phrasebookBar")->hide();
 416   }
 417   else
 418   {
 419     toolBar("phrasebookBar")->show();
 420   }
 421
 422   slotStatusMsg(i18n("Ready."));
 423 }
 424
 425 void KMouthApp::slotViewStatusBar()
 426 {
 427   slotStatusMsg(i18n("Toggle the statusbar..."));
 428   ///////////////////////////////////////////////////////////////////
 429   //turn Statusbar on or off
 430   if(!viewStatusBar->isChecked())
 431   {
 432     statusBar()->hide();
 433   }
 434   else
 435   {
 436     statusBar()->show();
 437   }
 438
 439   slotStatusMsg(i18n("Ready."));
 440 }
 441
 442 void KMouthApp::slotConfigureTTS() {
 443    phraseList->saveWordCompletion();
 444    optionsDialog->show();
 445 }
 446
 447
 448 void KMouthApp::slotStatusMsg(const QString &text)
 449 {
 450   ///////////////////////////////////////////////////////////////////
 451   // change status message permanently
 452   statusBar()->clear();
 453   statusBar()->changeItem(text, ID_STATUS_MSG);
 454 }
 455
 456 void KMouthApp::slotPhrasebookConfirmed (PhraseBook &book) {
 457    QString name = "phrasebooks";
 458    QMenu *popup = (QMenu *)factory()->container(name, this);
 459    KToolBar *toolbar = toolBar ("phrasebookBar");
 460
 461    KActionPtrList actions = phrases->actions ();
 462    KActionPtrList::iterator iter;
 463    for (iter = actions.begin(); iter != actions.end(); ++iter) {
 464       (*iter)->unplugAll();
 465    }
 466    delete phrases;
 467
 468    phrases = new KActionCollection (this, actionCollection());
 469    book.addToGUI (popup, toolbar, phrases, this, SLOT(slotPhraseSelected (const QString &)));
 470
 471    QString bookLocation = KApplication::kApplication()->dirs()->saveLocation ("appdata", "/");
 472    if (!bookLocation.isNull() && !bookLocation.isEmpty()) {
 473       book.save (KUrl::fromPathOrURL( bookLocation + "standard.phrasebook" ));
 474    }
 475 }
 476
 477 void KMouthApp::slotConfigurationChanged()
 478 {
 479    optionsDialog->saveOptions (config);
 480 }
 481
 482 void KMouthApp::slotPhraseSelected (const QString &phrase) {
 483    phraseList->insert (phrase);
 484    if (optionsDialog->isSpeakImmediately())
 485       phraseList->speak ();
 486 }
 487
 488 TextToSpeechSystem *KMouthApp::getTTSSystem() const {
 489    return optionsDialog->getTTSSystem();
 490 }
 491
 492 #include "kmouth.moc"