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