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