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 "ControlBibitem.h"
23 #include "ControlBibtex.h"
24 #include "ControlCharacter.h"
25 #include "ControlCitation.h"
26 #include "ControlCopyright.h"
27 #include "ControlCredits.h"
28 #include "ControlError.h"
29 #include "ControlExternal.h"
30 #include "ControlGraphics.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 "ControlSplash.h"
40 #include "ControlTabularCreate.h"
41 #include "ControlToc.h"
42 #include "ControlUrl.h"
43 #include "ControlVCLog.h"
47 #include "combox.h" // needed for clean destruction of boost::scoped_ptr
48 #include "form_bibitem.h"
49 #include "form_bibtex.h"
50 #include "form_browser.h"
51 #include "form_character.h"
52 #include "form_citation.h"
53 #include "form_copyright.h"
54 #include "form_credits.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_splash.h"
66 #include "form_tabular_create.h"
70 #include "FormBibitem.h"
71 #include "FormBibtex.h"
72 #include "FormCharacter.h"
73 #include "FormCitation.h"
74 #include "FormCopyright.h"
75 #include "FormCredits.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 "FormSplash.h"
88 #include "FormTabularCreate.h"
91 #include "FormVCLog.h"
93 #include "FormDocument.h"
94 #include "FormMathsPanel.h"
95 #include "FormParagraph.h"
96 #include "FormPreferences.h"
97 #include "FormTabular.h"
99 // Signal enabling all visible dialogs to be redrawn if so desired.
100 // E.g., when the GUI colours have been remapped.
101 SigC::Signal0<void> Dialogs::redrawGUI;
103 Dialogs::Dialogs(LyXView * lv)
105 splash_.reset(new GUISplash<FormSplash>(*this));
107 add(new GUIBibitem<FormBibitem, xformsBC>(*lv, *this));
108 add(new GUIBibtex<FormBibtex, xformsBC>(*lv, *this));
109 add(new GUICharacter<FormCharacter, xformsBC>(*lv, *this));
110 add(new GUICitation<FormCitation, xformsBC>(*lv, *this));
111 add(new GUICopyright<FormCopyright, xformsBC>(*lv, *this));
112 add(new GUICredits<FormCredits, 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 GUITabularCreate<FormTabularCreate, xformsBC>(*lv, *this));
125 add(new GUIToc<FormToc, xformsBC>(*lv, *this));
126 add(new GUIUrl<FormUrl, xformsBC>(*lv, *this));
127 add(new GUIVCLog<FormVCLog, xformsBC>(*lv, *this));
129 add(new FormDocument(lv, this));
130 add(new FormMathsPanel(lv, this));
131 add(new FormParagraph(lv, this));
132 add(new FormPreferences(lv, this));
133 add(new FormTabular(lv, this));
135 // reduce the number of connections needed in
136 // dialogs by a simple connection here.
137 hideAll.connect(hideBufferDependent.slot());
140 /*****************************************************************************
142 Q. WHY does Dialogs::Dialogs pass `this' to dialog constructors?
144 A. To avoid a segfault.
145 The dialog constructors need to connect to their
146 respective showSomeDialog signal(*) but in order to do
147 that they need to get the address of the Dialogs instance
148 from LyXView::getDialogs(). However, since the Dialogs
149 instance is still being constructed at that time
150 LyXView::getDialogs() will *not* return the correct
151 address because it hasn't finished being constructed.
152 A Catch-22 situation (or is that the chicken and the egg...).
153 So to get around the problem we pass the address of
154 the newly created Dialogs instance using `this'.
156 (*) -- I'm using signals exclusively to guarantee that the gui code
157 remains hidden from the rest of the system. In fact the only
158 header related to dialogs that anything in the non-gui-specific
159 code gets to see is Dialogs.h! Even Dialogs.h doesn't know what a
160 FormCopyright class looks like or that its even going to be used!
162 No other gui dialog headers are seen outside of the gui-specific
163 directories! This ensures that the gui is completely separate from
164 the rest of LyX. All this through the use of a few simple signals.
165 BUT, the price is that during construction we need to connect the
166 implementations show() method to the showSomeDialog signal and this
167 requires that we have an instance of Dialogs and the problem mentioned
170 Almost all other dialogs should be able to operate using the same style
171 of signalling used for Copyright. Exceptions should be handled
172 by adding a specific show or update signal. For example, spellchecker
173 needs to set the next suspect word and its options/replacements so we
175 Signal0<void> updateSpellChecker;
177 Since we would have to have a
178 Signal0<void> showSpellChecker;
180 in order to just see the spellchecker and let the user push the [Start]
181 button then the updateSpellChecker signal will make the SpellChecker
182 dialog get the new word and replacements list from LyX. If you really,
183 really wanted to you could define a signal that would pass the new
184 word and replacements:
185 Signal2<void, string, vector<string> > updateSpellChecker;
187 (or something similar) but, why bother when the spellchecker can get
188 it anyway with a LyXFunc call or two. Besides if someone extends
189 what a dialog does then they also have to change code in the rest of
190 LyX to pass more parameters or get the extra info via a function
191 call anyway. Thus reducing the independence of the two code bases.
193 We don't need a separate update signal for each dialog because most of
194 them will be changed only when the buffer is changed (either by closing
195 the current open buffer or switching to another buffer in the current
196 LyXView -- different BufferView same LyXView or same BufferView same
199 So we minimise signals but maximise independence and programming
200 simplicity, understandability and maintainability. It's also
201 extremely easy to add support for Qt or gtk-- because they use
202 signals already. Guis that use callbacks, like xforms, must have their
203 code wrapped up like that in the form_copyright.[Ch] which is awkward
204 but will at least allow multiple instances of the same dialog.
206 Signals will also be a great help in controlling the splashscreen --
207 once signalled to hide it can disconnect from the signal and remove
210 LyXFuncs will be used for requesting/setting LyX internal info. This
211 will ensure that scripts or LyXServer-connected applications can all
212 have access to the same calls as the internal user-interface.
214 ******************************************************************************/