src/frontends/gnome/Dialogs.C

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