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