src/frontends/gnome/Dialogs.C

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