1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1995-2001 The LyX Team.
8 * ======================================================
14 #pragma implementation
20 #include "BufferView.h"
23 #include "ControlBibitem.h"
24 #include "ControlBibtex.h"
25 #include "ControlCharacter.h"
26 #include "ControlCitation.h"
27 #include "ControlError.h"
28 #include "ControlInclude.h"
29 #include "ControlLog.h"
30 #include "ControlUrl.h"
31 #include "ControlVCLog.h"
32 #include "ControlTabularCreate.h"
33 #include "ControlERT.h"
37 #include "FormError.h"
38 #include "FormTabularCreate.h"
41 #include "FormBibitem.h"
42 #include "FormBibtex.h"
43 #include "FormCharacter.h"
44 #include "FormCitation.h"
46 #include "FormVCLog.h"
48 #include "FormDocument.h"
49 #include "FormExternal.h"
50 #include "FormGraphics.h"
51 #include "FormInclude.h"
52 #include "FormIndex.h"
53 #include "FormMathsPanel.h"
54 #include "FormParagraph.h"
55 #include "FormPreamble.h"
56 #include "FormPreferences.h"
57 #include "FormPrint.h"
59 #include "FormSearch.h"
60 #include "FormTabular.h"
61 #include "FormTabul./arCreate.h"
64 #include "FormMinipage.h"
67 Dialogs::Dialogs(LyXView * lv)
69 add(new GUIUrl<FormUrl, gnomeBC>(*lv, *this));
70 add(new GUIError<FormError, gnomeBC>(*lv, *this));
71 add(new GUITabularCreate<FormTabularCreate, gnomeBC>(*lv, *this));
72 add(new GUIERT<FormERT, gnomeBC>(*lv, *this));
75 add(new GUIBibitem<FormBibitem, xformsBC>(*lv, *this));
76 add(new GUIBibtex<FormBibtex, xformsBC>(*lv, *this));
77 add(new GUICharacter<FormCharacter, xformsBC>(*lv, *this));
78 //add(new GUICitation<FormCitation, xformsBC>(*lv, *this));
79 add(new GUILog<FormLog, xformsBC>(*lv, *this));
80 add(new GUIVCLog<FormVCLog, xformsBC>(*lv, *this));
82 // For now we use the gnome non MVC dialogs
83 add(new FormCitation(lv, this));
85 add(new FormDocument(lv, this));
86 add(new FormExternal(lv, this));
87 add(new FormGraphics(lv, this));
88 add(new FormInclude(lv, this));
89 add(new FormIndex(lv, this));
90 add(new FormMathsPanel(lv, this));
91 add(new FormParagraph(lv, this));
92 add(new FormPreamble(lv, this));
93 add(new FormPreferences(lv, this));
94 add(new FormPrint(lv, this));
95 add(new FormRef(lv, this));
96 add(new FormSearch(lv, this));
97 add(new FormTabular(lv, this));
98 add(new FormTabularCreate(lv, this));
99 add(new FormToc(lv, this));
100 add(new FormUrl(lv, this));
101 add(new FormMinipage(lv, this));
104 // reduce the number of connections needed in
105 // dialogs by a simple connection here.
106 hideAll.connect(hideBufferDependent.slot());
109 /*****************************************************************************
111 Q. WHY does Dialogs::Dialogs pass `this' to dialog constructors?
113 A. To avoid a segfault.
114 The dialog constructors need to connect to their
115 respective showSomeDialog signal(*) but in order to do
116 that they need to get the address of the Dialogs instance
117 from LyXView::getDialogs(). However, since the Dialogs
118 instance is still being constructed at that time
119 LyXView::getDialogs() will *not* return the correct
120 address because it hasn't finished being constructed.
121 A Catch-22 situation (or is that the chicken and the egg...).
122 So to get around the problem we pass the address of
123 the newly created Dialogs instance using `this'.
125 (*) -- I'm using signals exclusively to guarantee that the gui code
126 remains hidden from the rest of the system. In fact the only
127 header related to dialogs that anything in the non-gui-specific
128 code gets to see is Dialogs.h! Even Dialogs.h doesn't know what a
129 FormCopyright class looks like or that its even going to be used!
131 No other gui dialog headers are seen outside of the gui-specific
132 directories! This ensures that the gui is completely separate from
133 the rest of LyX. All this through the use of a few simple signals.
134 BUT, the price is that during construction we need to connect the
135 implementations show() method to the showSomeDialog signal and this
136 requires that we have an instance of Dialogs and the problem mentioned
139 Almost all other dialogs should be able to operate using the same style
140 of signalling used for Copyright. Exceptions should be handled
141 by adding a specific show or update signal. For example, spellchecker
142 needs to set the next suspect word and its options/replacements so we
144 Signal0<void> updateSpellChecker;
146 Since we would have to have a
147 Signal0<void> showSpellChecker;
149 in order to just see the spellchecker and let the user push the [Start]
150 button then the updateSpellChecker signal will make the SpellChecker
151 dialog get the new word and replacements list from LyX. If you really,
152 really wanted to you could define a signal that would pass the new
153 word and replacements:
154 Signal2<void, string, vector<string> > updateSpellChecker;
156 (or something similar) but, why bother when the spellchecker can get
157 it anyway with a LyXFunc call or two. Besides if someone extends
158 what a dialog does then they also have to change code in the rest of
159 LyX to pass more parameters or get the extra info via a function
160 call anyway. Thus reducing the independence of the two code bases.
162 We don't need a separate update signal for each dialog because most of
163 them will be changed only when the buffer is changed (either by closing
164 the current open buffer or switching to another buffer in the current
165 LyXView -- different BufferView same LyXView or same BufferView same
168 So we minimise signals but maximise independence and programming
169 simplicity, understandability and maintainability. It's also
170 extremely easy to add support for Qt or gtk-- because they use
171 signals already. Guis that use callbacks, like xforms, must have their
172 code wrapped up like that in the form_copyright.[Ch] which is awkward
173 but will at least allow multiple instances of the same dialog.
175 LyXFuncs will be used for requesting/setting LyX internal info. This
176 will ensure that scripts or LyXServer-connected applications can all
177 have access to the same calls as the internal user-interface.
179 ******************************************************************************/