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