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