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