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;
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);
119 void restartCursor();
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 void errors(std::string const &, bool from_master = false);
170 void structureChanged();
171 void updateTocItem(std::string const &, DocIterator const &);
175 TocModels & tocModels();
177 /// called on timeout
180 /// check for external change of any opened buffer, mainly for svn usage
181 void checkExternallyModifiedBuffers();
183 /** redraw \c inset in all the BufferViews in which it is currently
184 * visible. If successful return a pointer to the owning Buffer.
186 Buffer const * updateInset(Inset const *);
188 /// \return the \c Workarea associated to \p Buffer
189 /// \retval 0 if no \c WorkArea is found.
190 GuiWorkArea * workArea(Buffer & buffer);
191 /// \return the \c Workarea at index \c index
192 GuiWorkArea * workArea(int index);
194 /// Add a \c WorkArea
195 /// \return the \c Workarea associated to \p Buffer
196 /// \retval 0 if no \c WorkArea is found.
197 GuiWorkArea * addWorkArea(Buffer & buffer);
198 /// \param work_area The current \c WorkArea, or \c NULL
199 void setCurrentWorkArea(GuiWorkArea * work_area);
201 void removeWorkArea(GuiWorkArea * work_area);
202 /// return the current WorkArea (the one that has the focus).
203 GuiWorkArea const * currentWorkArea() const;
204 /// return the current WorkArea (the one that has the focus).
205 GuiWorkArea * currentWorkArea();
207 /// return the current document WorkArea (it may not have the focus).
208 GuiWorkArea const * currentMainWorkArea() const;
209 /// return the current document WorkArea (it may not have the focus).
210 GuiWorkArea * currentMainWorkArea();
212 /// Current ratio between physical pixels and device-independent pixels
213 double pixelRatio() const;
217 void triggerShowDialog(QString const & qname, QString const & qdata, Inset * inset);
218 // emitted when the work area or its buffer view changed
219 void bufferViewChanged();
225 /// clear any temporary message and replace with current status.
228 void updateWindowTitle(GuiWorkArea * wa);
232 void resetWindowTitle();
235 void on_currentWorkAreaChanged(GuiWorkArea *);
237 void onBufferViewChanged();
239 void on_lastWorkAreaRemoved();
241 /// For completion of autosave or export threads.
242 void processingThreadStarted();
243 void processingThreadFinished();
244 void autoSaveThreadFinished();
246 /// must be called in GUI thread
247 void doShowDialog(QString const & qname, QString const & qdata,
250 /// must be called from GUI thread
251 void updateStatusBarMessage(QString const & str);
252 void clearMessageText();
255 void toolBarPopup(const QPoint &pos);
258 /// Open given child document in current buffer directory.
259 void openChildDocument(std::string const & filename);
260 /// Close current document buffer.
262 /// Close all document buffers.
263 bool closeBufferAll();
265 TabWorkArea * addTabWorkArea();
267 /// connect to signals in the given BufferView
268 void connectBufferView(BufferView & bv);
269 /// disconnect from signals in the given BufferView
270 void disconnectBufferView();
271 /// connect to signals in the given buffer
272 void connectBuffer(Buffer & buf);
273 /// disconnect from signals in the given buffer
274 void disconnectBuffer();
276 void dragEnterEvent(QDragEnterEvent * ev);
278 void dropEvent(QDropEvent * ev);
279 /// make sure we quit cleanly
280 void closeEvent(QCloseEvent * e);
282 void showEvent(QShowEvent *);
284 /// in order to catch Tab key press.
285 bool event(QEvent * e);
286 bool focusNextPrevChild(bool);
289 bool goToFileRow(std::string const & argument);
292 class GuiViewPrivate;
297 /// dialogs for this view
303 /// Hide all visible dialogs
304 void hideAll() const;
306 /// Update all visible dialogs.
308 * Check the status of all visible dialogs and disable or reenable
309 * them as appropriate.
311 * Disabling is needed for example when a dialog is open and the
312 * cursor moves to a position where the corresponding inset is not
315 void updateDialogs();
317 /** Show dialog could be called from arbitrary threads.
318 \param name == "bibtex", "citation" etc; an identifier used to
319 launch a particular dialog.
320 \param data is a string representation of the Inset contents.
321 It is often little more than the output from Inset::write.
322 It is passed to, and parsed by, the frontend dialog.
323 Several of these dialogs do not need any data,
324 so it defaults to string().
325 \param inset ownership is _not_ passed to the frontend dialog.
326 It is stored internally and used by the kernel to ascertain
327 what to do with the FuncRequest dispatched from the frontend
328 dialog on 'Apply'; should it be used to create a new inset at
329 the current cursor position or modify an existing, 'open' inset?
331 void showDialog(std::string const & name,
332 std::string const & data, Inset * inset = 0);
334 /** \param name == "citation", "bibtex" etc; an identifier used
335 to reset the contents of a particular dialog with \param data.
336 See the comments to 'show', above.
338 void updateDialog(std::string const & name, std::string const & data);
340 /** All Dialogs of the given \param name will be closed if they are
341 connected to the given \param inset.
343 void hideDialog(std::string const & name, Inset * inset);
345 void disconnectDialog(std::string const & name);
348 /// Saves the layout and geometry of the window
349 void saveLayout() const;
350 /// Saves the settings of toolbars and all dialogs
351 void saveUISettings() const;
353 bool restoreLayout();
355 GuiToolbar * toolbar(std::string const & name);
357 void constructToolbars();
361 void initToolbar(std::string const & name);
362 /// Update lock (all) toolbars position
363 void updateLockToolbars();
365 bool lfunUiToggle(std::string const & ui_component);
367 void toggleFullScreen();
369 void insertLyXFile(docstring const & fname);
371 /// Open Export As ... dialog. \p iformat is the format the
372 /// filter is initially set to.
373 bool exportBufferAs(Buffer & b, docstring const & iformat);
376 enum RenameKind { LV_WRITE_AS, LV_VC_RENAME, LV_VC_COPY };
377 /// Save a buffer as a new file.
379 Write a buffer to a new file name and rename the buffer
380 according to the new file name.
382 This function is e.g. used by menu callbacks and
383 LFUN_BUFFER_WRITE_AS.
385 If 'newname' is empty, the user is asked via a
386 dialog for the buffer's new name and location.
388 If 'newname' is non-empty and has an absolute path, that is used.
389 Otherwise the base directory of the buffer is used as the base
390 for any relative path in 'newname'.
392 \p kind controls what is done besides the pure renaming:
393 * LV_WRITE_AS => The buffer is written without version control actions.
394 * LV_VC_RENAME => The file is renamed in version control.
395 * LV_VC_COPY => The file is copied in version control.
397 bool renameBuffer(Buffer & b, docstring const & newname,
398 RenameKind kind = LV_WRITE_AS);
400 bool saveBuffer(Buffer & b);
401 /// save and rename buffer to fn. If fn is empty, the buffer
402 /// is just saved as the filename it already has.
403 bool saveBuffer(Buffer & b, support::FileName const & fn);
404 /// closes a workarea, if close_buffer is true the buffer will
405 /// also be released, otherwise the buffer will be hidden.
406 bool closeWorkArea(GuiWorkArea * wa, bool close_buffer);
407 /// closes the tabworkarea and all tabs. If we are in a close event,
408 /// all buffers will be closed, otherwise they will be hidden.
409 bool closeTabWorkArea(TabWorkArea * twa);
410 /// gives the user the possibility to save his work
411 /// or to discard the changes. If hiding is true, the
412 /// document will be reloaded.
413 bool saveBufferIfNeeded(Buffer & buf, bool hiding);
414 /// closes all workareas
415 bool closeWorkAreaAll();
416 /// write all open workareas into the session file
417 void writeSession() const;
418 /// is the buffer in this workarea also shown in another tab ?
419 /// This tab can either be in the same view or in another one.
420 bool inMultiTabs(GuiWorkArea * wa);
421 /// is the buffer shown in some other view ?
422 bool inOtherView(Buffer & buf);
424 enum NextOrPrevious {
429 void gotoNextOrPreviousBuffer(NextOrPrevious np, bool const move);
431 /// Is the dialog currently visible?
432 bool isDialogVisible(std::string const & name) const;
434 Dialog * findOrBuild(std::string const & name, bool hide_it);
436 Dialog * build(std::string const & name);
438 bool reloadBuffer(Buffer & buffer);
440 void dispatchVC(FuncRequest const & cmd, DispatchResult & dr);
442 void dispatchToBufferView(FuncRequest const & cmd, DispatchResult & dr);
449 /// flag to avoid two concurrent close events.
451 /// if the view is busy the cursor shouldn't blink for instance.
452 /// This counts the number of times more often we called
453 /// setBusy(true) compared to setBusy(false), so we can nest
454 /// functions that call setBusy;
457 /// Request to open the command toolbar if it is "auto"
458 bool command_execute_;
459 /// Request to give focus to minibuffer
460 bool minibuffer_focus_;
462 /// Statusbar widget that shows read-only status
464 /// Statusbar widget that shows version control status
465 QLabel * version_control_;
467 /// Minimum zoom percentage
468 static int const zoom_min_ = 10;
470 // movability flag of all toolbars
471 bool toolbarsMovable_;
474 } // namespace frontend