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"
20 #include "support/strfwd.h"
22 #include <QMainWindow>
25 class QDragEnterEvent;
33 namespace support { class FileName; }
54 * GuiView - Qt4 main LyX window
56 * This class represents the main LyX window and provides
57 * accessor functions to its content.
59 * Note: a QObject emits a destroyed(QObject *) Qt signal when it
60 * is deleted. This might be useful for closing other dialogs
61 * depending on a given GuiView.
63 class GuiView : public QMainWindow, public GuiBufferViewDelegate,
64 public GuiBufferDelegate
69 /// create a main window of the given dimensions
74 /// closes the view such that the view knows that is closed
75 /// programmatically and not by the user clicking the x.
76 bool closeScheduled();
78 int id() const { return id_; }
85 void saveCursorShapes();
86 void restoreCursorShapes();
87 void setCursorShapes(Qt::CursorShape shape);
89 /// \name Generic accessor functions
91 /// The current BufferView refers to the BufferView that has the focus,
92 /// including for example the one that is created when you use the
93 /// advanced search and replace pane.
94 /// \return the currently selected buffer view.
95 BufferView * currentBufferView();
96 BufferView const * currentBufferView() const;
98 /// The document BufferView always refers to the view's main document
99 /// BufferView. So, even if the BufferView in e.g., the advanced
100 /// search and replace pane has the focus.
101 /// \return the current document buffer view.
102 BufferView * documentBufferView();
103 BufferView const * documentBufferView() const;
105 void newDocument(std::string const & filename,
108 /// display a message in the view
109 /// could be called from any thread
110 void message(docstring const &);
112 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
113 /// dispatch command.
114 /// \return true if the \c FuncRequest has been dispatched.
115 void dispatch(FuncRequest const & cmd, DispatchResult & dr);
117 void restartCursor();
118 /// Update the completion popup and the inline completion state.
119 /// If \c start is true, then a new completion might be started.
120 /// If \c keep is true, an active completion will be kept active
121 /// even though the cursor moved. The update flags of \c cur might
123 void updateCompletion(Cursor & cur, bool start, bool keep);
129 void focusInEvent(QFocusEvent * e);
130 /// set a buffer to the current workarea.
131 void setBuffer(Buffer * b); ///< \c Buffer to set.
133 /// load a document into the current workarea.
134 Buffer * loadDocument(
135 support::FileName const & name, ///< File to load.
136 bool tolastfiles = true ///< append to the "Open recent" menu?
139 /// add toolbar, if newline==true, add a toolbar break before the toolbar
140 GuiToolbar * makeToolbar(ToolbarInfo const & tbinfo, bool newline);
141 void updateStatusBar();
143 /// updates the possible layouts selectable
144 void updateLayoutList();
145 void updateToolbars();
146 QMenu * createPopupMenu();
149 LayoutBox * getLayoutDialog() const;
151 /// hides the workarea and makes sure it is clean
152 bool hideWorkArea(GuiWorkArea * wa);
153 /// closes the workarea
154 bool closeWorkArea(GuiWorkArea * wa);
155 /// closes the buffer
156 bool closeBuffer(Buffer & buf);
158 void openDocument(std::string const & filename);
160 void importDocument(std::string const &);
162 /// \name GuiBufferDelegate.
164 void resetAutosaveTimers();
165 void errors(std::string const &, bool from_master = false);
166 void structureChanged();
167 void updateTocItem(std::string const &, DocIterator const &);
171 TocModels & tocModels();
173 /// called on timeout
176 /// check for external change of any opened buffer, mainly for svn usage
177 void checkExternallyModifiedBuffers();
179 /** redraw \c inset in all the BufferViews in which it is currently
180 * visible. If successful return a pointer to the owning Buffer.
182 Buffer const * updateInset(Inset const *);
184 /// \return the \c Workarea associated to \p Buffer
185 /// \retval 0 if no \c WorkArea is found.
186 GuiWorkArea * workArea(Buffer & buffer);
188 /// Add a \c WorkArea
189 /// \return the \c Workarea associated to \p Buffer
190 /// \retval 0 if no \c WorkArea is found.
191 GuiWorkArea * addWorkArea(Buffer & buffer);
192 /// \param work_area The current \c WorkArea, or \c NULL
193 void setCurrentWorkArea(GuiWorkArea * work_area);
195 void removeWorkArea(GuiWorkArea * work_area);
196 /// return the current WorkArea (the one that has the focus).
197 GuiWorkArea const * currentWorkArea() const;
198 /// return the current WorkArea (the one that has the focus).
199 GuiWorkArea * currentWorkArea();
201 /// return the current document WorkArea (it may not have the focus).
202 GuiWorkArea const * currentMainWorkArea() const;
203 /// return the current document WorkArea (it may not have the focus).
204 GuiWorkArea * currentMainWorkArea();
208 void triggerShowDialog(QString const & qname, QString const & qdata, Inset * inset);
212 /// clear any temporary message and replace with current status.
217 void updateWindowTitle(GuiWorkArea * wa);
219 void resetWindowTitleAndIconText();
222 void on_currentWorkAreaChanged(GuiWorkArea *);
224 void on_lastWorkAreaRemoved();
226 /// slots to change the icon size
227 void smallSizedIcons();
228 void normalSizedIcons();
229 void bigSizedIcons();
231 /// For completion of autosave or export threads.
232 void processingThreadStarted();
233 void processingThreadFinished();
234 void indicateProcessing();
236 /// must be called in GUI thread
237 void doShowDialog(QString const & qname, QString const & qdata,
240 /// must be called from GUI thread
241 void updateStatusBarMessage(QString const & str);
242 void clearMessageText();
245 /// Open given child document in current buffer directory.
246 void openChildDocument(std::string const & filename);
247 /// Close current document buffer.
249 /// Close all document buffers.
250 bool closeBufferAll();
252 TabWorkArea * addTabWorkArea();
254 /// connect to signals in the given BufferView
255 void connectBufferView(BufferView & bv);
256 /// disconnect from signals in the given BufferView
257 void disconnectBufferView();
258 /// connect to signals in the given buffer
259 void connectBuffer(Buffer & buf);
260 /// disconnect from signals in the given buffer
261 void disconnectBuffer();
263 void dragEnterEvent(QDragEnterEvent * ev);
265 void dropEvent(QDropEvent * ev);
266 /// make sure we quit cleanly
267 void closeEvent(QCloseEvent * e);
269 void showEvent(QShowEvent *);
271 /// in order to catch Tab key press.
272 bool event(QEvent * e);
273 bool focusNextPrevChild(bool);
276 bool goToFileRow(std::string const & argument);
279 struct GuiViewPrivate;
284 /// dialogs for this view
290 /// Hide all visible dialogs
291 void hideAll() const;
293 /// Update all visible dialogs.
295 * Check the status of all visible dialogs and disable or reenable
296 * them as appropriate.
298 * Disabling is needed for example when a dialog is open and the
299 * cursor moves to a position where the corresponding inset is not
302 void updateDialogs();
304 /** Show dialog could be called from arbitrary threads.
305 \param name == "bibtex", "citation" etc; an identifier used to
306 launch a particular dialog.
307 \param data is a string representation of the Inset contents.
308 It is often little more than the output from Inset::write.
309 It is passed to, and parsed by, the frontend dialog.
310 Several of these dialogs do not need any data,
311 so it defaults to string().
312 \param inset ownership is _not_ passed to the frontend dialog.
313 It is stored internally and used by the kernel to ascertain
314 what to do with the FuncRequest dispatched from the frontend
315 dialog on 'Apply'; should it be used to create a new inset at
316 the current cursor position or modify an existing, 'open' inset?
318 void showDialog(std::string const & name,
319 std::string const & data, Inset * inset = 0);
321 /** \param name == "citation", "bibtex" etc; an identifier used
322 to reset the contents of a particular dialog with \param data.
323 See the comments to 'show', above.
325 void updateDialog(std::string const & name, std::string const & data);
327 /** All Dialogs of the given \param name will be closed if they are
328 connected to the given \param inset.
330 void hideDialog(std::string const & name, Inset * inset);
332 void disconnectDialog(std::string const & name);
336 void saveLayout() const;
338 bool restoreLayout();
340 GuiToolbar * toolbar(std::string const & name);
342 void constructToolbars();
346 bool lfunUiToggle(std::string const & ui_component);
348 void toggleFullScreen();
350 void insertLyXFile(docstring const & fname);
352 void insertPlaintextFile(docstring const & fname,
355 /// Save a buffer as a new file.
357 Write a buffer to a new file name and rename the buffer
358 according to the new file name.
360 This function is e.g. used by menu callbacks and
361 LFUN_BUFFER_WRITE_AS.
363 If 'newname' is empty, the user is asked via a
364 dialog for the buffer's new name and location.
366 If 'newname' is non-empty and has an absolute path, that is used.
367 Otherwise the base directory of the buffer is used as the base
368 for any relative path in 'newname'.
370 bool renameBuffer(Buffer & b, docstring const & newname);
372 bool saveBuffer(Buffer & b);
373 /// save and rename buffer to fn. If fn is empty, the buffer
374 /// is just saved as the filename it already has.
375 bool saveBuffer(Buffer & b, support::FileName const & fn);
376 /// closes a workarea, if close_buffer is true the buffer will
377 /// also be released, otherwise the buffer will be hidden.
378 bool closeWorkArea(GuiWorkArea * wa, bool close_buffer);
379 /// closes the tabworkarea and all tabs. If we are in a close event,
380 /// all buffers will be closed, otherwise they will be hidden.
381 bool closeTabWorkArea(TabWorkArea * twa);
382 /// gives the user the possibility to save his work
383 /// or to discard the changes. If hiding is true, the
384 /// document will be reloaded.
385 bool saveBufferIfNeeded(Buffer & buf, bool hiding);
386 /// closes all workareas
387 bool closeWorkAreaAll();
388 /// write all open workareas into the session file
389 void writeSession() const;
390 /// is the buffer in this workarea also shown in another tab ?
391 /// This tab can either be in the same view or in another one.
392 bool inMultiTabs(GuiWorkArea * wa);
393 /// is the buffer in this workarea also shown in another view ?
394 bool inMultiViews(GuiWorkArea * wa);
396 enum NextOrPrevious {
401 void gotoNextOrPreviousBuffer(NextOrPrevious np);
403 /// Is the dialog currently visible?
404 bool isDialogVisible(std::string const & name) const;
406 Dialog * findOrBuild(std::string const & name, bool hide_it);
408 Dialog * build(std::string const & name);
410 bool reloadBuffer(Buffer & buffer);
412 void dispatchVC(FuncRequest const & cmd, DispatchResult & dr);
419 /// flag to avoid two concurrent close events.
421 /// if the view is busy the cursor shouldn't blink for instance.
422 /// This counts the number of times more often we called
423 /// setBusy(true) compared to setBusy(false), so we can nest
424 /// functions that call setBusy;
429 } // namespace frontend