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