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_; }
84 /// \name Generic accessor functions
86 /// The current BufferView refers to the BufferView that has the focus,
87 /// including for example the one that is created when you use the
88 /// advanced search and replace pane.
89 /// \return the currently selected buffer view.
90 BufferView * currentBufferView();
91 BufferView const * currentBufferView() const;
93 /// The document BufferView always refers to the view's main document
94 /// BufferView. So, even if the BufferView in e.g., the advanced
95 /// search and replace pane has the focus.
96 /// \return the current document buffer view.
97 BufferView * documentBufferView();
98 BufferView const * documentBufferView() const;
100 void newDocument(std::string const & filename,
103 /// display a message in the view
104 /// could be called from any thread
105 void message(docstring const &);
107 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
108 /// dispatch command.
109 /// \return true if the \c FuncRequest has been dispatched.
110 void dispatch(FuncRequest const & cmd, DispatchResult & dr);
112 void restartCursor();
113 /// Update the completion popup and the inline completion state.
114 /// If \c start is true, then a new completion might be started.
115 /// If \c keep is true, an active completion will be kept active
116 /// even though the cursor moved. The update flags of \c cur might
118 void updateCompletion(Cursor & cur, bool start, bool keep);
124 void focusInEvent(QFocusEvent * e);
125 /// set a buffer to the current workarea.
126 void setBuffer(Buffer * b); ///< \c Buffer to set.
128 /// load a document into the current workarea.
129 Buffer * loadDocument(
130 support::FileName const & name, ///< File to load.
131 bool tolastfiles = true ///< append to the "Open recent" menu?
134 /// add toolbar, if newline==true, add a toolbar break before the toolbar
135 GuiToolbar * makeToolbar(ToolbarInfo const & tbinfo, bool newline);
136 void updateStatusBar();
138 /// updates the possible layouts selectable
139 void updateLayoutList();
140 void updateToolbars();
141 QMenu * createPopupMenu();
144 LayoutBox * getLayoutDialog() const;
146 /// hides the workarea and makes sure it is clean
147 bool hideWorkArea(GuiWorkArea * wa);
148 /// closes the workarea
149 bool closeWorkArea(GuiWorkArea * wa);
150 /// closes the buffer
151 bool closeBuffer(Buffer & buf);
153 void openDocument(std::string const & filename);
155 void importDocument(std::string const &);
157 /// \name GuiBufferDelegate.
159 void resetAutosaveTimers();
160 void errors(std::string const &, bool from_master = false);
161 void structureChanged();
162 void updateTocItem(std::string const &, DocIterator const &);
166 TocModels & tocModels();
168 /// called on timeout
171 /// check for external change of any opened buffer, mainly for svn usage
172 void checkExternallyModifiedBuffers();
174 /** redraw \c inset in all the BufferViews in which it is currently
175 * visible. If successful return a pointer to the owning Buffer.
177 Buffer const * updateInset(Inset const *);
179 /// \return the \c Workarea associated to \p Buffer
180 /// \retval 0 if no \c WorkArea is found.
181 GuiWorkArea * workArea(Buffer & buffer);
182 /// \return the \c Workarea at index \c index
183 GuiWorkArea * workArea(int index);
185 /// Add a \c WorkArea
186 /// \return the \c Workarea associated to \p Buffer
187 /// \retval 0 if no \c WorkArea is found.
188 GuiWorkArea * addWorkArea(Buffer & buffer);
189 /// \param work_area The current \c WorkArea, or \c NULL
190 void setCurrentWorkArea(GuiWorkArea * work_area);
192 void removeWorkArea(GuiWorkArea * work_area);
193 /// return the current WorkArea (the one that has the focus).
194 GuiWorkArea const * currentWorkArea() const;
195 /// return the current WorkArea (the one that has the focus).
196 GuiWorkArea * currentWorkArea();
198 /// return the current document WorkArea (it may not have the focus).
199 GuiWorkArea const * currentMainWorkArea() const;
200 /// return the current document WorkArea (it may not have the focus).
201 GuiWorkArea * currentMainWorkArea();
205 void triggerShowDialog(QString const & qname, QString const & qdata, Inset * inset);
211 /// clear any temporary message and replace with current status.
216 void updateWindowTitle(GuiWorkArea * wa);
218 void resetWindowTitleAndIconText();
221 void on_currentWorkAreaChanged(GuiWorkArea *);
223 void on_lastWorkAreaRemoved();
225 /// slots to change the icon size
226 void smallSizedIcons();
227 void normalSizedIcons();
228 void bigSizedIcons();
230 /// For completion of autosave or export threads.
231 void processingThreadStarted();
232 void processingThreadFinished(bool show_errors);
233 void processingThreadFinished();
234 void autoSaveThreadFinished();
236 /// must be called in GUI thread
237 void doShowDialog(QString const & qname, QString const & qdata,
240 /// must be called from GUI thread
241 void updateStatusBarMessage(QString const & str);
242 void clearMessageText();
245 /// Open given child document in current buffer directory.
246 void openChildDocument(std::string const & filename);
247 /// Close current document buffer.
249 /// Close all document buffers.
250 bool closeBufferAll();
252 TabWorkArea * addTabWorkArea();
254 /// connect to signals in the given BufferView
255 void connectBufferView(BufferView & bv);
256 /// disconnect from signals in the given BufferView
257 void disconnectBufferView();
258 /// connect to signals in the given buffer
259 void connectBuffer(Buffer & buf);
260 /// disconnect from signals in the given buffer
261 void disconnectBuffer();
263 void dragEnterEvent(QDragEnterEvent * ev);
265 void dropEvent(QDropEvent * ev);
266 /// make sure we quit cleanly
267 void closeEvent(QCloseEvent * e);
269 void showEvent(QShowEvent *);
271 /// in order to catch Tab key press.
272 bool event(QEvent * e);
273 bool focusNextPrevChild(bool);
276 bool goToFileRow(std::string const & argument);
279 struct GuiViewPrivate;
284 /// dialogs for this view
290 /// Hide all visible dialogs
291 void hideAll() const;
293 /// Update all visible dialogs.
295 * Check the status of all visible dialogs and disable or reenable
296 * them as appropriate.
298 * Disabling is needed for example when a dialog is open and the
299 * cursor moves to a position where the corresponding inset is not
302 void updateDialogs();
304 /** Show dialog could be called from arbitrary threads.
305 \param name == "bibtex", "citation" etc; an identifier used to
306 launch a particular dialog.
307 \param data is a string representation of the Inset contents.
308 It is often little more than the output from Inset::write.
309 It is passed to, and parsed by, the frontend dialog.
310 Several of these dialogs do not need any data,
311 so it defaults to string().
312 \param inset ownership is _not_ passed to the frontend dialog.
313 It is stored internally and used by the kernel to ascertain
314 what to do with the FuncRequest dispatched from the frontend
315 dialog on 'Apply'; should it be used to create a new inset at
316 the current cursor position or modify an existing, 'open' inset?
318 void showDialog(std::string const & name,
319 std::string const & data, Inset * inset = 0);
321 /** \param name == "citation", "bibtex" etc; an identifier used
322 to reset the contents of a particular dialog with \param data.
323 See the comments to 'show', above.
325 void updateDialog(std::string const & name, std::string const & data);
327 /** All Dialogs of the given \param name will be closed if they are
328 connected to the given \param inset.
330 void hideDialog(std::string const & name, Inset * inset);
332 void disconnectDialog(std::string const & name);
335 /// Saves the layout and geometry of the window
336 void saveLayout() const;
337 /// Saves the settings of toolbars and all dialogs
338 void saveUISettings() 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 bool exportBufferAs(Buffer & b);
359 /// Save a buffer as a new file.
361 Write a buffer to a new file name and rename the buffer
362 according to the new file name.
364 This function is e.g. used by menu callbacks and
365 LFUN_BUFFER_WRITE_AS.
367 If 'newname' is empty, the user is asked via a
368 dialog for the buffer's new name and location.
370 If 'newname' is non-empty and has an absolute path, that is used.
371 Otherwise the base directory of the buffer is used as the base
372 for any relative path in 'newname'.
374 bool renameBuffer(Buffer & b, docstring const & newname);
376 bool saveBuffer(Buffer & b);
377 /// save and rename buffer to fn. If fn is empty, the buffer
378 /// is just saved as the filename it already has.
379 bool saveBuffer(Buffer & b, support::FileName const & fn);
380 /// closes a workarea, if close_buffer is true the buffer will
381 /// also be released, otherwise the buffer will be hidden.
382 bool closeWorkArea(GuiWorkArea * wa, bool close_buffer);
383 /// closes the tabworkarea and all tabs. If we are in a close event,
384 /// all buffers will be closed, otherwise they will be hidden.
385 bool closeTabWorkArea(TabWorkArea * twa);
386 /// gives the user the possibility to save his work
387 /// or to discard the changes. If hiding is true, the
388 /// document will be reloaded.
389 bool saveBufferIfNeeded(Buffer & buf, bool hiding);
390 /// closes all workareas
391 bool closeWorkAreaAll();
392 /// write all open workareas into the session file
393 void writeSession() const;
394 /// is the buffer in this workarea also shown in another tab ?
395 /// This tab can either be in the same view or in another one.
396 bool inMultiTabs(GuiWorkArea * wa);
397 /// is the buffer shown in some other view ?
398 bool inOtherView(Buffer & buf);
400 enum NextOrPrevious {
405 void gotoNextOrPreviousBuffer(NextOrPrevious np);
407 /// Is the dialog currently visible?
408 bool isDialogVisible(std::string const & name) const;
410 Dialog * findOrBuild(std::string const & name, bool hide_it);
412 Dialog * build(std::string const & name);
414 bool reloadBuffer(Buffer & buffer);
416 void dispatchVC(FuncRequest const & cmd, DispatchResult & dr);
418 void dispatchToBufferView(FuncRequest const & cmd, DispatchResult & dr);
425 /// flag to avoid two concurrent close events.
427 /// if the view is busy the cursor shouldn't blink for instance.
428 /// This counts the number of times more often we called
429 /// setBusy(true) compared to setBusy(false), so we can nest
430 /// functions that call setBusy;
435 } // namespace frontend