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