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;
47 * GuiView - Qt4 implementation of LyXView
49 * qt4-private implementation of the main LyX window.
51 * Note: a QObject emits a destroyed(QObject *) Qt signal when it
52 * is deleted. This might be useful for closing other dialogs
53 * depending on a given GuiView.
55 class GuiView : public QMainWindow, public LyXView, public GuiBufferViewDelegate,
56 public GuiBufferDelegate
60 /// create a main window of the given dimensions
66 int id() const { return id_; }
69 /// returns true if this view has the focus.
70 bool hasFocus() const;
72 /// add toolbar, if newline==true, add a toolbar break before the toolbar
73 GuiToolbar * makeToolbar(ToolbarInfo const & tbinfo, bool newline);
74 virtual void updateStatusBar();
75 virtual void message(docstring const & str);
77 /// updates the possible layouts selectable
78 void updateLayoutList();
79 void updateToolbars();
80 QMenu * createPopupMenu();
81 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
82 bool dispatch(FuncRequest const & cmd);
85 LayoutBox * getLayoutDialog() const;
87 /// \return the buffer currently shown in this window
89 Buffer const * buffer() const;
90 /// set a buffer to the current workarea.
91 void setBuffer(Buffer * b); ///< \c Buffer to set.
94 /// hides the workarea and makes sure it is clean
95 bool hideWorkArea(GuiWorkArea * wa);
96 /// load a document into the current workarea.
97 Buffer * loadDocument(support::FileName const & name, ///< File to load.
98 bool tolastfiles = true); ///< append to the "Open recent" menu?
100 void openDocument(std::string const & filename);
102 void importDocument(std::string const &);
104 void newDocument(std::string const & filename, bool fromTemplate);
106 /// GuiBufferDelegate.
108 void resetAutosaveTimers();
109 void errors(std::string const &, bool from_master = false);
110 void structureChanged();
111 void updateTocItem(std::string const &, DocIterator const &);
115 TocModels & tocModels();
117 /// called on timeout
120 /// \return the current buffer view.
123 /** redraw \c inset in all the BufferViews in which it is currently
124 * visible. If successful return a pointer to the owning Buffer.
126 Buffer const * updateInset(Inset const *);
128 void restartCursor();
130 /// \return the \c Workarea associated to \p Buffer
131 /// \retval 0 if no \c WorkArea is found.
132 GuiWorkArea * workArea(Buffer & buffer);
134 /// Add a \c WorkArea
135 /// \return the \c Workarea associated to \p Buffer
136 /// \retval 0 if no \c WorkArea is found.
137 GuiWorkArea * addWorkArea(Buffer & buffer);
139 void setCurrentWorkArea(GuiWorkArea * work_area);
141 void removeWorkArea(GuiWorkArea * work_area);
142 /// return the current WorkArea (the one that has the focus).
143 GuiWorkArea const * currentWorkArea() const;
144 /// return the current WorkArea (the one that has the focus).
145 GuiWorkArea * currentWorkArea();
147 /// return the current document WorkArea (it may not have the focus).
148 GuiWorkArea const * currentMainWorkArea() const;
149 /// return the current document WorkArea (it may not have the focus).
150 GuiWorkArea * currentMainWorkArea();
157 /// clear any temporary message and replace with current status.
162 void updateWindowTitle(GuiWorkArea * wa);
164 void resetWindowTitleAndIconText();
167 void on_currentWorkAreaChanged(GuiWorkArea *);
169 void on_lastWorkAreaRemoved();
171 /// slots to change the icon size
172 void smallSizedIcons();
173 void normalSizedIcons();
174 void bigSizedIcons();
178 TabWorkArea * addTabWorkArea();
180 /// connect to signals in the given BufferView
181 void connectBufferView(BufferView & bv);
182 /// disconnect from signals in the given BufferView
183 void disconnectBufferView();
184 /// connect to signals in the given buffer
185 void connectBuffer(Buffer & buf);
186 /// disconnect from signals in the given buffer
187 void disconnectBuffer();
189 void dragEnterEvent(QDragEnterEvent * ev);
191 void dropEvent(QDropEvent * ev);
192 /// make sure we quit cleanly
193 void closeEvent(QCloseEvent * e);
195 void showEvent(QShowEvent *);
197 /// in order to catch Tab key press.
198 bool event(QEvent * e);
199 bool focusNextPrevChild(bool);
202 struct GuiViewPrivate;
207 /// dialogs for this view
213 /// Hide all visible dialogs
214 void hideAll() const;
216 /// Update all visible dialogs.
218 * Check the status of all visible dialogs and disable or reenable
219 * them as appropriate.
221 * Disabling is needed for example when a dialog is open and the
222 * cursor moves to a position where the corresponding inset is not
225 void updateDialogs();
227 /** \param name == "bibtex", "citation" etc; an identifier used to
228 launch a particular dialog.
229 \param data is a string representation of the Inset contents.
230 It is often little more than the output from Inset::write.
231 It is passed to, and parsed by, the frontend dialog.
232 Several of these dialogs do not need any data,
233 so it defaults to string().
234 \param inset ownership is _not_ passed to the frontend dialog.
235 It is stored internally and used by the kernel to ascertain
236 what to do with the FuncRequest dispatched from the frontend
237 dialog on 'Apply'; should it be used to create a new inset at
238 the current cursor position or modify an existing, 'open' inset?
240 void showDialog(std::string const & name,
241 std::string const & data, Inset * inset = 0);
243 /** \param name == "citation", "bibtex" etc; an identifier used
244 to reset the contents of a particular dialog with \param data.
245 See the comments to 'show', above.
247 void updateDialog(std::string const & name, std::string const & data);
249 /** All Dialogs of the given \param name will be closed if they are
250 connected to the given \param inset.
252 void hideDialog(std::string const & name, Inset * inset);
254 void disconnectDialog(std::string const & name);
257 void updateCompletion(Cursor & cur, bool start, bool keep);
261 void saveLayout() const;
263 bool restoreLayout();
265 GuiToolbar * toolbar(std::string const & name);
267 void constructToolbars();
271 void lfunUiToggle(FuncRequest const & cmd);
273 void toggleFullScreen();
275 void insertLyXFile(docstring const & fname);
277 void insertPlaintextFile(docstring const & fname,
280 /// Save a buffer as a new file.
282 Write a buffer to a new file name and rename the buffer
283 according to the new file name.
285 This function is e.g. used by menu callbacks and
286 LFUN_BUFFER_WRITE_AS.
288 If 'newname' is empty, the user is asked via a
289 dialog for the buffer's new name and location.
291 If 'newname' is non-empty and has an absolute path, that is used.
292 Otherwise the base directory of the buffer is used as the base
293 for any relative path in 'newname'.
295 bool renameBuffer(Buffer & b, docstring const & newname);
297 bool saveBuffer(Buffer & b);
299 bool closeWorkArea(GuiWorkArea * wa, bool close_buffer,
300 bool in_close_event = false, bool mark_active = false);
301 /// gives the user the possibility to save his work
302 /// or to discard the changes. If hiding is true, the
303 /// document will be reloaded.
304 bool saveBufferIfNeeded(Buffer & buf, bool hiding);
306 bool closeBufferAll(bool in_close_event = false);
307 /// is the buffer in this workarea also shown in another tab ?
308 /// This tab can either be in the same view or in another one.
309 bool inMultiTabs(GuiWorkArea * wa);
310 /// is the buffer in this workarea also shown in another view ?
311 bool inMultiViews(GuiWorkArea * wa);
313 enum NextOrPrevious {
318 void gotoNextOrPreviousBuffer(NextOrPrevious np);
321 Inset * getOpenInset(std::string const & name) const;
323 /// Is the dialog currently visible?
324 bool isDialogVisible(std::string const & name) const;
326 Dialog * findOrBuild(std::string const & name, bool hide_it);
328 Dialog * build(std::string const & name);
333 /// flag to avoid two concurrent close events.
337 } // namespace frontend