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