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