src/frontends/qt4/GuiPrefs.h

   1 // -*- C++ -*-
   2 /**
   3  * \file GuiPrefs.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author John Levon
   8  * \author Bo Peng
   9  * \author Edwin Leuven
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #ifndef GUIPREFS_H
  15 #define GUIPREFS_H
  16
  17 #include "GuiDialog.h"
  18
  19 #include "Converter.h"
  20 #include "Format.h"
  21 #include "KeyMap.h"
  22 #include "LyXRC.h"
  23 #include "Mover.h"
  24
  25 #include "ui_PrefsUi.h"
  26
  27 #include "ui_PrefOutputUi.h"
  28 #include "ui_PrefInputUi.h"
  29 #include "ui_PrefLatexUi.h"
  30 #include "ui_PrefScreenFontsUi.h"
  31 #include "ui_PrefCompletionUi.h"
  32 #include "ui_PrefColorsUi.h"
  33 #include "ui_PrefDisplayUi.h"
  34 #include "ui_PrefDocHandlingUi.h"
  35 #include "ui_PrefEditUi.h"
  36 #include "ui_PrefPathsUi.h"
  37 #include "ui_PrefShortcutsUi.h"
  38 #include "ui_PrefSpellcheckerUi.h"
  39 #include "ui_PrefConvertersUi.h"
  40 #include "ui_PrefFileformatsUi.h"
  41 #include "ui_PrefLanguageUi.h"
  42 #include "ui_PrefUi.h"
  43 #include "ui_PrefIdentityUi.h"
  44 #include "ui_ShortcutUi.h"
  45
  46 #include <string>
  47 #include <vector>
  48
  49
  50 namespace lyx {
  51
  52 class Converters;
  53 class Formats;
  54 class Movers;
  55
  56 namespace frontend {
  57
  58 class PrefModule;
  59
  60 class GuiPreferences : public GuiDialog, public Ui::PrefsUi
  61 {
  62         Q_OBJECT
  63 public:
  64         GuiPreferences(GuiView & lv);
  65
  66         void applyRC(LyXRC & rc) const;
  67         void updateRC(LyXRC const & rc);
  68
  69 public Q_SLOTS:
  70         void change_adaptor();
  71
  72 Q_SIGNALS:
  73         void prefsApplied(LyXRC const & rc);
  74
  75 public:
  76         /// Apply changes
  77         void applyView();
  78
  79         std::vector<PrefModule *> modules_;
  80
  81         ///
  82         bool initialiseParams(std::string const &);
  83         ///
  84         void clearParams() {}
  85         ///
  86         void dispatchParams();
  87         ///
  88         bool isBufferDependent() const { return false; }
  89
  90         /// various file pickers
  91         QString browsebind(QString const & file) const;
  92         QString browseUI(QString const & file) const;
  93         QString browsekbmap(QString const & file) const;
  94
  95         /// general browse
  96         QString browse(QString const & file, QString const & title) const;
  97
  98         /// set a color
  99         void setColor(ColorCode col, QString const & hex);
 100
 101         /// update the screen fonts after change
 102         void updateScreenFonts();
 103
 104         /// update the previews after change
 105         void updatePreviews();
 106
 107         LyXRC & rc() { return rc_; }
 108         Converters & converters() { return converters_; }
 109         Formats & formats() { return formats_; }
 110         Movers & movers() { return movers_; }
 111
 112 private:
 113         ///
 114         void addModule(PrefModule * module);
 115
 116         /// temporary lyxrc
 117         LyXRC rc_;
 118         /// temporary converters
 119         Converters converters_;
 120         /// temporary formats
 121         Formats formats_;
 122         /// temporary movers
 123         Movers movers_;
 124
 125         /// A list of colors to be dispatched
 126         std::vector<std::string> colors_;
 127
 128         bool update_screen_font_;
 129         bool update_previews_;
 130 };
 131
 132
 133 class PrefModule : public QWidget
 134 {
 135         Q_OBJECT
 136 public:
 137         PrefModule(QString const & cat, QString const & t,
 138                         GuiPreferences * form)
 139                 : QWidget(form), category_(cat), title_(t), form_(form)
 140         {}
 141
 142         virtual void applyRC(LyXRC & rc) const = 0;
 143         virtual void updateRC(LyXRC const & rc) = 0;
 144
 145         QString const & category() const { return category_; }
 146         QString const & title() const { return title_; }
 147
 148 protected:
 149         QString category_;
 150         QString title_;
 151         GuiPreferences * form_;
 152
 153 Q_SIGNALS:
 154         void changed();
 155 };
 156
 157
 158 class PrefOutput : public PrefModule, public Ui::PrefOutputUi
 159 {
 160         Q_OBJECT
 161 public:
 162         PrefOutput(GuiPreferences * form);
 163
 164         virtual void applyRC(LyXRC & rc) const;
 165         virtual void updateRC(LyXRC const & rc);
 166
 167 private Q_SLOTS:
 168         void on_DateED_textChanged(const QString &);
 169 };
 170
 171
 172 class PrefInput : public PrefModule, public Ui::PrefInputUi
 173 {
 174         Q_OBJECT
 175 public:
 176         PrefInput(GuiPreferences * form);
 177
 178         virtual void applyRC(LyXRC & rc) const;
 179         virtual void updateRC(LyXRC const & rc);
 180
 181 private Q_SLOTS:
 182         void on_firstKeymapPB_clicked(bool);
 183         void on_secondKeymapPB_clicked(bool);
 184         void on_keymapCB_toggled(bool);
 185         void on_scrollzoomEnableCB_toggled(bool);
 186
 187 private:
 188         QString testKeymap(QString const & keymap);
 189 };
 190
 191
 192 class PrefCompletion : public PrefModule, public Ui::PrefCompletionUi
 193 {
 194         Q_OBJECT
 195 public:
 196         PrefCompletion(GuiPreferences * form);
 197
 198         virtual void applyRC(LyXRC & rc) const;
 199         virtual void updateRC(LyXRC const & rc);
 200         virtual void enableCB();
 201 private Q_SLOTS:
 202         void on_popupTextCB_clicked();
 203         void on_inlineTextCB_clicked();
 204 };
 205
 206
 207 class PrefLatex : public PrefModule, public Ui::PrefLatexUi
 208 {
 209         Q_OBJECT
 210 public:
 211         PrefLatex(GuiPreferences * form);
 212
 213         virtual void applyRC(LyXRC & rc) const;
 214         virtual void updateRC(LyXRC const & rc);
 215
 216 private Q_SLOTS:
 217         void on_latexEncodingCB_stateChanged(int state);
 218         void on_latexBibtexCO_activated(int n);
 219         void on_latexIndexCO_activated(int n);
 220
 221 private:
 222         ///
 223         std::set<std::string> bibtex_alternatives;
 224         ///
 225         std::set<std::string> index_alternatives;
 226 };
 227
 228
 229 class PrefScreenFonts : public PrefModule, public Ui::PrefScreenFontsUi
 230 {
 231         Q_OBJECT
 232 public:
 233         PrefScreenFonts(GuiPreferences * form);
 234
 235         virtual void applyRC(LyXRC & rc) const;
 236         virtual void updateRC(LyXRC const & rc);
 237
 238 private Q_SLOTS:
 239         void selectRoman(const QString&);
 240         void selectSans(const QString&);
 241         void selectTypewriter(const QString&);
 242
 243 public Q_SLOTS:
 244         void updateScreenFontSizes(LyXRC const & rc);
 245 };
 246
 247
 248 class PrefColors : public PrefModule, public Ui::PrefColorsUi
 249 {
 250         Q_OBJECT
 251 public:
 252         PrefColors(GuiPreferences * form);
 253
 254         void applyRC(LyXRC & rc) const;
 255         void updateRC(LyXRC const & rc);
 256
 257 private Q_SLOTS:
 258         void changeColor();
 259         void changeSysColor();
 260         void changeLyxObjectsSelection();
 261
 262 private:
 263         std::vector<ColorCode> lcolors_;
 264         std::vector<QString> curcolors_;
 265         std::vector<QString> newcolors_;
 266 };
 267
 268
 269 class PrefDisplay : public PrefModule, public Ui::PrefDisplayUi
 270 {
 271         Q_OBJECT
 272 public:
 273         PrefDisplay(GuiPreferences * form);
 274
 275         void applyRC(LyXRC & rc) const;
 276         void updateRC(LyXRC const & rc);
 277
 278 private Q_SLOTS:
 279         void on_instantPreviewCO_currentIndexChanged(int);
 280 };
 281
 282
 283 class PrefPaths : public PrefModule, public Ui::PrefPathsUi
 284 {
 285         Q_OBJECT
 286 public:
 287         PrefPaths(GuiPreferences * form);
 288
 289         void applyRC(LyXRC & rc) const;
 290         void updateRC(LyXRC const & rc);
 291
 292 private Q_SLOTS:
 293         void selectExampledir();
 294         void selectTemplatedir();
 295         void selectTempdir();
 296         void selectBackupdir();
 297         void selectWorkingdir();
 298         void selectThesaurusdir();
 299         void selectHunspelldir();
 300         void selectLyxPipe();
 301
 302 };
 303
 304
 305 class PrefSpellchecker : public PrefModule, public Ui::PrefSpellcheckerUi
 306 {
 307         Q_OBJECT
 308 public:
 309         PrefSpellchecker(GuiPreferences * form);
 310
 311         void applyRC(LyXRC & rc) const;
 312         void updateRC(LyXRC const & rc);
 313
 314 private Q_SLOTS:
 315         void on_spellcheckerCB_currentIndexChanged(int);
 316 };
 317
 318
 319 class PrefConverters : public PrefModule, public Ui::PrefConvertersUi
 320 {
 321         Q_OBJECT
 322 public:
 323         PrefConverters(GuiPreferences * form);
 324
 325         void applyRC(LyXRC & rc) const;
 326         void updateRC(LyXRC const & rc);
 327
 328 public Q_SLOTS:
 329         void updateGui();
 330
 331 private Q_SLOTS:
 332         void updateConverter();
 333         void switchConverter();
 334         void removeConverter();
 335         void changeConverter();
 336         void on_cacheCB_stateChanged(int state);
 337         void on_needauthForbiddenCB_toggled(bool);
 338
 339 private:
 340         void updateButtons();
 341 };
 342
 343
 344 class PrefFileformats : public PrefModule, public Ui::PrefFileformatsUi
 345 {
 346         Q_OBJECT
 347 public:
 348         PrefFileformats(GuiPreferences * form);
 349
 350         void applyRC(LyXRC & rc) const;
 351         void updateRC(LyXRC const & rc);
 352         void updateView();
 353
 354 Q_SIGNALS:
 355         void formatsChanged();
 356
 357 private Q_SLOTS:
 358         void on_copierED_textEdited(const QString & s);
 359         void on_extensionsED_textEdited(const QString &);
 360         void on_viewerED_textEdited(const QString &);
 361         void on_editorED_textEdited(const QString &);
 362         void on_mimeED_textEdited(const QString &);
 363         void on_shortcutED_textEdited(const QString &);
 364         void on_formatED_editingFinished();
 365         void on_formatED_textChanged(const QString &);
 366         void on_formatsCB_currentIndexChanged(int);
 367         void on_formatsCB_editTextChanged(const QString &);
 368         void on_formatNewPB_clicked();
 369         void on_formatRemovePB_clicked();
 370         void on_viewerCO_currentIndexChanged(int i);
 371         void on_editorCO_currentIndexChanged(int i);
 372         void setFlags();
 373         void updatePrettyname();
 374
 375 private:
 376         Format & currentFormat();
 377         ///
 378         void updateViewers();
 379         ///
 380         void updateEditors();
 381         ///
 382         LyXRC::Alternatives viewer_alternatives;
 383         ///
 384         LyXRC::Alternatives editor_alternatives;
 385 };
 386
 387
 388 class PrefLanguage : public PrefModule, public Ui::PrefLanguageUi
 389 {
 390         Q_OBJECT
 391 public:
 392         PrefLanguage(GuiPreferences * form);
 393
 394         void applyRC(LyXRC & rc) const;
 395         void updateRC(LyXRC const & rc);
 396
 397 private Q_SLOTS:
 398         void on_uiLanguageCO_currentIndexChanged(int);
 399         void on_languagePackageCO_currentIndexChanged(int);
 400 };
 401
 402
 403 class PrefUserInterface : public PrefModule, public Ui::PrefUi
 404 {
 405         Q_OBJECT
 406 public:
 407         PrefUserInterface(GuiPreferences * form);
 408
 409         void applyRC(LyXRC & rc) const;
 410         void updateRC(LyXRC const & rc);
 411
 412 public Q_SLOTS:
 413         void selectUi();
 414 };
 415
 416
 417 class PrefDocHandling : public PrefModule, public Ui::PrefDocHandlingUi
 418 {
 419         Q_OBJECT
 420 public:
 421         PrefDocHandling(GuiPreferences * form);
 422
 423         void applyRC(LyXRC & rc) const;
 424         void updateRC(LyXRC const & rc);
 425
 426 public Q_SLOTS:
 427         void on_clearSessionPB_clicked();
 428 };
 429
 430
 431
 432 class PrefEdit : public PrefModule, public Ui::PrefEditUi
 433 {
 434         Q_OBJECT
 435 public:
 436         PrefEdit(GuiPreferences * form);
 437
 438         void applyRC(LyXRC & rc) const;
 439         void updateRC(LyXRC const & rc);
 440 };
 441
 442
 443
 444 class GuiShortcutDialog : public QDialog, public Ui::shortcutUi
 445 {
 446 public:
 447         GuiShortcutDialog(QWidget * parent);
 448 };
 449
 450
 451 class PrefShortcuts : public PrefModule, public Ui::PrefShortcuts
 452 {
 453         Q_OBJECT
 454 public:
 455         PrefShortcuts(GuiPreferences * form);
 456
 457         void applyRC(LyXRC & rc) const;
 458         void updateRC(LyXRC const & rc);
 459         void updateShortcutsTW();
 460
 461 public Q_SLOTS:
 462         void selectBind();
 463         void on_modifyPB_pressed();
 464         void on_newPB_pressed();
 465         void on_removePB_pressed();
 466         void on_searchLE_textEdited();
 467         ///
 468         void on_shortcutsTW_itemSelectionChanged();
 469         void on_shortcutsTW_itemDoubleClicked();
 470         ///
 471         void shortcutOkPressed();
 472         void shortcutCancelPressed();
 473         void shortcutClearPressed();
 474         void shortcutRemovePressed();
 475
 476 private:
 477         void modifyShortcut();
 478         /// remove selected binding, restore default value
 479         void removeShortcut();
 480         /// remove bindings, do not restore default values
 481         void deactivateShortcuts(QList<QTreeWidgetItem*> const & items);
 482         /// check the new binding k->func, and remove existing bindings to k after
 483         /// asking the user. We exclude lfun_to_modify from this test: we assume
 484         /// that if the user clicked "modify" then they agreed to modify the
 485         /// binding. Returns false if the shortcut is invalid or the user cancels.
 486         bool validateNewShortcut(FuncRequest const & func,
 487                                  KeySequence const & k,
 488                                  QString const & lfun_to_modify);
 489         /// compute current active shortcut
 490         FuncRequest currentBinding(KeySequence const & k);
 491         ///
 492         void setItemType(QTreeWidgetItem * item, KeyMap::ItemType tag);
 493         ///
 494         static KeyMap::ItemType itemType(QTreeWidgetItem & item);
 495         /// some items need to be always hidden, for instance empty rebound
 496         /// system keys
 497         static bool isAlwaysHidden(QTreeWidgetItem & item);
 498         /// unhide an empty system binding that may have been hidden
 499         /// returns either null or the unhidden shortcut
 500         void unhideEmpty(QString const & lfun, bool select);
 501         ///
 502         QTreeWidgetItem * insertShortcutItem(FuncRequest const & lfun,
 503                 KeySequence const & shortcut, KeyMap::ItemType tag);
 504         ///
 505         GuiShortcutDialog * shortcut_;
 506         ///
 507         ButtonController shortcut_bc_;
 508         /// category items
 509         QTreeWidgetItem * editItem_;
 510         QTreeWidgetItem * mathItem_;
 511         QTreeWidgetItem * bufferItem_;
 512         QTreeWidgetItem * layoutItem_;
 513         QTreeWidgetItem * systemItem_;
 514         // system_bind_ holds bindings from rc.bind_file
 515         // user_bind_ holds \bind bindings from user.bind
 516         // user_unbind_ holds \unbind bindings from user.bind
 517         // When an item is inserted, it is added to user_bind_
 518         // When an item from system_bind_ is deleted, it is added to user_unbind_
 519         // When an item in user_bind_ or user_unbind_ is deleted, it is
 520         //      deleted (unbind)
 521         KeyMap system_bind_;
 522         KeyMap user_bind_;
 523         KeyMap user_unbind_;
 524         ///
 525         QString save_lfun_;
 526 };
 527
 528
 529 class PrefIdentity : public PrefModule, public Ui::PrefIdentityUi
 530 {
 531         Q_OBJECT
 532 public:
 533         PrefIdentity(GuiPreferences * form);
 534
 535         void applyRC(LyXRC & rc) const;
 536         void updateRC(LyXRC const & rc);
 537 };
 538
 539
 540 } // namespace frontend
 541 } // namespace lyx
 542
 543 #endif // GUIPREFS_H