4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjornes
9 * \author Abdelrazak Younes
10 * \author Peter Kümmel
12 * Full author contact details are available in file CREDITS.
18 #include "frontends/Delegates.h"
19 #include "frontends/LyXView.h"
21 #include "support/strfwd.h"
23 #include <QMainWindow>
26 class QDragEnterEvent;
45 * GuiView - Qt4 implementation of LyXView
47 * qt4-private implementation of the main LyX window.
49 * Note: a QObject emits a destroyed(QObject *) Qt signal when it
50 * is deleted. This might be useful for closing other dialogs
51 * depending on a given GuiView.
53 class GuiView : public QMainWindow, public LyXView, public GuiBufferViewDelegate,
54 public GuiBufferDelegate
58 /// create a main window of the given dimensions
64 int id() const { return id_; }
68 /// returns true if this view has the focus.
69 bool hasFocus() const;
71 /// add toolbar, if newline==true, add a toolbar break before the toolbar
72 GuiToolbar * makeToolbar(ToolbarInfo const & tbinfo, bool newline);
73 virtual void updateStatusBar();
74 virtual void message(docstring const & str);
76 /// updates the possible layouts selectable
77 void updateLayoutList();
78 void updateToolbars();
79 QMenu * createPopupMenu();
80 FuncStatus getStatus(FuncRequest const & cmd);
81 bool dispatch(FuncRequest const & cmd);
84 void setLayoutDialog(GuiLayoutBox *);
86 /// \return the buffer currently shown in this window
88 Buffer const * buffer() const;
89 /// set a buffer to the current workarea.
90 void setBuffer(Buffer * b); ///< \c Buffer to set.
93 /// load a document into the current workarea.
94 Buffer * loadDocument(support::FileName const & name, ///< File to load.
95 bool tolastfiles = true); ///< append to the "Open recent" menu?
97 void openDocument(std::string const & filename);
99 void importDocument(std::string const &);
101 void newDocument(std::string const & filename, bool fromTemplate);
102 /// write all buffers, asking the user, returns false if cancelled
105 /// GuiBufferDelegate.
107 void resetAutosaveTimers();
108 void errors(std::string const &);
109 void structureChanged() { updateToc(); }
112 /// called on timeout
115 void updateEmbeddedFiles();
117 /// \return the current buffer view.
120 /** redraw \c inset in all the BufferViews in which it is currently
121 * visible. If successful return a pointer to the owning Buffer.
123 Buffer const * updateInset(Inset const *);
125 void restartCursor();
127 /// \return the \c Workarea associated to \p Buffer
128 /// \retval 0 if no \c WorkArea is found.
129 GuiWorkArea * workArea(Buffer & buffer);
131 /// Add a \c WorkArea
132 /// \return the \c Workarea associated to \p Buffer
133 /// \retval 0 if no \c WorkArea is found.
134 GuiWorkArea * addWorkArea(Buffer & buffer);
136 void setCurrentWorkArea(GuiWorkArea * work_area);
138 void removeWorkArea(GuiWorkArea * work_area);
139 /// return the current WorkArea (the one that has the focus).
140 GuiWorkArea const * currentWorkArea() const;
147 /// clear any temporary message and replace with current status.
152 void updateWindowTitle(GuiWorkArea * wa);
155 void on_currentWorkAreaChanged(GuiWorkArea *);
157 /// slots to change the icon size
158 void smallSizedIcons();
159 void normalSizedIcons();
160 void bigSizedIcons();
164 TabWorkArea * addTabWorkArea();
166 /// connect to signals in the given BufferView
167 void connectBufferView(BufferView & bv);
168 /// disconnect from signals in the given BufferView
169 void disconnectBufferView();
170 /// connect to signals in the given buffer
171 void connectBuffer(Buffer & buf);
172 /// disconnect from signals in the given buffer
173 void disconnectBuffer();
177 void dragEnterEvent(QDragEnterEvent * ev);
179 void dropEvent(QDropEvent * ev);
180 /// make sure we quit cleanly
181 void closeEvent(QCloseEvent * e);
183 void showEvent(QShowEvent *);
185 /// in order to catch Tab key press.
186 bool event(QEvent * e);
187 bool focusNextPrevChild(bool);
190 struct GuiViewPrivate;
195 /// dialogs for this view
201 /** Check the status of all visible dialogs and disable or reenable
202 * them as appropriate.
204 * Disabling is needed for example when a dialog is open and the
205 * cursor moves to a position where the corresponding inset is not
210 /// Hide all visible dialogs
211 void hideAll() const;
212 /// Hide any dialogs that require a buffer for them to operate
213 void hideBufferDependent() const;
214 /** Update visible, buffer-dependent dialogs
215 If the bool is true then a buffer change has occurred
216 else it is still the same buffer.
218 void updateBufferDependent(bool) const;
220 /** \param name == "bibtex", "citation" etc; an identifier used to
221 launch a particular dialog.
222 \param data is a string representation of the Inset contents.
223 It is often little more than the output from Inset::write.
224 It is passed to, and parsed by, the frontend dialog.
225 Several of these dialogs do not need any data,
226 so it defaults to string().
227 \param inset ownership is _not_ passed to the frontend dialog.
228 It is stored internally and used by the kernel to ascertain
229 what to do with the FuncRequest dispatched from the frontend
230 dialog on 'Apply'; should it be used to create a new inset at
231 the current cursor position or modify an existing, 'open' inset?
233 void showDialog(std::string const & name,
234 std::string const & data, Inset * inset = 0);
236 /** \param name == "citation", "bibtex" etc; an identifier used
237 to update the contents of a particular dialog with \param data.
238 See the comments to 'show', above.
240 void updateDialog(std::string const & name, std::string const & data);
242 /** All Dialogs of the given \param name will be closed if they are
243 connected to the given \param inset.
245 void hideDialog(std::string const & name, Inset * inset);
247 void disconnectDialog(std::string const & name);
250 void updateCompletion(bool start, bool keep);
254 void lfunUiToggle(FuncRequest const & cmd);
257 void insertLyXFile(docstring const & fname);
259 void insertPlaintextFile(docstring const & fname,
262 /// Save a buffer as a new file.
264 Write a buffer to a new file name and rename the buffer
265 according to the new file name.
267 This function is e.g. used by menu callbacks and
268 LFUN_BUFFER_WRITE_AS.
270 If 'newname' is empty, the user is asked via a
271 dialog for the buffer's new name and location.
273 If 'newname' is non-empty and has an absolute path, that is used.
274 Otherwise the base directory of the buffer is used as the base
275 for any relative path in 'newname'.
277 bool renameBuffer(Buffer & b, docstring const & newname);
279 bool saveBuffer(Buffer & b);
281 bool closeBuffer(Buffer & buf);
284 Inset * getOpenInset(std::string const & name) const;
286 /// Is the dialog currently visible?
287 bool isDialogVisible(std::string const & name) const;
289 Dialog * find_or_build(std::string const & name);
291 Dialog * build(std::string const & name);
297 } // namespace frontend