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 /// set a buffer to the current workarea.
134 void setBuffer(Buffer * b); ///< \c Buffer to set.
136 /// load a document into the current workarea.
137 Buffer * loadDocument(
138 support::FileName const & name, ///< File to load.
139 bool tolastfiles = true ///< append to the "Open recent" menu?
142 /// add toolbar, if newline==true, add a toolbar break before the toolbar
143 GuiToolbar * makeToolbar(ToolbarInfo const & tbinfo, bool newline);
144 void updateStatusBar();
146 /// updates the possible layouts selectable
147 void updateLayoutList();
148 void updateToolbars();
149 QMenu * createPopupMenu();
152 LayoutBox * getLayoutDialog() const;
154 /// hides the workarea and makes sure it is clean
155 bool hideWorkArea(GuiWorkArea * wa);
156 /// closes workarea; close buffer only if no other workareas point to it
157 bool closeWorkArea(GuiWorkArea * wa);
158 /// closes the buffer
159 bool closeBuffer(Buffer & buf);
161 void openDocument(std::string const & filename);
163 void importDocument(std::string const &);
165 /// \name GuiBufferDelegate.
167 void resetAutosaveTimers();
168 void errors(std::string const &, bool from_master = false);
169 void structureChanged();
170 void updateTocItem(std::string const &, DocIterator const &);
174 TocModels & tocModels();
176 /// called on timeout
179 /// check for external change of any opened buffer, mainly for svn usage
180 void checkExternallyModifiedBuffers();
182 /** redraw \c inset in all the BufferViews in which it is currently
183 * visible. If successful return a pointer to the owning Buffer.
185 Buffer const * updateInset(Inset const *);
187 /// \return the \c Workarea associated to \p Buffer
188 /// \retval 0 if no \c WorkArea is found.
189 GuiWorkArea * workArea(Buffer & buffer);
190 /// \return the \c Workarea at index \c index
191 GuiWorkArea * workArea(int index);
193 /// Add a \c WorkArea
194 /// \return the \c Workarea associated to \p Buffer
195 /// \retval 0 if no \c WorkArea is found.
196 GuiWorkArea * addWorkArea(Buffer & buffer);
197 /// \param work_area The current \c WorkArea, or \c NULL
198 void setCurrentWorkArea(GuiWorkArea * work_area);
200 void removeWorkArea(GuiWorkArea * work_area);
201 /// return the current WorkArea (the one that has the focus).
202 GuiWorkArea const * currentWorkArea() const;
203 /// return the current WorkArea (the one that has the focus).
204 GuiWorkArea * currentWorkArea();
206 /// return the current document WorkArea (it may not have the focus).
207 GuiWorkArea const * currentMainWorkArea() const;
208 /// return the current document WorkArea (it may not have the focus).
209 GuiWorkArea * currentMainWorkArea();
211 /// Current ratio between physical pixels and device-independent pixels
212 double pixelRatio() const;
216 void triggerShowDialog(QString const & qname, QString const & qdata, Inset * inset);
222 /// clear any temporary message and replace with current status.
225 void updateWindowTitle(GuiWorkArea * wa);
229 void resetWindowTitle();
232 void on_currentWorkAreaChanged(GuiWorkArea *);
234 void on_lastWorkAreaRemoved();
236 /// slots to change the icon size
237 void smallSizedIcons();
238 void normalSizedIcons();
239 void bigSizedIcons();
240 void hugeSizedIcons();
241 void giantSizedIcons();
243 /// For completion of autosave or export threads.
244 void processingThreadStarted();
245 void processingThreadFinished();
246 void autoSaveThreadFinished();
248 /// must be called in GUI thread
249 void doShowDialog(QString const & qname, QString const & qdata,
252 /// must be called from GUI thread
253 void updateStatusBarMessage(QString const & str);
254 void clearMessageText();
257 /// Open given child document in current buffer directory.
258 void openChildDocument(std::string const & filename);
259 /// Close current document buffer.
261 /// Close all document buffers.
262 bool closeBufferAll();
264 TabWorkArea * addTabWorkArea();
266 /// connect to signals in the given BufferView
267 void connectBufferView(BufferView & bv);
268 /// disconnect from signals in the given BufferView
269 void disconnectBufferView();
270 /// connect to signals in the given buffer
271 void connectBuffer(Buffer & buf);
272 /// disconnect from signals in the given buffer
273 void disconnectBuffer();
275 void dragEnterEvent(QDragEnterEvent * ev);
277 void dropEvent(QDropEvent * ev);
278 /// make sure we quit cleanly
279 void closeEvent(QCloseEvent * e);
281 void showEvent(QShowEvent *);
283 /// in order to catch Tab key press.
284 bool event(QEvent * e);
285 bool focusNextPrevChild(bool);
288 bool goToFileRow(std::string const & argument);
291 class GuiViewPrivate;
296 /// dialogs for this view
302 /// Hide all visible dialogs
303 void hideAll() const;
305 /// Update all visible dialogs.
307 * Check the status of all visible dialogs and disable or reenable
308 * them as appropriate.
310 * Disabling is needed for example when a dialog is open and the
311 * cursor moves to a position where the corresponding inset is not
314 void updateDialogs();
316 /** Show dialog could be called from arbitrary threads.
317 \param name == "bibtex", "citation" etc; an identifier used to
318 launch a particular dialog.
319 \param data is a string representation of the Inset contents.
320 It is often little more than the output from Inset::write.
321 It is passed to, and parsed by, the frontend dialog.
322 Several of these dialogs do not need any data,
323 so it defaults to string().
324 \param inset ownership is _not_ passed to the frontend dialog.
325 It is stored internally and used by the kernel to ascertain
326 what to do with the FuncRequest dispatched from the frontend
327 dialog on 'Apply'; should it be used to create a new inset at
328 the current cursor position or modify an existing, 'open' inset?
330 void showDialog(std::string const & name,
331 std::string const & data, Inset * inset = 0);
333 /** \param name == "citation", "bibtex" etc; an identifier used
334 to reset the contents of a particular dialog with \param data.
335 See the comments to 'show', above.
337 void updateDialog(std::string const & name, std::string const & data);
339 /** All Dialogs of the given \param name will be closed if they are
340 connected to the given \param inset.
342 void hideDialog(std::string const & name, Inset * inset);
344 void disconnectDialog(std::string const & name);
347 /// Saves the layout and geometry of the window
348 void saveLayout() const;
349 /// Saves the settings of toolbars and all dialogs
350 void saveUISettings() const;
352 bool restoreLayout();
354 GuiToolbar * toolbar(std::string const & name);
356 void constructToolbars();
360 void initToolbar(std::string const & name);
362 bool lfunUiToggle(std::string const & ui_component);
364 void toggleFullScreen();
366 void insertLyXFile(docstring const & fname);
368 /// Open Export As ... dialog. \p iformat is the format the
369 /// filter is initially set to.
370 bool exportBufferAs(Buffer & b, docstring const & iformat);
373 enum RenameKind { LV_WRITE_AS, LV_VC_RENAME, LV_VC_COPY };
374 /// Save a buffer as a new file.
376 Write a buffer to a new file name and rename the buffer
377 according to the new file name.
379 This function is e.g. used by menu callbacks and
380 LFUN_BUFFER_WRITE_AS.
382 If 'newname' is empty, the user is asked via a
383 dialog for the buffer's new name and location.
385 If 'newname' is non-empty and has an absolute path, that is used.
386 Otherwise the base directory of the buffer is used as the base
387 for any relative path in 'newname'.
389 \p kind controls what is done besides the pure renaming:
390 * LV_WRITE_AS => The buffer is written without version control actions.
391 * LV_VC_RENAME => The file is renamed in version control.
392 * LV_VC_COPY => The file is copied in version control.
394 bool renameBuffer(Buffer & b, docstring const & newname,
395 RenameKind kind = LV_WRITE_AS);
397 bool saveBuffer(Buffer & b);
398 /// save and rename buffer to fn. If fn is empty, the buffer
399 /// is just saved as the filename it already has.
400 bool saveBuffer(Buffer & b, support::FileName const & fn);
401 /// closes a workarea, if close_buffer is true the buffer will
402 /// also be released, otherwise the buffer will be hidden.
403 bool closeWorkArea(GuiWorkArea * wa, bool close_buffer);
404 /// closes the tabworkarea and all tabs. If we are in a close event,
405 /// all buffers will be closed, otherwise they will be hidden.
406 bool closeTabWorkArea(TabWorkArea * twa);
407 /// gives the user the possibility to save his work
408 /// or to discard the changes. If hiding is true, the
409 /// document will be reloaded.
410 bool saveBufferIfNeeded(Buffer & buf, bool hiding);
411 /// closes all workareas
412 bool closeWorkAreaAll();
413 /// write all open workareas into the session file
414 void writeSession() const;
415 /// is the buffer in this workarea also shown in another tab ?
416 /// This tab can either be in the same view or in another one.
417 bool inMultiTabs(GuiWorkArea * wa);
418 /// is the buffer shown in some other view ?
419 bool inOtherView(Buffer & buf);
421 enum NextOrPrevious {
426 void gotoNextOrPreviousBuffer(NextOrPrevious np, bool const move);
428 /// Is the dialog currently visible?
429 bool isDialogVisible(std::string const & name) const;
431 Dialog * findOrBuild(std::string const & name, bool hide_it);
433 Dialog * build(std::string const & name);
435 bool reloadBuffer(Buffer & buffer);
437 void dispatchVC(FuncRequest const & cmd, DispatchResult & dr);
439 void dispatchToBufferView(FuncRequest const & cmd, DispatchResult & dr);
446 /// flag to avoid two concurrent close events.
448 /// if the view is busy the cursor shouldn't blink for instance.
449 /// This counts the number of times more often we called
450 /// setBusy(true) compared to setBusy(false), so we can nest
451 /// functions that call setBusy;
454 /// Request to open the command toolbar if it is "auto"
455 bool command_execute_;
456 /// Request to give focus to minibuffer
457 bool minibuffer_focus_;
459 /// Statusbar widget that shows read-only status
461 /// Statusbar widget that shows version control status
462 QLabel * version_control_;
466 } // namespace frontend