src/frontends/kde/Dialogs.C

   1 #include <config.h>
   2 #include FORMS_H_LOCATION
   3
   4 #include "Dialogs.h"
   5 #include "FormCitation.h"
   6 #include "FormCopyright.h"
   7 #include "FormDocument.h"
   8 #include "FormError.h"
   9 #include "FormGraphics.h"
  10 #include "FormIndex.h"
  11 #include "FormPreferences.h"
  12 #include "FormPrint.h"
  13 #include "FormRef.h"
  14 #include "FormTabular.h"
  15 #include "FormToc.h"
  16 #include "FormUrl.h"
  17
  18 #ifdef __GNUG__
  19 #pragma implementation
  20 #endif
  21
  22 // temporary till ported
  23 extern void ShowCredits();
  24
  25
  26 Dialogs::Dialogs(LyXView * lv)
  27 {
  28         dialogs_.push_back(new FormCitation(lv, this));
  29         dialogs_.push_back(new FormCopyright(lv, this));
  30         dialogs_.push_back(new FormDocument(lv, this));
  31         dialogs_.push_back(new FormError(lv, this));
  32         dialogs_.push_back(new FormGraphics(lv, this));
  33         dialogs_.push_back(new FormIndex(lv, this));
  34         dialogs_.push_back(new FormPreferences(lv, this));
  35         dialogs_.push_back(new FormPrint(lv, this));
  36         dialogs_.push_back(new FormRef(lv, this));
  37         dialogs_.push_back(new FormTabular(lv, this));
  38         dialogs_.push_back(new FormToc(lv, this));
  39         dialogs_.push_back(new FormUrl(lv, this));
  40
  41         showCredits.connect(slot(ShowCredits));
  42
  43         // reduce the number of connections needed in
  44         // dialogs by a simple connection here.
  45         hideAll.connect(hideBufferDependent.slot());
  46 }
  47
  48 Dialogs::~Dialogs()
  49 {
  50         for (vector<DialogBase *>::iterator iter = dialogs_.begin();
  51              iter != dialogs_.end();
  52              ++iter) {
  53                 delete *iter;
  54         }
  55 }
  56
  57
  58 /*****************************************************************************
  59
  60 Q.  WHY does Dialogs::Dialogs pass `this' to dialog constructors?
  61
  62 A.  To avoid a segfault.
  63     The dialog constructors need to connect to their
  64     respective showSomeDialog signal(*) but in order to do
  65     that they need to get the address of the Dialogs instance
  66     from LyXView::getDialogs().  However, since the Dialogs
  67     instance is still being constructed at that time
  68     LyXView::getDialogs() will *not* return the correct
  69     address because it hasn't finished being constructed.
  70     A Catch-22 situation (or is that the chicken and the egg...).
  71     So to get around the problem we pass the address of
  72     the newly created Dialogs instance using `this'.
  73
  74 (*) -- I'm using signals exclusively to guarantee that the gui code
  75        remains hidden from the rest of the system.  In fact the only
  76        header related to dialogs that anything in the non-gui-specific
  77        code gets to see is Dialogs.h!  Even Dialogs.h doesn't know what a
  78        FormCopyright class looks like or that its even going to be used!
  79
  80        No other gui dialog headers are seen outside of the gui-specific
  81        directories!  This ensures that the gui is completely separate from
  82        the rest of LyX.  All this through the use of a few simple signals.
  83        BUT, the price is that during construction we need to connect the
  84        implementations show() method to the showSomeDialog signal and this
  85        requires that we have an instance of Dialogs and the problem mentioned
  86        above.
  87
  88        Almost all other dialogs should be able to operate using the same style
  89        of signalling used for Copyright.  Exceptions should be handled
  90        by adding a specific show or update signal.  For example, spellchecker
  91        needs to set the next suspect word and its options/replacements so we
  92        need a:
  93                  Signal0<void> updateSpellChecker;
  94
  95        Since we would have to have a
  96                  Signal0<void> showSpellChecker;
  97
  98        in order to just see the spellchecker and let the user push the [Start]
  99        button then the updateSpellChecker signal will make the SpellChecker
 100        dialog get the new word and replacements list from LyX.  If you really,
 101        really wanted to you could define a signal that would pass the new
 102        word and replacements:
 103                  Signal2<void, string, vector<string> > updateSpellChecker;
 104
 105        (or something similar) but, why bother when the spellchecker can get
 106        it anyway with a LyXFunc call or two.  Besides if someone extends
 107        what a dialog does then they also have to change code in the rest of
 108        LyX to pass more parameters or get the extra info via a function
 109        call anyway.  Thus reducing the independence of the two code bases.
 110
 111        We don't need a separate update signal for each dialog because most of
 112        them will be changed only when the buffer is changed (either by closing
 113        the current open buffer or switching to another buffer in the current
 114        LyXView -- different BufferView same LyXView or same BufferView same
 115        LyXView).
 116
 117        So we minimise signals but maximise independence and programming
 118        simplicity, understandability and maintainability.  It's also
 119        extremely easy to add support for Qt or gtk-- because they use
 120        signals already. Guis that use callbacks, like xforms, must have their
 121        code wrapped up like that in the form_copyright.[Ch] which is awkward
 122        but will at least allow multiple instances of the same dialog.
 123
 124        Signals will also be a great help in controlling the splashscreen --
 125        once signalled to hide it can disconnect from the signal and remove
 126        itself from memory.
 127
 128        LyXFuncs will be used for requesting/setting LyX internal info.  This
 129        will ensure that scripts or LyXServer-connected applications can all
 130        have access to the same calls as the internal user-interface.
 131
 132 ******************************************************************************/