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);
187 /// \return the \c Workarea at index \c index
188 GuiWorkArea * workArea(int index);
190 /// Add a \c WorkArea
191 /// \return the \c Workarea associated to \p Buffer
192 /// \retval 0 if no \c WorkArea is found.
193 GuiWorkArea * addWorkArea(Buffer & buffer);
194 /// \param work_area The current \c WorkArea, or \c NULL
195 void setCurrentWorkArea(GuiWorkArea * work_area);
197 void removeWorkArea(GuiWorkArea * work_area);
198 /// return the current WorkArea (the one that has the focus).
199 GuiWorkArea const * currentWorkArea() const;
200 /// return the current WorkArea (the one that has the focus).
201 GuiWorkArea * currentWorkArea();
203 /// return the current document WorkArea (it may not have the focus).
204 GuiWorkArea const * currentMainWorkArea() const;
205 /// return the current document WorkArea (it may not have the focus).
206 GuiWorkArea * currentMainWorkArea();
210 void triggerShowDialog(QString const & qname, QString const & qdata, Inset * inset);
214 /// clear any temporary message and replace with current status.
219 void updateWindowTitle(GuiWorkArea * wa);
221 void resetWindowTitleAndIconText();
224 void on_currentWorkAreaChanged(GuiWorkArea *);
226 void on_lastWorkAreaRemoved();
228 /// slots to change the icon size
229 void smallSizedIcons();
230 void normalSizedIcons();
231 void bigSizedIcons();
233 /// For completion of autosave or export threads.
234 void processingThreadStarted();
235 void processingThreadFinished();
236 void indicateProcessing();
238 /// must be called in GUI thread
239 void doShowDialog(QString const & qname, QString const & qdata,
242 /// must be called from GUI thread
243 void updateStatusBarMessage(QString const & str);
244 void clearMessageText();
247 /// Open given child document in current buffer directory.
248 void openChildDocument(std::string const & filename);
249 /// Close current document buffer.
251 /// Close all document buffers.
252 bool closeBufferAll();
254 TabWorkArea * addTabWorkArea();
256 /// connect to signals in the given BufferView
257 void connectBufferView(BufferView & bv);
258 /// disconnect from signals in the given BufferView
259 void disconnectBufferView();
260 /// connect to signals in the given buffer
261 void connectBuffer(Buffer & buf);
262 /// disconnect from signals in the given buffer
263 void disconnectBuffer();
265 void dragEnterEvent(QDragEnterEvent * ev);
267 void dropEvent(QDropEvent * ev);
268 /// make sure we quit cleanly
269 void closeEvent(QCloseEvent * e);
271 void showEvent(QShowEvent *);
273 /// in order to catch Tab key press.
274 bool event(QEvent * e);
275 bool focusNextPrevChild(bool);
278 bool goToFileRow(std::string const & argument);
281 struct GuiViewPrivate;
286 /// dialogs for this view
292 /// Hide all visible dialogs
293 void hideAll() const;
295 /// Update all visible dialogs.
297 * Check the status of all visible dialogs and disable or reenable
298 * them as appropriate.
300 * Disabling is needed for example when a dialog is open and the
301 * cursor moves to a position where the corresponding inset is not
304 void updateDialogs();
306 /** Show dialog could be called from arbitrary threads.
307 \param name == "bibtex", "citation" etc; an identifier used to
308 launch a particular dialog.
309 \param data is a string representation of the Inset contents.
310 It is often little more than the output from Inset::write.
311 It is passed to, and parsed by, the frontend dialog.
312 Several of these dialogs do not need any data,
313 so it defaults to string().
314 \param inset ownership is _not_ passed to the frontend dialog.
315 It is stored internally and used by the kernel to ascertain
316 what to do with the FuncRequest dispatched from the frontend
317 dialog on 'Apply'; should it be used to create a new inset at
318 the current cursor position or modify an existing, 'open' inset?
320 void showDialog(std::string const & name,
321 std::string const & data, Inset * inset = 0);
323 /** \param name == "citation", "bibtex" etc; an identifier used
324 to reset the contents of a particular dialog with \param data.
325 See the comments to 'show', above.
327 void updateDialog(std::string const & name, std::string const & data);
329 /** All Dialogs of the given \param name will be closed if they are
330 connected to the given \param inset.
332 void hideDialog(std::string const & name, Inset * inset);
334 void disconnectDialog(std::string const & name);
338 void saveLayout() const;
340 bool restoreLayout();
342 GuiToolbar * toolbar(std::string const & name);
344 void constructToolbars();
348 bool lfunUiToggle(std::string const & ui_component);
350 void toggleFullScreen();
352 void insertLyXFile(docstring const & fname);
354 void insertPlaintextFile(docstring const & fname,
357 /// Save a buffer as a new file.
359 Write a buffer to a new file name and rename the buffer
360 according to the new file name.
362 This function is e.g. used by menu callbacks and
363 LFUN_BUFFER_WRITE_AS.
365 If 'newname' is empty, the user is asked via a
366 dialog for the buffer's new name and location.
368 If 'newname' is non-empty and has an absolute path, that is used.
369 Otherwise the base directory of the buffer is used as the base
370 for any relative path in 'newname'.
372 bool renameBuffer(Buffer & b, docstring const & newname);
374 bool saveBuffer(Buffer & b);
375 /// save and rename buffer to fn. If fn is empty, the buffer
376 /// is just saved as the filename it already has.
377 bool saveBuffer(Buffer & b, support::FileName const & fn);
378 /// closes a workarea, if close_buffer is true the buffer will
379 /// also be released, otherwise the buffer will be hidden.
380 bool closeWorkArea(GuiWorkArea * wa, bool close_buffer);
381 /// closes the tabworkarea and all tabs. If we are in a close event,
382 /// all buffers will be closed, otherwise they will be hidden.
383 bool closeTabWorkArea(TabWorkArea * twa);
384 /// gives the user the possibility to save his work
385 /// or to discard the changes. If hiding is true, the
386 /// document will be reloaded.
387 bool saveBufferIfNeeded(Buffer & buf, bool hiding);
388 /// closes all workareas
389 bool closeWorkAreaAll();
390 /// write all open workareas into the session file
391 void writeSession() const;
392 /// is the buffer in this workarea also shown in another tab ?
393 /// This tab can either be in the same view or in another one.
394 bool inMultiTabs(GuiWorkArea * wa);
395 /// is the buffer in this workarea also shown in another view ?
396 bool inMultiViews(GuiWorkArea * wa);
398 enum NextOrPrevious {
403 void gotoNextOrPreviousBuffer(NextOrPrevious np);
405 /// Is the dialog currently visible?
406 bool isDialogVisible(std::string const & name) const;
408 Dialog * findOrBuild(std::string const & name, bool hide_it);
410 Dialog * build(std::string const & name);
412 bool reloadBuffer(Buffer & buffer);
414 void dispatchVC(FuncRequest const & cmd, DispatchResult & dr);
416 void dispatchToBufferView(FuncRequest const & cmd, DispatchResult & dr);
423 /// flag to avoid two concurrent close events.
425 /// if the view is busy the cursor shouldn't blink for instance.
426 /// This counts the number of times more often we called
427 /// setBusy(true) compared to setBusy(false), so we can nest
428 /// functions that call setBusy;
433 } // namespace frontend