4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Angus Leeming
9 * Full author contact details are available in file CREDITS.
32 /** \enum KernelDocType used to flag the different kinds of buffer
33 * without making the kernel header files available to the
34 * dialog's Controller or View.
44 /** \c Dialog collects the different parts of a Model-Controller-View
45 * split of a generic dialog together.
50 /// \param lv is the access point for the dialog to the LyX kernel.
51 /// \param name is the identifier given to the dialog by its parent
53 Dialog(GuiView & lv, std::string const & name);
57 virtual QWidget * asQWidget() = 0;
58 virtual QWidget const * asQWidget() const = 0;
62 * This key must be used for any session setting.
64 QString sessionKey() const;
66 /// Save session settings.
68 * This default implementation saves the geometry state.
69 * Reimplement to save more settings.
71 virtual void saveSession() const;
73 /// Restore session settings.
75 * This default implementation restores the geometry state.
76 * Reimplement to restore more settings.
78 virtual void restoreSession();
80 /** \name Container Access
81 * These methods are publicly accessible because they are invoked
82 * by the parent container acting on commands from the LyX kernel.
85 /// \param data is a string encoding of the data to be displayed.
86 /// It is passed to the Controller to be translated into a useable form.
87 virtual void showData(std::string const & data);
88 virtual void updateData(std::string const & data);
91 /** Check whether we may apply our data.
93 * The buttons are disabled if not and (re-)enabled if yes.
95 virtual void checkStatus();
97 /** When applying, it's useful to know whether the dialog is about
98 * to close or not (no point refreshing the display for example).
100 virtual bool isClosing() const { return false; }
103 * of a Model-Controller-View split of a generic dialog.
104 * These few methods are all that a generic dialog needs of a
108 /** A request to modify the data structures stored by the
109 * accompanying Controller in preparation for their dispatch to
112 virtual void applyView() = 0;
114 /// Hide the dialog from sight
117 /// Create the dialog if necessary, update it and display it.
120 /// Update the display of the dialog whilst it is still visible.
121 virtual void updateView() = 0;
123 // Default Implementation does nothing.
124 // Each dialog has to choose what control to enable or disable.
125 virtual void enableView(bool /*enable*/) {}
127 /// \return true if the dialog is visible.
128 virtual bool isVisibleView() const;
131 /// Dialog identifier.
132 /// FIXME for Andre': Now that Dialog is entirely within qt4/
133 /// We can use QString instead in order to avoid <string> inclusion
134 /// or we can pimpl name_.
135 std::string const & name() const;
138 /** Enable the controller to initialise its data structures.
139 * \param data is a string encoding of the parameters to be displayed.
140 * \return true if the translation was successful.
142 virtual bool initialiseParams(std::string const & data) = 0;
144 /// Enable the controller to clean up its data structures.
145 virtual void clearParams() = 0;
147 /// Enable the Controller to dispatch its data back to the LyX kernel.
148 virtual void dispatchParams() = 0;
150 /** \return true if the dialog should be shown only when
153 virtual bool isBufferDependent() const = 0;
155 /** \return true if the dialog can apply data also
156 * for ReadOnly buffers.
157 * This has to be distinguished from isBufferDependent()
159 virtual bool canApplyToReadOnly() const { return false; }
161 /** The lfun that is sent for applying the data.
163 * This method is used by the default implementation of canApply()
164 * for buffer dependent dialogs that send one lfun when applying the
166 * It should be used in dispatchParams(), too for consistency reasons.
167 * \returns the lfun that is sent for applying the data.
169 virtual kb_action getLfun() const { return LFUN_INSET_APPLY; }
171 /** Check whether we may apply our data.
173 * The default implementation works for all dialogs that send one
174 * lfun when applying the data. Dialogs that send none or more than
175 * one lfun need to reimplement it.
176 * \returns whether the data can be applied or not.
178 virtual bool canApply() const;
180 /** \return true if the kernel should disconnect the dialog from
181 * a particular inset after the data has been applied to it.
182 * Clearly this makes sense only for dialogs modifying the contents
184 * In practise, only a very few dialogs (e.g. the citation dialog)
187 virtual bool disconnectOnApply() const { return false; }
189 /** \return true if Dialog::View::show() should not display the dialog
190 * after running update. Currently, only ControlSpellchecker
193 virtual bool exitEarly() const { return false; }
196 /** \c Kernel part: a wrapper making the LyX kernel available to the dialog.
197 * (Ie, it provides an interface to the Model part of the Model-Controller-
199 * In an ideal world, it will shrink as more info is passed to the
200 * Dialog::show() and Dialog::update() methods.
204 /** This method is the primary purpose of the class. It provides
205 * the "gateway" by which the dialog can send a request (of a
206 * change in the data, for more information) to the kernel.
207 * \param fr is the encoding of the request.
209 void dispatch(FuncRequest const & fr) const;
211 /** The dialog has received a request from the user
212 * (who pressed the "Restore" button) to update contents.
213 * It must, therefore, ask the kernel to provide this information.
214 * \param name is used to identify the dialog to the kernel.
216 void updateDialog() const;
218 /** A request from the Controller that future changes to the data
219 * stored by the dialog are not applied to the inset currently
220 * connected to the dialog. Instead, they will be used to generate
221 * a new inset at the cursor position.
222 * \param name is used to identify the dialog to the kernel.
224 void disconnect() const;
226 /** \name Kernel Wrappers
227 * Simple wrapper functions to Buffer methods.
230 bool isBufferAvailable() const;
231 bool isBufferReadonly() const;
232 std::string const bufferFilepath() const;
235 /// The type of the current buffer.
236 KernelDocType docType() const;
238 /** \name Kernel Nasties
239 * Unpleasantly public internals of the LyX kernel.
240 * We should aim to reduce/remove these from the interface.
243 GuiView & lyxview() { return *lyxview_; }
244 GuiView const & lyxview() const { return *lyxview_; }
247 Buffer const & buffer() const;
249 BufferView * bufferview();
250 BufferView const * bufferview() const;
254 virtual void apply();
257 /** The Dialog's name is the means by which a dialog identifies
258 * itself to the LyXView.
260 std::string const name_;
264 /// intentionally unimplemented, therefore uncopiable
265 Dialog(Dialog const &);
266 void operator=(Dialog const &);
271 } // namespace frontend