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 - Qt 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 /// Things that need to be done when the OSes session manager
79 /// requests a log out.
80 bool prepareAllBuffersForLogout();
82 int id() const { return id_; }
87 /// Signal that the any "auto" minibuffer can be closed now.
88 void resetCommandExecute();
90 /// \name Generic accessor functions
92 /// The current BufferView refers to the BufferView that has the focus,
93 /// including for example the one that is created when you use the
94 /// advanced search and replace pane.
95 /// \return the currently selected buffer view.
96 BufferView * currentBufferView();
97 BufferView const * currentBufferView() const;
99 /// The document BufferView always refers to the view's main document
100 /// BufferView. So, even if the BufferView in e.g., the advanced
101 /// search and replace pane has the focus.
102 /// \return the current document buffer view.
103 BufferView * documentBufferView();
104 BufferView const * documentBufferView() const;
106 void newDocument(std::string const & filename,
109 /// display a message in the view
110 /// could be called from any thread
111 void message(docstring const &);
113 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
114 /// dispatch command.
115 /// \return true if the \c FuncRequest has been dispatched.
116 void dispatch(FuncRequest const & cmd, DispatchResult & dr);
118 void restartCursor();
119 /// Update the completion popup and the inline completion state.
120 /// If \c start is true, then a new completion might be started.
121 /// If \c keep is true, an active completion will be kept active
122 /// even though the cursor moved. The update flags of \c cur might
124 void updateCompletion(Cursor & cur, bool start, bool keep);
128 bool hasFocus() const;
131 void focusInEvent(QFocusEvent * e);
132 /// set a buffer to the current workarea.
133 void setBuffer(Buffer * b); ///< \c Buffer to set.
135 /// load a document into the current workarea.
136 Buffer * loadDocument(
137 support::FileName const & name, ///< File to load.
138 bool tolastfiles = true ///< append to the "Open recent" menu?
141 /// add toolbar, if newline==true, add a toolbar break before the toolbar
142 GuiToolbar * makeToolbar(ToolbarInfo const & tbinfo, bool newline);
143 void updateStatusBar();
145 /// updates the possible layouts selectable
146 void updateLayoutList();
147 void updateToolbars();
148 QMenu * createPopupMenu();
151 LayoutBox * getLayoutDialog() const;
153 /// hides the workarea and makes sure it is clean
154 bool hideWorkArea(GuiWorkArea * wa);
155 /// closes workarea; close buffer only if no other workareas point to it
156 bool closeWorkArea(GuiWorkArea * wa);
157 /// closes the buffer
158 bool closeBuffer(Buffer & buf);
160 void openDocument(std::string const & filename);
162 void importDocument(std::string const &);
164 /// \name GuiBufferDelegate.
166 void resetAutosaveTimers();
167 void errors(std::string const &, bool from_master = false);
168 void structureChanged();
169 void updateTocItem(std::string const &, DocIterator const &);
173 TocModels & tocModels();
175 /// called on timeout
178 /// check for external change of any opened buffer, mainly for svn usage
179 void checkExternallyModifiedBuffers();
181 /** redraw \c inset in all the BufferViews in which it is currently
182 * visible. If successful return a pointer to the owning Buffer.
184 Buffer const * updateInset(Inset const *);
186 /// \return the \c Workarea associated to \p Buffer
187 /// \retval 0 if no \c WorkArea is found.
188 GuiWorkArea * workArea(Buffer & buffer);
189 /// \return the \c Workarea at index \c index
190 GuiWorkArea * workArea(int index);
192 /// Add a \c WorkArea
193 /// \return the \c Workarea associated to \p Buffer
194 /// \retval 0 if no \c WorkArea is found.
195 GuiWorkArea * addWorkArea(Buffer & buffer);
196 /// \param work_area The current \c WorkArea, or \c NULL
197 void setCurrentWorkArea(GuiWorkArea * work_area);
199 void removeWorkArea(GuiWorkArea * work_area);
200 /// return the current WorkArea (the one that has the focus).
201 GuiWorkArea const * currentWorkArea() const;
202 /// return the current WorkArea (the one that has the focus).
203 GuiWorkArea * currentWorkArea();
205 /// return the current document WorkArea (it may not have the focus).
206 GuiWorkArea const * currentMainWorkArea() const;
207 /// return the current document WorkArea (it may not have the focus).
208 GuiWorkArea * currentMainWorkArea();
210 /// Current ratio between physical pixels and device-independent pixels
211 double pixelRatio() const;
215 void triggerShowDialog(QString const & qname, QString const & qdata, Inset * inset);
221 /// clear any temporary message and replace with current status.
226 void updateWindowTitle(GuiWorkArea * wa);
228 void resetWindowTitleAndIconText();
231 void on_currentWorkAreaChanged(GuiWorkArea *);
233 void on_lastWorkAreaRemoved();
235 /// slots to change the icon size
236 void smallSizedIcons();
237 void normalSizedIcons();
238 void bigSizedIcons();
239 void hugeSizedIcons();
240 void giantSizedIcons();
242 /// For completion of autosave or export threads.
243 void processingThreadStarted();
244 void processingThreadFinished();
245 void autoSaveThreadFinished();
247 /// must be called in GUI thread
248 void doShowDialog(QString const & qname, QString const & qdata,
251 /// must be called from GUI thread
252 void updateStatusBarMessage(QString const & str);
253 void clearMessageText();
256 /// Open given child document in current buffer directory.
257 void openChildDocument(std::string const & filename);
258 /// Close current document buffer.
260 /// Close all document buffers.
261 bool closeBufferAll();
263 TabWorkArea * addTabWorkArea();
265 /// connect to signals in the given BufferView
266 void connectBufferView(BufferView & bv);
267 /// disconnect from signals in the given BufferView
268 void disconnectBufferView();
269 /// connect to signals in the given buffer
270 void connectBuffer(Buffer & buf);
271 /// disconnect from signals in the given buffer
272 void disconnectBuffer();
274 void dragEnterEvent(QDragEnterEvent * ev);
276 void dropEvent(QDropEvent * ev);
277 /// make sure we quit cleanly
278 void closeEvent(QCloseEvent * e);
280 void showEvent(QShowEvent *);
282 /// in order to catch Tab key press.
283 bool event(QEvent * e);
284 bool focusNextPrevChild(bool);
287 bool goToFileRow(std::string const & argument);
290 struct GuiViewPrivate;
295 /// dialogs for this view
301 /// Hide all visible dialogs
302 void hideAll() const;
304 /// Update all visible dialogs.
306 * Check the status of all visible dialogs and disable or reenable
307 * them as appropriate.
309 * Disabling is needed for example when a dialog is open and the
310 * cursor moves to a position where the corresponding inset is not
313 void updateDialogs();
315 /** Show dialog could be called from arbitrary threads.
316 \param name == "bibtex", "citation" etc; an identifier used to
317 launch a particular dialog.
318 \param data is a string representation of the Inset contents.
319 It is often little more than the output from Inset::write.
320 It is passed to, and parsed by, the frontend dialog.
321 Several of these dialogs do not need any data,
322 so it defaults to string().
323 \param inset ownership is _not_ passed to the frontend dialog.
324 It is stored internally and used by the kernel to ascertain
325 what to do with the FuncRequest dispatched from the frontend
326 dialog on 'Apply'; should it be used to create a new inset at
327 the current cursor position or modify an existing, 'open' inset?
329 void showDialog(std::string const & name,
330 std::string const & data, Inset * inset = 0);
332 /** \param name == "citation", "bibtex" etc; an identifier used
333 to reset the contents of a particular dialog with \param data.
334 See the comments to 'show', above.
336 void updateDialog(std::string const & name, std::string const & data);
338 /** All Dialogs of the given \param name will be closed if they are
339 connected to the given \param inset.
341 void hideDialog(std::string const & name, Inset * inset);
343 void disconnectDialog(std::string const & name);
346 /// Saves the layout and geometry of the window
347 void saveLayout() const;
348 /// Saves the settings of toolbars and all dialogs
349 void saveUISettings() const;
351 bool restoreLayout();
353 GuiToolbar * toolbar(std::string const & name);
355 void constructToolbars();
359 void initToolbar(std::string const & name);
361 bool lfunUiToggle(std::string const & ui_component);
363 void toggleFullScreen();
365 void insertLyXFile(docstring const & fname);
367 void insertPlaintextFile(docstring const & fname,
369 /// Open Export As ... dialog. \p iformat is the format the
370 /// filter is initially set to.
371 bool exportBufferAs(Buffer & b, docstring const & iformat);
374 enum RenameKind { LV_WRITE_AS, LV_VC_RENAME, LV_VC_COPY };
375 /// Save a buffer as a new file.
377 Write a buffer to a new file name and rename the buffer
378 according to the new file name.
380 This function is e.g. used by menu callbacks and
381 LFUN_BUFFER_WRITE_AS.
383 If 'newname' is empty, the user is asked via a
384 dialog for the buffer's new name and location.
386 If 'newname' is non-empty and has an absolute path, that is used.
387 Otherwise the base directory of the buffer is used as the base
388 for any relative path in 'newname'.
390 \p kind controls what is done besides the pure renaming:
391 * LV_WRITE_AS => The buffer is written without version control actions.
392 * LV_VC_RENAME => The file is renamed in version control.
393 * LV_VC_COPY => The file is copied in version control.
395 bool renameBuffer(Buffer & b, docstring const & newname,
396 RenameKind kind = LV_WRITE_AS);
398 bool saveBuffer(Buffer & b);
399 /// save and rename buffer to fn. If fn is empty, the buffer
400 /// is just saved as the filename it already has.
401 bool saveBuffer(Buffer & b, support::FileName const & fn);
402 /// closes a workarea, if close_buffer is true the buffer will
403 /// also be released, otherwise the buffer will be hidden.
404 bool closeWorkArea(GuiWorkArea * wa, bool close_buffer);
405 /// closes the tabworkarea and all tabs. If we are in a close event,
406 /// all buffers will be closed, otherwise they will be hidden.
407 bool closeTabWorkArea(TabWorkArea * twa);
408 /// gives the user the possibility to save his work
409 /// or to discard the changes. If hiding is true, the
410 /// document will be reloaded.
411 bool saveBufferIfNeeded(Buffer & buf, bool hiding);
412 /// closes all workareas
413 bool closeWorkAreaAll();
414 /// write all open workareas into the session file
415 void writeSession() const;
416 /// is the buffer in this workarea also shown in another tab ?
417 /// This tab can either be in the same view or in another one.
418 bool inMultiTabs(GuiWorkArea * wa);
419 /// is the buffer shown in some other view ?
420 bool inOtherView(Buffer & buf);
422 enum NextOrPrevious {
427 void gotoNextOrPreviousBuffer(NextOrPrevious np, bool const move);
429 /// Is the dialog currently visible?
430 bool isDialogVisible(std::string const & name) const;
432 Dialog * findOrBuild(std::string const & name, bool hide_it);
434 Dialog * build(std::string const & name);
436 bool reloadBuffer(Buffer & buffer);
438 void dispatchVC(FuncRequest const & cmd, DispatchResult & dr);
440 void dispatchToBufferView(FuncRequest const & cmd, DispatchResult & dr);
447 /// flag to avoid two concurrent close events.
449 /// if the view is busy the cursor shouldn't blink for instance.
450 /// This counts the number of times more often we called
451 /// setBusy(true) compared to setBusy(false), so we can nest
452 /// functions that call setBusy;
455 /// Request to open the command toolbar if it is "auto"
456 bool command_execute_;
460 } // namespace frontend