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.
17 #include "insets/InsetCode.h"
19 #include "support/strfwd.h"
36 /** \enum KernelDocType used to flag the different kinds of buffer
37 * without making the kernel header files available to the
38 * dialog's Controller or View.
48 /** \c Dialog collects the different parts of a Model-Controller-View
49 * split of a generic dialog together.
54 /// \param lv is the access point for the dialog to the LyX kernel.
55 /// \param name is the identifier given to the dialog by its parent
57 /// \param title is the window title used for decoration.
58 Dialog(GuiView & lv, QString const & name, QString const & title);
62 virtual QWidget * asQWidget() = 0;
63 virtual QWidget const * asQWidget() const = 0;
67 * This key must be used for any session setting.
69 QString sessionKey() const;
71 /// Save session settings.
73 * This default implementation saves the geometry state.
74 * Reimplement to save more settings.
76 virtual void saveSession() const;
78 /// Restore session settings.
80 * This default implementation restores the geometry state.
81 * Reimplement to restore more settings.
83 virtual void restoreSession();
85 /** \name Container Access
86 * These methods are publicly accessible because they are invoked
87 * by the parent container acting on commands from the LyX kernel.
90 /// \param data is a string encoding of the data to be displayed.
91 /// It is passed to the Controller to be translated into a useable form.
92 virtual void showData(std::string const & data);
95 /// \return inset at current cursor location.
96 Inset const * inset(InsetCode code) const;
98 /** Check whether we may apply our data.
100 * The buttons are disabled if not and (re-)enabled if yes.
102 virtual void checkStatus();
104 /** When applying, it's useful to know whether the dialog is about
105 * to close or not (no point refreshing the display for example).
107 virtual bool isClosing() const { return false; }
110 * of a Model-Controller-View split of a generic dialog.
111 * These few methods are all that a generic dialog needs of a
115 /** A request to modify the data structures stored by the
116 * accompanying Controller in preparation for their dispatch to
119 virtual void applyView() = 0;
121 /// Hide the dialog from sight
124 /// Prepare dialog and display it.
127 /// Prepare dialog before view.
130 /// Decide wether the dialog should grab thekeyboard focus when shown.
131 /// This method defaults to true, override if a different behaviour
133 virtual bool wantInitialFocus() const { return true; }
135 /// Update the display of the dialog whilst it is still visible.
136 virtual void updateView() = 0;
138 // Default Implementation does nothing.
139 // Each dialog has to choose what control to enable or disable.
140 virtual void enableView(bool /*enable*/) {}
142 /// \return true if the dialog is visible.
143 virtual bool isVisibleView() const;
146 /// Dialog identifier.
147 QString name() const { return name_; }
150 /** Enable the controller to initialise its data structures.
151 * \param data is a string encoding of the parameters to be displayed.
152 * \return true if the translation was successful.
154 virtual bool initialiseParams(std::string const & data) = 0;
156 /// Enable the controller to clean up its data structures.
157 virtual void clearParams() = 0;
159 /// Enable the Controller to dispatch its data back to the LyX kernel.
160 virtual void dispatchParams() = 0;
162 /** \return true if the dialog should be shown only when
165 virtual bool isBufferDependent() const = 0;
167 /** \return true if the dialog can apply data also
168 * for ReadOnly buffers.
169 * This has to be distinguished from isBufferDependent()
171 virtual bool canApplyToReadOnly() const { return false; }
173 /** The lfun that is sent for applying the data.
175 * This method is used by the default implementation of canApply()
176 * for buffer dependent dialogs that send one lfun when applying the
178 * It should be used in dispatchParams(), too for consistency reasons.
179 * \returns the lfun that is sent for applying the data.
181 virtual FuncCode getLfun() const { return LFUN_INSET_APPLY; }
183 /** Check whether we may apply our data.
185 * The default implementation works for all dialogs that send one
186 * lfun when applying the data. Dialogs that send none or more than
187 * one lfun need to reimplement it.
188 * \returns whether the data can be applied or not.
190 virtual bool canApply() const;
192 /** \return true if the kernel should disconnect the dialog from
193 * a particular inset after the data has been applied to it.
194 * Clearly this makes sense only for dialogs modifying the contents
196 * In practise, only a very few dialogs (e.g. the citation dialog)
199 virtual bool disconnectOnApply() const { return false; }
203 /** \c Kernel part: a wrapper making the LyX kernel available to the dialog.
204 * (Ie, it provides an interface to the Model part of the Model-Controller-
206 * In an ideal world, it will shrink as more info is passed to the
207 * Dialog::show() and Dialog::update() methods.
211 /** This method is the primary purpose of the class. It provides
212 * the "gateway" by which the dialog can send a request (of a
213 * change in the data, for more information) to the kernel.
214 * \param fr is the encoding of the request.
216 void dispatch(FuncRequest const & fr) const;
218 /** The dialog has received a request from the user
219 * (who pressed the "Restore" button) to update contents.
220 * It must, therefore, ask the kernel to provide this information.
221 * \param name is used to identify the dialog to the kernel.
223 void updateDialog() const;
225 /** A request from the Controller that future changes to the data
226 * stored by the dialog are not applied to the inset currently
227 * connected to the dialog. Instead, they will be used to generate
228 * a new inset at the cursor position.
230 void disconnect() const;
232 /** \name Kernel Wrappers
233 * Simple wrapper functions to Buffer methods.
236 bool isBufferAvailable() const;
237 bool isBufferReadonly() const;
238 QString bufferFilepath() const;
241 /// The type of the current buffer.
242 KernelDocType docType() const;
244 /** \name Kernel Nasties
245 * Unpleasantly public internals of the LyX kernel.
246 * We should aim to reduce/remove these from the interface.
249 GuiView const & lyxview() const { return *lyxview_; }
250 Buffer const & buffer() const;
251 BufferView const * bufferview() const;
256 void setTitle(QString const & title) { title_ = title; }
258 virtual void apply();
261 /** The Dialog's name is the means by which a dialog identifies
262 * itself to the LyXView.
270 /// intentionally unimplemented, therefore uncopiable
271 Dialog(Dialog const &);
272 void operator=(Dialog const &);
277 } // namespace frontend