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"
19 #include "frontends/LyXView.h"
21 #include "support/strfwd.h"
23 #include <QMainWindow>
26 class QDragEnterEvent;
47 * GuiView - Qt4 implementation of LyXView
49 * qt4-private implementation of the main LyX window.
51 * Note: a QObject emits a destroyed(QObject *) Qt signal when it
52 * is deleted. This might be useful for closing other dialogs
53 * depending on a given GuiView.
55 class GuiView : public QMainWindow, public LyXView, public GuiBufferViewDelegate,
56 public GuiBufferDelegate
60 /// create a main window of the given dimensions
66 int id() const { return id_; }
69 /// returns true if this view has the focus.
70 bool hasFocus() const;
72 /// add toolbar, if newline==true, add a toolbar break before the toolbar
73 GuiToolbar * makeToolbar(ToolbarInfo const & tbinfo, bool newline);
74 virtual void updateStatusBar();
75 virtual void message(docstring const & str);
77 /// updates the possible layouts selectable
78 void updateLayoutList();
79 void updateToolbars();
80 QMenu * createPopupMenu();
81 bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
82 bool dispatch(FuncRequest const & cmd);
85 void setLayoutDialog(LayoutBox *);
87 /// \return the buffer currently shown in this window
89 Buffer const * buffer() const;
90 /// set a buffer to the current workarea.
91 void setBuffer(Buffer * b); ///< \c Buffer to set.
94 /// load a document into the current workarea.
95 Buffer * loadDocument(support::FileName const & name, ///< File to load.
96 bool tolastfiles = true); ///< append to the "Open recent" menu?
98 void openDocument(std::string const & filename);
100 void importDocument(std::string const &);
102 void newDocument(std::string const & filename, bool fromTemplate);
104 /// GuiBufferDelegate.
106 void resetAutosaveTimers();
107 void errors(std::string const &, bool from_master = false);
108 void structureChanged();
109 void updateTocItem(std::string const &, DocIterator const &);
113 TocModels & tocModels();
115 /// called on timeout
118 /// \return the current buffer view.
121 /** redraw \c inset in all the BufferViews in which it is currently
122 * visible. If successful return a pointer to the owning Buffer.
124 Buffer const * updateInset(Inset const *);
126 void restartCursor();
128 /// \return the \c Workarea associated to \p Buffer
129 /// \retval 0 if no \c WorkArea is found.
130 GuiWorkArea * workArea(Buffer & buffer);
132 /// Add a \c WorkArea
133 /// \return the \c Workarea associated to \p Buffer
134 /// \retval 0 if no \c WorkArea is found.
135 GuiWorkArea * addWorkArea(Buffer & buffer);
137 void setCurrentWorkArea(GuiWorkArea * work_area);
139 void removeWorkArea(GuiWorkArea * work_area);
140 /// return the current WorkArea (the one that has the focus).
141 GuiWorkArea const * currentWorkArea() const;
142 /// return the current WorkArea (the one that has the focus).
143 GuiWorkArea * currentWorkArea();
145 /// return the current document WorkArea (it may not have the focus).
146 GuiWorkArea const * currentMainWorkArea() const;
147 /// return the current document WorkArea (it may not have the focus).
148 GuiWorkArea * currentMainWorkArea();
155 /// clear any temporary message and replace with current status.
160 void updateWindowTitle(GuiWorkArea * wa);
162 void resetWindowTitleAndIconText();
165 void on_currentWorkAreaChanged(GuiWorkArea *);
167 void on_lastWorkAreaRemoved();
169 /// slots to change the icon size
170 void smallSizedIcons();
171 void normalSizedIcons();
172 void bigSizedIcons();
176 TabWorkArea * addTabWorkArea();
178 /// connect to signals in the given BufferView
179 void connectBufferView(BufferView & bv);
180 /// disconnect from signals in the given BufferView
181 void disconnectBufferView();
182 /// connect to signals in the given buffer
183 void connectBuffer(Buffer & buf);
184 /// disconnect from signals in the given buffer
185 void disconnectBuffer();
187 void dragEnterEvent(QDragEnterEvent * ev);
189 void dropEvent(QDropEvent * ev);
190 /// make sure we quit cleanly
191 void closeEvent(QCloseEvent * e);
193 void showEvent(QShowEvent *);
195 /// in order to catch Tab key press.
196 bool event(QEvent * e);
197 bool focusNextPrevChild(bool);
200 struct GuiViewPrivate;
205 /// dialogs for this view
211 /// Hide all visible dialogs
212 void hideAll() const;
214 /// Update all visible dialogs.
216 * Check the status of all visible dialogs and disable or reenable
217 * them as appropriate.
219 * Disabling is needed for example when a dialog is open and the
220 * cursor moves to a position where the corresponding inset is not
223 void updateDialogs();
225 /** \param name == "bibtex", "citation" etc; an identifier used to
226 launch a particular dialog.
227 \param data is a string representation of the Inset contents.
228 It is often little more than the output from Inset::write.
229 It is passed to, and parsed by, the frontend dialog.
230 Several of these dialogs do not need any data,
231 so it defaults to string().
232 \param inset ownership is _not_ passed to the frontend dialog.
233 It is stored internally and used by the kernel to ascertain
234 what to do with the FuncRequest dispatched from the frontend
235 dialog on 'Apply'; should it be used to create a new inset at
236 the current cursor position or modify an existing, 'open' inset?
238 void showDialog(std::string const & name,
239 std::string const & data, Inset * inset = 0);
241 /** \param name == "citation", "bibtex" etc; an identifier used
242 to reset the contents of a particular dialog with \param data.
243 See the comments to 'show', above.
245 void updateDialog(std::string const & name, std::string const & data);
247 /** All Dialogs of the given \param name will be closed if they are
248 connected to the given \param inset.
250 void hideDialog(std::string const & name, Inset * inset);
252 void disconnectDialog(std::string const & name);
255 void updateCompletion(Cursor & cur, bool start, bool keep);
259 void saveLayout() const;
261 bool restoreLayout();
263 GuiToolbar * toolbar(std::string const & name);
265 void constructToolbars();
269 void lfunUiToggle(FuncRequest const & cmd);
271 void toggleFullScreen();
273 void insertLyXFile(docstring const & fname);
275 void insertPlaintextFile(docstring const & fname,
278 /// Save a buffer as a new file.
280 Write a buffer to a new file name and rename the buffer
281 according to the new file name.
283 This function is e.g. used by menu callbacks and
284 LFUN_BUFFER_WRITE_AS.
286 If 'newname' is empty, the user is asked via a
287 dialog for the buffer's new name and location.
289 If 'newname' is non-empty and has an absolute path, that is used.
290 Otherwise the base directory of the buffer is used as the base
291 for any relative path in 'newname'.
293 bool renameBuffer(Buffer & b, docstring const & newname);
295 bool saveBuffer(Buffer & b);
297 bool closeBuffer(Buffer & buf, bool close_buffer,
298 bool tolastopened = false, bool mark_active = false);
300 bool saveBufferIfNeeded(Buffer & buf);
302 bool closeBufferAll(bool tolastopened = false);
304 enum NextOrPrevious {
309 void gotoNextOrPreviousBuffer(NextOrPrevious np);
312 Inset * getOpenInset(std::string const & name) const;
314 /// Is the dialog currently visible?
315 bool isDialogVisible(std::string const & name) const;
317 Dialog * findOrBuild(std::string const & name, bool hide_it);
319 Dialog * build(std::string const & name);
324 /// flag to avoid two concurrent close events.
328 } // namespace frontend