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 "ControlInclude.h"
30 #include "ControlLog.h"
31 #include "ControlPrint.h"
32 #include "ControlRef.h"
33 #include "ControlSearch.h"
34 #include "ControlSplash.h"
35 #include "ControlTabularCreate.h"
36 #include "ControlUrl.h"
37 #include "ControlVCLog.h"
41 #include "combox.h" // needed for clean destruction of boost::scoped_ptr
42 #include "form_bibitem.h"
43 #include "form_bibtex.h"
44 #include "form_browser.h"
45 #include "form_character.h"
46 #include "form_citation.h"
47 #include "form_copyright.h"
48 #include "form_credits.h"
49 #include "form_error.h"
50 #include "form_include.h"
51 #include "form_print.h"
53 #include "form_search.h"
54 #include "form_splash.h"
55 #include "form_tabular_create.h"
58 #include "FormBibitem.h"
59 #include "FormBibtex.h"
60 #include "FormCharacter.h"
61 #include "FormCitation.h"
62 #include "FormCopyright.h"
63 #include "FormCredits.h"
64 #include "FormError.h"
65 #include "FormInclude.h"
67 #include "FormPrint.h"
69 #include "FormSearch.h"
70 #include "FormSplash.h"
71 #include "FormTabularCreate.h"
73 #include "FormVCLog.h"
75 #include "FormDocument.h"
76 #include "FormExternal.h"
77 #include "FormGraphics.h"
78 #include "FormIndex.h"
79 #include "FormMathsPanel.h"
80 #include "FormParagraph.h"
81 #include "FormPreamble.h"
82 #include "FormPreferences.h"
83 #include "FormTabular.h"
85 #include "FormMinipage.h"
87 // Signal enabling all visible popups to be redrawn if so desired.
88 // E.g., when the GUI colours have been remapped.
89 SigC::Signal0<void> Dialogs::redrawGUI;
91 Dialogs::Dialogs(LyXView * lv)
93 splash_.reset(new GUISplash<FormSplash>(*this));
95 add(new GUIBibitem<FormBibitem, xformsBC>(*lv, *this));
96 add(new GUIBibtex<FormBibtex, xformsBC>(*lv, *this));
97 add(new GUICharacter<FormCharacter, xformsBC>(*lv, *this));
98 add(new GUICitation<FormCitation, xformsBC>(*lv, *this));
99 add(new GUICopyright<FormCopyright, xformsBC>(*lv, *this));
100 add(new GUICredits<FormCredits, xformsBC>(*lv, *this));
101 add(new GUIError<FormError, xformsBC>(*lv, *this));
102 add(new GUIInclude<FormInclude, xformsBC>(*lv, *this));
103 add(new GUILog<FormLog, xformsBC>(*lv, *this));
104 add(new GUIPrint<FormPrint, xformsBC>(*lv, *this));
105 add(new GUIRef<FormRef, xformsBC>(*lv, *this));
106 add(new GUISearch<FormSearch, xformsBC>(*lv, *this));
107 add(new GUITabularCreate<FormTabularCreate, xformsBC>(*lv, *this));
108 add(new GUIUrl<FormUrl, xformsBC>(*lv, *this));
109 add(new GUIVCLog<FormVCLog, xformsBC>(*lv, *this));
111 add(new FormDocument(lv, this));
112 add(new FormExternal(lv, this));
113 add(new FormGraphics(lv, this));
114 add(new FormIndex(lv, this));
115 add(new FormMathsPanel(lv, this));
116 add(new FormParagraph(lv, this));
117 add(new FormPreamble(lv, this));
118 add(new FormPreferences(lv, this));
119 add(new FormTabular(lv, this));
120 add(new FormToc(lv, this));
121 add(new FormMinipage(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 Signals will also be a great help in controlling the splashscreen --
195 once signalled to hide it can disconnect from the signal and remove
198 LyXFuncs will be used for requesting/setting LyX internal info. This
199 will ensure that scripts or LyXServer-connected applications can all
200 have access to the same calls as the internal user-interface.
202 ******************************************************************************/