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