src/frontends/xforms/Dialogs.C

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