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-2001 The LyX Team.
   8  *
   9  * ======================================================
  10  */
  11
  12 #include <config.h>
  13
  14 #ifdef __GNUG__
  15 #pragma implementation
  16 #endif
  17
  18 #include "Dialogs.h"
  19
  20 #include "xformsBC.h"
  21
  22 #include "ControlAboutlyx.h"
  23 #include "ControlBibitem.h"
  24 #include "ControlBibtex.h"
  25 #include "ControlCharacter.h"
  26 #include "ControlCitation.h"
  27 #include "ControlError.h"
  28 #include "ControlExternal.h"
  29 #include "ControlGraphics.h"
  30 #include "insets/insetgraphicsParams.h"
  31 #include "ControlInclude.h"
  32 #include "ControlIndex.h"
  33 #include "ControlLog.h"
  34 #include "ControlMinipage.h"
  35 #include "ControlPreamble.h"
  36 #include "ControlPrint.h"
  37 #include "ControlRef.h"
  38 #include "ControlSearch.h"
  39 #include "ControlSpellchecker.h"
  40 #include "ControlSplash.h"
  41 #include "ControlTabularCreate.h"
  42 #include "ControlThesaurus.h"
  43 #include "ControlToc.h"
  44 #include "ControlUrl.h"
  45 #include "ControlVCLog.h"
  46
  47 #include "GUI.h"
  48
  49 #include "combox.h"       // needed for clean destruction of boost::scoped_ptr
  50 #include "form_aboutlyx.h"
  51 #include "form_bibitem.h"
  52 #include "form_bibtex.h"
  53 #include "form_browser.h"
  54 #include "form_character.h"
  55 #include "form_citation.h"
  56 #include "form_error.h"
  57 #include "form_external.h"
  58 #include "form_graphics.h"
  59 #include "form_include.h"
  60 #include "form_index.h"
  61 #include "form_minipage.h"
  62 #include "form_preamble.h"
  63 #include "form_print.h"
  64 #include "form_ref.h"
  65 #include "form_search.h"
  66 #include "form_spellchecker.h"
  67 #include "form_splash.h"
  68 #include "form_tabular_create.h"
  69 #include "form_thesaurus.h"
  70 #include "form_toc.h"
  71 #include "form_url.h"
  72
  73 #include "FormAboutlyx.h"
  74 #include "FormBibitem.h"
  75 #include "FormBibtex.h"
  76 #include "FormCharacter.h"
  77 #include "FormCitation.h"
  78 #include "FormError.h"
  79 #include "FormExternal.h"
  80 #include "FormGraphics.h"
  81 #include "FormInclude.h"
  82 #include "FormIndex.h"
  83 #include "FormLog.h"
  84 #include "FormMinipage.h"
  85 #include "FormPreamble.h"
  86 #include "FormPrint.h"
  87 #include "FormRef.h"
  88 #include "FormSearch.h"
  89 #include "FormSpellchecker.h"
  90 #include "FormSplash.h"
  91 #include "FormTabularCreate.h"
  92 #include "FormThesaurus.h"
  93 #include "FormToc.h"
  94 #include "FormUrl.h"
  95 #include "FormVCLog.h"
  96
  97 #include "FormDocument.h"
  98 #include "FormMathsPanel.h"
  99 #include "FormParagraph.h"
 100 #include "FormPreferences.h"
 101 #include "FormTabular.h"
 102
 103 // Signal enabling all visible dialogs to be redrawn if so desired.
 104 // E.g., when the GUI colours have been remapped.
 105 SigC::Signal0<void> Dialogs::redrawGUI;
 106
 107 Dialogs::Dialogs(LyXView * lv)
 108 {
 109         splash_.reset(new GUISplash<FormSplash>(*this));
 110
 111         add(new GUIAboutlyx<FormAboutlyx, xformsBC>(*lv, *this));
 112         add(new GUIBibitem<FormBibitem, xformsBC>(*lv, *this));
 113         add(new GUIBibtex<FormBibtex, xformsBC>(*lv, *this));
 114         add(new GUICharacter<FormCharacter, xformsBC>(*lv, *this));
 115         add(new GUICitation<FormCitation, xformsBC>(*lv, *this));
 116         add(new GUIError<FormError, xformsBC>(*lv, *this));
 117         add(new GUIExternal<FormExternal, xformsBC>(*lv, *this));
 118         add(new GUIGraphics<FormGraphics, xformsBC>(*lv, *this));
 119         add(new GUIInclude<FormInclude, xformsBC>(*lv, *this));
 120         add(new GUIIndex<FormIndex, xformsBC>(*lv, *this));
 121         add(new GUILog<FormLog, xformsBC>(*lv, *this));
 122         add(new GUIMinipage<FormMinipage, xformsBC>(*lv, *this));
 123         add(new GUIPreamble<FormPreamble, xformsBC>(*lv, *this));
 124         add(new GUIPrint<FormPrint, xformsBC>(*lv, *this));
 125         add(new GUIRef<FormRef, xformsBC>(*lv, *this));
 126         add(new GUISearch<FormSearch, xformsBC>(*lv, *this));
 127         add(new GUISpellchecker<FormSpellchecker, xformsBC>(*lv, *this));
 128         add(new GUITabularCreate<FormTabularCreate, xformsBC>(*lv, *this));
 129 #ifdef HAVE_LIBAIKSAURUS
 130         add(new GUIThesaurus<FormThesaurus, xformsBC>(*lv, *this));
 131 #endif
 132         add(new GUIToc<FormToc, xformsBC>(*lv, *this));
 133         add(new GUIUrl<FormUrl, xformsBC>(*lv, *this));
 134         add(new GUIVCLog<FormVCLog, xformsBC>(*lv, *this));
 135
 136         add(new FormDocument(lv, this));
 137         add(new FormMathsPanel(lv, this));
 138         add(new FormParagraph(lv, this));
 139         add(new FormPreferences(lv, this));
 140         add(new FormTabular(lv, this));
 141
 142         // reduce the number of connections needed in
 143         // dialogs by a simple connection here.
 144         hideAll.connect(hideBufferDependent.slot());
 145 }
 146
 147 /*****************************************************************************
 148
 149 Q.  WHY does Dialogs::Dialogs pass `this' to dialog constructors?
 150
 151 A.  To avoid a segfault.
 152     The dialog constructors need to connect to their
 153     respective showSomeDialog signal(*) but in order to do
 154     that they need to get the address of the Dialogs instance
 155     from LyXView::getDialogs().  However, since the Dialogs
 156     instance is still being constructed at that time
 157     LyXView::getDialogs() will *not* return the correct
 158     address because it hasn't finished being constructed.
 159     A Catch-22 situation (or is that the chicken and the egg...).
 160     So to get around the problem we pass the address of
 161     the newly created Dialogs instance using `this'.
 162
 163 (*) -- I'm using signals exclusively to guarantee that the gui code
 164        remains hidden from the rest of the system.  In fact the only
 165        header related to dialogs that anything in the non-gui-specific
 166        code gets to see is Dialogs.h!  Even Dialogs.h doesn't know what a
 167        FormCopyright class looks like or that its even going to be used!
 168
 169        No other gui dialog headers are seen outside of the gui-specific
 170        directories!  This ensures that the gui is completely separate from
 171        the rest of LyX.  All this through the use of a few simple signals.
 172        BUT, the price is that during construction we need to connect the
 173        implementations show() method to the showSomeDialog signal and this
 174        requires that we have an instance of Dialogs and the problem mentioned
 175        above.
 176
 177        Almost all other dialogs should be able to operate using the same style
 178        of signalling used for Copyright.  Exceptions should be handled
 179        by adding a specific show or update signal.  For example, spellchecker
 180        needs to set the next suspect word and its options/replacements so we
 181        need a:
 182                  Signal0<void> updateSpellChecker;
 183
 184        Since we would have to have a
 185                  Signal0<void> showSpellChecker;
 186
 187        in order to just see the spellchecker and let the user push the [Start]
 188        button then the updateSpellChecker signal will make the SpellChecker
 189        dialog get the new word and replacements list from LyX.  If you really,
 190        really wanted to you could define a signal that would pass the new
 191        word and replacements:
 192                  Signal2<void, string, vector<string> > updateSpellChecker;
 193
 194        (or something similar) but, why bother when the spellchecker can get
 195        it anyway with a LyXFunc call or two.  Besides if someone extends
 196        what a dialog does then they also have to change code in the rest of
 197        LyX to pass more parameters or get the extra info via a function
 198        call anyway.  Thus reducing the independence of the two code bases.
 199
 200        We don't need a separate update signal for each dialog because most of
 201        them will be changed only when the buffer is changed (either by closing
 202        the current open buffer or switching to another buffer in the current
 203        LyXView -- different BufferView same LyXView or same BufferView same
 204        LyXView).
 205
 206        So we minimise signals but maximise independence and programming
 207        simplicity, understandability and maintainability.  It's also
 208        extremely easy to add support for Qt or gtk-- because they use
 209        signals already. Guis that use callbacks, like xforms, must have their
 210        code wrapped up like that in the form_copyright.[Ch] which is awkward
 211        but will at least allow multiple instances of the same dialog.
 212
 213        Signals will also be a great help in controlling the splashscreen --
 214        once signalled to hide it can disconnect from the signal and remove
 215        itself from memory.
 216
 217        LyXFuncs will be used for requesting/setting LyX internal info.  This
 218        will ensure that scripts or LyXServer-connected applications can all
 219        have access to the same calls as the internal user-interface.
 220
 221 ******************************************************************************/