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