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