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