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>
26 class QDragEnterEvent;
34 namespace support { class FileName; }
55 * GuiView - Qt main LyX window
57 * This class represents the main LyX window and provides
58 * accessor functions to its content.
60 * Note: a QObject emits a destroyed(QObject *) Qt signal when it
61 * is deleted. This might be useful for closing other dialogs
62 * depending on a given GuiView.
64 class GuiView : public QMainWindow, public GuiBufferViewDelegate,
65 public GuiBufferDelegate
70 /// create a main window of the given dimensions
75 /// closes the view such that the view knows that is closed
76 /// programmatically and not by the user clicking the x.
77 bool closeScheduled();
79 /// Things that need to be done when the OSes session manager
80 /// requests a log out.
81 bool prepareAllBuffersForLogout();
83 int id() const { return id_; }
88 /// Signal that the any "auto" minibuffer can be closed now.
89 void resetCommandExecute();
91 /// \name Generic accessor functions
93 /// The current BufferView refers to the BufferView that has the focus,
94 /// including for example the one that is created when you use the
95 /// advanced search and replace pane.
96 /// \return the currently selected buffer view.
97 BufferView * currentBufferView();
98 BufferView const * currentBufferView() const;
100 /// The document BufferView always refers to the view's main document
101 /// BufferView. So, even if the BufferView in e.g., the advanced
102 /// search and replace pane has the focus.
103 /// \return the current document buffer view.
104 BufferView * documentBufferView();
105 BufferView const * documentBufferView() const;
107 void newDocument(std::string const & filename,
110 /// display a message in the view
111 /// could be called from any thread
112 void message(docstring const &);
114 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
115 /// dispatch command.
116 /// \return true if the \c FuncRequest has been dispatched.
117 void dispatch(FuncRequest const & cmd, DispatchResult & dr);
120 /// Update the completion popup and the inline completion state.
121 /// If \c start is true, then a new completion might be started.
122 /// If \c keep is true, an active completion will be kept active
123 /// even though the cursor moved. The update flags of \c cur might
125 void updateCompletion(Cursor & cur, bool start, bool keep);
129 bool hasFocus() const;
132 void focusInEvent(QFocusEvent * e);
133 /// Add a Buffer to the View
134 /// \param b Buffer to set.
135 /// \param switch_to Whether to set it to the current workarea.
136 void setBuffer(Buffer * b, bool switch_to = true);
138 /// load a document into the current workarea.
139 Buffer * loadDocument(
140 support::FileName const & name, ///< File to load.
141 bool tolastfiles = true ///< append to the "Open recent" menu?
144 /// add toolbar, if newline==true, add a toolbar break before the toolbar
145 GuiToolbar * makeToolbar(ToolbarInfo const & tbinfo, bool newline);
146 void updateStatusBar();
148 /// updates the possible layouts selectable
149 void updateLayoutList();
150 void updateToolbars();
153 LayoutBox * getLayoutDialog() const;
155 /// hides the workarea and makes sure it is clean
156 bool hideWorkArea(GuiWorkArea * wa);
157 /// closes workarea; close buffer only if no other workareas point to it
158 bool closeWorkArea(GuiWorkArea * wa);
159 /// closes the buffer
160 bool closeBuffer(Buffer & buf);
162 void openDocument(std::string const & filename);
164 void importDocument(std::string const &);
166 /// \name GuiBufferDelegate.
168 void resetAutosaveTimers();
169 // shows an error list
170 // if from_master is true, show master's error list
171 void errors(std::string const &, bool from_master = false);
172 void structureChanged();
173 void updateTocItem(std::string const &, DocIterator const &);
177 TocModels & tocModels();
179 /// called on timeout
182 /// check for external change of any opened buffer, mainly for svn usage
183 void checkExternallyModifiedBuffers();
185 /** redraw \c inset in all the BufferViews in which it is currently
186 * visible. If successful return a pointer to the owning Buffer.
188 Buffer const * updateInset(Inset const *);
190 /// \return the \c Workarea associated to \p Buffer
191 /// \retval 0 if no \c WorkArea is found.
192 GuiWorkArea * workArea(Buffer & buffer);
193 /// \return the \c Workarea at index \c index
194 GuiWorkArea * workArea(int index);
196 /// Add a \c WorkArea
197 /// \return the \c Workarea associated to \p Buffer
198 /// \retval 0 if no \c WorkArea is found.
199 GuiWorkArea * addWorkArea(Buffer & buffer);
200 /// \param work_area The current \c WorkArea, or \c NULL
201 void setCurrentWorkArea(GuiWorkArea * work_area);
203 void removeWorkArea(GuiWorkArea * work_area);
204 /// return the current WorkArea (the one that has the focus).
205 GuiWorkArea const * currentWorkArea() const;
206 /// return the current WorkArea (the one that has the focus).
207 GuiWorkArea * currentWorkArea();
209 /// return the current document WorkArea (it may not have the focus).
210 GuiWorkArea const * currentMainWorkArea() const;
211 /// return the current document WorkArea (it may not have the focus).
212 GuiWorkArea * currentMainWorkArea();
214 /// Current ratio between physical pixels and device-independent pixels
215 double pixelRatio() const;
219 void triggerShowDialog(QString const & qname, QString const & qdata, Inset * inset);
220 // emitted when the work area or its buffer view changed
221 void bufferViewChanged();
227 /// clear any temporary message and replace with current status.
230 void updateWindowTitle(GuiWorkArea * wa);
232 void disableShellEscape();
236 void resetWindowTitle();
239 void on_currentWorkAreaChanged(GuiWorkArea *);
241 void onBufferViewChanged();
243 void on_lastWorkAreaRemoved();
245 /// For completion of autosave or export threads.
246 void processingThreadStarted();
247 void processingThreadFinished();
248 void autoSaveThreadFinished();
250 /// must be called in GUI thread
251 void doShowDialog(QString const & qname, QString const & qdata,
254 /// must be called from GUI thread
255 void updateStatusBarMessage(QString const & str);
256 void clearMessageText();
259 void toolBarPopup(const QPoint &pos);
262 /// Open given child document in current buffer directory.
263 void openChildDocument(std::string const & filename);
264 /// Close current document buffer.
266 /// Close all document buffers.
267 bool closeBufferAll();
269 TabWorkArea * addTabWorkArea();
271 /// connect to signals in the given BufferView
272 void connectBufferView(BufferView & bv);
273 /// disconnect from signals in the given BufferView
274 void disconnectBufferView();
275 /// connect to signals in the given buffer
276 void connectBuffer(Buffer & buf);
277 /// disconnect from signals in the given buffer
278 void disconnectBuffer();
280 void dragEnterEvent(QDragEnterEvent * ev);
282 void dropEvent(QDropEvent * ev);
283 /// make sure we quit cleanly
284 void closeEvent(QCloseEvent * e);
286 void showEvent(QShowEvent *);
288 /// in order to catch Tab key press.
289 bool event(QEvent * e);
290 bool focusNextPrevChild(bool);
293 bool goToFileRow(std::string const & argument);
296 class GuiViewPrivate;
301 /// dialogs for this view
307 /// Hide all visible dialogs
308 void hideAll() const;
310 /// Update all visible dialogs.
312 * Check the status of all visible dialogs and disable or reenable
313 * them as appropriate.
315 * Disabling is needed for example when a dialog is open and the
316 * cursor moves to a position where the corresponding inset is not
319 void updateDialogs();
321 /** Show dialog could be called from arbitrary threads.
322 \param name == "bibtex", "citation" etc; an identifier used to
323 launch a particular dialog.
324 \param data is a string representation of the Inset contents.
325 It is often little more than the output from Inset::write.
326 It is passed to, and parsed by, the frontend dialog.
327 Several of these dialogs do not need any data,
328 so it defaults to string().
329 \param inset ownership is _not_ passed to the frontend dialog.
330 It is stored internally and used by the kernel to ascertain
331 what to do with the FuncRequest dispatched from the frontend
332 dialog on 'Apply'; should it be used to create a new inset at
333 the current cursor position or modify an existing, 'open' inset?
335 void showDialog(std::string const & name,
336 std::string const & data, Inset * inset = 0);
338 /** \param name == "citation", "bibtex" etc; an identifier used
339 to reset the contents of a particular dialog with \param data.
340 See the comments to 'show', above.
342 void updateDialog(std::string const & name, std::string const & data);
344 /** All Dialogs of the given \param name will be closed if they are
345 connected to the given \param inset.
347 void hideDialog(std::string const & name, Inset * inset);
349 void disconnectDialog(std::string const & name);
351 bool develMode() const { return devel_mode_; }
354 /// Saves the layout and geometry of the window
355 void saveLayout() const;
356 /// Saves the settings of toolbars and all dialogs
357 void saveUISettings() const;
359 bool restoreLayout();
361 GuiToolbar * toolbar(std::string const & name);
363 void constructToolbars();
367 void initToolbar(std::string const & name);
368 /// Update lock (all) toolbars position
369 void updateLockToolbars();
371 bool lfunUiToggle(std::string const & ui_component);
373 void toggleFullScreen();
375 void insertLyXFile(docstring const & fname);
377 /// Open Export As ... dialog. \p iformat is the format the
378 /// filter is initially set to.
379 bool exportBufferAs(Buffer & b, docstring const & iformat);
382 enum RenameKind { LV_WRITE_AS, LV_VC_RENAME, LV_VC_COPY };
383 /// Save a buffer as a new file.
385 Write a buffer to a new file name and rename the buffer
386 according to the new file name.
388 This function is e.g. used by menu callbacks and
389 LFUN_BUFFER_WRITE_AS.
391 If 'newname' is empty, the user is asked via a
392 dialog for the buffer's new name and location.
394 If 'newname' is non-empty and has an absolute path, that is used.
395 Otherwise the base directory of the buffer is used as the base
396 for any relative path in 'newname'.
398 \p kind controls what is done besides the pure renaming:
399 * LV_WRITE_AS => The buffer is written without version control actions.
400 * LV_VC_RENAME => The file is renamed in version control.
401 * LV_VC_COPY => The file is copied in version control.
403 bool renameBuffer(Buffer & b, docstring const & newname,
404 RenameKind kind = LV_WRITE_AS);
406 bool saveBuffer(Buffer & b);
407 /// save and rename buffer to fn. If fn is empty, the buffer
408 /// is just saved as the filename it already has.
409 bool saveBuffer(Buffer & b, support::FileName const & fn);
410 /// closes a workarea, if close_buffer is true the buffer will
411 /// also be released, otherwise the buffer will be hidden.
412 bool closeWorkArea(GuiWorkArea * wa, bool close_buffer);
413 /// closes the tabworkarea and all tabs. If we are in a close event,
414 /// all buffers will be closed, otherwise they will be hidden.
415 bool closeTabWorkArea(TabWorkArea * twa);
416 /// gives the user the possibility to save his work
417 /// or to discard the changes. If hiding is true, the
418 /// document will be reloaded.
419 bool saveBufferIfNeeded(Buffer & buf, bool hiding);
420 /// closes all workareas
421 bool closeWorkAreaAll();
422 /// write all open workareas into the session file
423 void writeSession() const;
424 /// is the buffer in this workarea also shown in another tab ?
425 /// This tab can either be in the same view or in another one.
426 bool inMultiTabs(GuiWorkArea * wa);
427 /// is the buffer shown in some other view ?
428 bool inOtherView(Buffer & buf);
430 enum NextOrPrevious {
435 void gotoNextOrPreviousBuffer(NextOrPrevious np, bool const move);
437 /// Is the dialog currently visible?
438 bool isDialogVisible(std::string const & name) const;
440 Dialog * findOrBuild(std::string const & name, bool hide_it);
442 Dialog * build(std::string const & name);
444 bool reloadBuffer(Buffer & buffer);
446 void dispatchVC(FuncRequest const & cmd, DispatchResult & dr);
448 void dispatchToBufferView(FuncRequest const & cmd, DispatchResult & dr);
455 /// flag to avoid two concurrent close events.
457 /// if the view is busy the cursor shouldn't blink for instance.
458 /// This counts the number of times more often we called
459 /// setBusy(true) compared to setBusy(false), so we can nest
460 /// functions that call setBusy;
463 /// Request to open the command toolbar if it is "auto"
464 bool command_execute_;
465 /// Request to give focus to minibuffer
466 bool minibuffer_focus_;
468 /// Statusbar widget that shows shell-escape status
469 QLabel * shell_escape_;
470 /// Statusbar widget that shows read-only status
472 /// Statusbar widget that shows version control status
473 QLabel * version_control_;
475 /// The rate from which the actual zoom value is calculated
476 /// from the default zoom pref
477 double zoom_ratio_ = 1.0;
478 /// Minimum zoom percentage
479 static int const zoom_min_ = 10;
481 // movability flag of all toolbars
482 bool toolbarsMovable_;
489 class SEMenu : public QMenu
493 explicit SEMenu(QWidget * parent);
496 void showMenu(QPoint const &) { exec(QCursor::pos()); }
499 } // namespace frontend