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
65 /// LyXView inherited methods.
67 int id() const { return id_; };
69 BufferView * currentBufferView();
70 BufferView const * currentBufferView() const;
71 BufferView * documentBufferView();
72 BufferView const * documentBufferView() const;
73 void newDocument(std::string const & filename,
75 void message(docstring const &);
76 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
77 bool dispatch(FuncRequest const & cmd);
79 void updateCompletion(Cursor & cur, bool start, bool keep);
83 /// set a buffer to the current workarea.
84 void setBuffer(Buffer * b); ///< \c Buffer to set.
86 /// load a document into the current workarea.
87 Buffer * loadDocument(
88 support::FileName const & name, ///< File to load.
89 bool tolastfiles = true ///< append to the "Open recent" menu?
92 /// add toolbar, if newline==true, add a toolbar break before the toolbar
93 GuiToolbar * makeToolbar(ToolbarInfo const & tbinfo, bool newline);
94 void updateStatusBar();
96 /// updates the possible layouts selectable
97 void updateLayoutList();
98 void updateToolbars();
99 QMenu * createPopupMenu();
102 LayoutBox * getLayoutDialog() const;
104 /// hides the workarea and makes sure it is clean
105 bool hideWorkArea(GuiWorkArea * wa);
106 /// closes the workarea
107 bool closeWorkArea(GuiWorkArea * wa);
108 /// closes the buffer
109 bool closeBuffer(Buffer & buf);
111 void openDocument(std::string const & filename);
113 void importDocument(std::string const &);
115 /// GuiBufferDelegate.
117 void resetAutosaveTimers();
118 void errors(std::string const &, bool from_master = false);
119 void structureChanged();
120 void updateTocItem(std::string const &, DocIterator const &);
124 TocModels & tocModels();
126 /// called on timeout
129 /** redraw \c inset in all the BufferViews in which it is currently
130 * visible. If successful return a pointer to the owning Buffer.
132 Buffer const * updateInset(Inset const *);
134 /// \return the \c Workarea associated to \p Buffer
135 /// \retval 0 if no \c WorkArea is found.
136 GuiWorkArea * workArea(Buffer & buffer);
138 /// Add a \c WorkArea
139 /// \return the \c Workarea associated to \p Buffer
140 /// \retval 0 if no \c WorkArea is found.
141 GuiWorkArea * addWorkArea(Buffer & buffer);
142 /// \param work_area The current \c WorkArea, or \c NULL
143 void setCurrentWorkArea(GuiWorkArea * work_area);
145 void removeWorkArea(GuiWorkArea * work_area);
146 /// return the current WorkArea (the one that has the focus).
147 GuiWorkArea const * currentWorkArea() const;
148 /// return the current WorkArea (the one that has the focus).
149 GuiWorkArea * currentWorkArea();
151 /// return the current document WorkArea (it may not have the focus).
152 GuiWorkArea const * currentMainWorkArea() const;
153 /// return the current document WorkArea (it may not have the focus).
154 GuiWorkArea * currentMainWorkArea();
161 /// clear any temporary message and replace with current status.
166 void updateWindowTitle(GuiWorkArea * wa);
168 void resetWindowTitleAndIconText();
171 void on_currentWorkAreaChanged(GuiWorkArea *);
173 void on_lastWorkAreaRemoved();
175 /// slots to change the icon size
176 void smallSizedIcons();
177 void normalSizedIcons();
178 void bigSizedIcons();
181 /// Open given child document in current buffer directory.
182 void openChildDocument(std::string const & filename);
183 /// Close current document buffer.
185 /// Close all document buffers.
186 bool closeBufferAll();
188 TabWorkArea * addTabWorkArea();
190 /// connect to signals in the given BufferView
191 void connectBufferView(BufferView & bv);
192 /// disconnect from signals in the given BufferView
193 void disconnectBufferView();
194 /// connect to signals in the given buffer
195 void connectBuffer(Buffer & buf);
196 /// disconnect from signals in the given buffer
197 void disconnectBuffer();
199 void dragEnterEvent(QDragEnterEvent * ev);
201 void dropEvent(QDropEvent * ev);
202 /// make sure we quit cleanly
203 void closeEvent(QCloseEvent * e);
205 void showEvent(QShowEvent *);
207 /// in order to catch Tab key press.
208 bool event(QEvent * e);
209 bool focusNextPrevChild(bool);
212 bool goToFileRow(std::string const & argument);
215 struct GuiViewPrivate;
220 /// dialogs for this view
226 /// Hide all visible dialogs
227 void hideAll() const;
229 /// Update all visible dialogs.
231 * Check the status of all visible dialogs and disable or reenable
232 * them as appropriate.
234 * Disabling is needed for example when a dialog is open and the
235 * cursor moves to a position where the corresponding inset is not
238 void updateDialogs();
240 /** \param name == "bibtex", "citation" etc; an identifier used to
241 launch a particular dialog.
242 \param data is a string representation of the Inset contents.
243 It is often little more than the output from Inset::write.
244 It is passed to, and parsed by, the frontend dialog.
245 Several of these dialogs do not need any data,
246 so it defaults to string().
247 \param inset ownership is _not_ passed to the frontend dialog.
248 It is stored internally and used by the kernel to ascertain
249 what to do with the FuncRequest dispatched from the frontend
250 dialog on 'Apply'; should it be used to create a new inset at
251 the current cursor position or modify an existing, 'open' inset?
253 void showDialog(std::string const & name,
254 std::string const & data, Inset * inset = 0);
256 /** \param name == "citation", "bibtex" etc; an identifier used
257 to reset the contents of a particular dialog with \param data.
258 See the comments to 'show', above.
260 void updateDialog(std::string const & name, std::string const & data);
262 /** All Dialogs of the given \param name will be closed if they are
263 connected to the given \param inset.
265 void hideDialog(std::string const & name, Inset * inset);
267 void disconnectDialog(std::string const & name);
271 void saveLayout() const;
273 bool restoreLayout();
275 GuiToolbar * toolbar(std::string const & name);
277 void constructToolbars();
281 void lfunUiToggle(FuncRequest const & cmd);
283 void toggleFullScreen();
285 void insertLyXFile(docstring const & fname);
287 void insertPlaintextFile(docstring const & fname,
290 /// Save a buffer as a new file.
292 Write a buffer to a new file name and rename the buffer
293 according to the new file name.
295 This function is e.g. used by menu callbacks and
296 LFUN_BUFFER_WRITE_AS.
298 If 'newname' is empty, the user is asked via a
299 dialog for the buffer's new name and location.
301 If 'newname' is non-empty and has an absolute path, that is used.
302 Otherwise the base directory of the buffer is used as the base
303 for any relative path in 'newname'.
305 bool renameBuffer(Buffer & b, docstring const & newname);
307 bool saveBuffer(Buffer & b);
308 /// closes a workarea, if close_buffer is true the buffer will
309 /// also be released, otherwise the buffer will be hidden.
310 bool closeWorkArea(GuiWorkArea * wa, bool close_buffer);
311 /// closes the tabworkarea and all tabs. If we are in a close event,
312 /// all buffers will be closed, otherwise they will be hidden.
313 bool closeTabWorkArea(TabWorkArea * twa);
314 /// gives the user the possibility to save his work
315 /// or to discard the changes. If hiding is true, the
316 /// document will be reloaded.
317 bool saveBufferIfNeeded(Buffer & buf, bool hiding);
318 /// closes all workareas
319 bool closeWorkAreaAll();
320 /// write all open workareas into the session file
321 void writeSession() const;
322 /// is the buffer in this workarea also shown in another tab ?
323 /// This tab can either be in the same view or in another one.
324 bool inMultiTabs(GuiWorkArea * wa);
325 /// is the buffer in this workarea also shown in another view ?
326 bool inMultiViews(GuiWorkArea * wa);
328 enum NextOrPrevious {
333 void gotoNextOrPreviousBuffer(NextOrPrevious np);
335 /// Is the dialog currently visible?
336 bool isDialogVisible(std::string const & name) const;
338 Dialog * findOrBuild(std::string const & name, bool hide_it);
340 Dialog * build(std::string const & name);
344 void dispatchVC(FuncRequest const & cmd);
351 /// flag to avoid two concurrent close events.
355 } // namespace frontend