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(GuiLayoutBox *);
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 &);
108 void structureChanged();
112 TocModels & tocModels();
114 /// called on timeout
117 /// \return the current buffer view.
120 /** redraw \c inset in all the BufferViews in which it is currently
121 * visible. If successful return a pointer to the owning Buffer.
123 Buffer const * updateInset(Inset const *);
125 void restartCursor();
127 /// \return the \c Workarea associated to \p Buffer
128 /// \retval 0 if no \c WorkArea is found.
129 GuiWorkArea * workArea(Buffer & buffer);
131 /// Add a \c WorkArea
132 /// \return the \c Workarea associated to \p Buffer
133 /// \retval 0 if no \c WorkArea is found.
134 GuiWorkArea * addWorkArea(Buffer & buffer);
136 void setCurrentWorkArea(GuiWorkArea * work_area);
138 void removeWorkArea(GuiWorkArea * work_area);
139 /// return the current WorkArea (the one that has the focus).
140 GuiWorkArea const * currentWorkArea() const;
147 /// clear any temporary message and replace with current status.
152 void updateWindowTitle(GuiWorkArea * wa);
155 void on_currentWorkAreaChanged(GuiWorkArea *);
157 void on_lastWorkAreaRemoved();
159 /// slots to change the icon size
160 void smallSizedIcons();
161 void normalSizedIcons();
162 void bigSizedIcons();
166 TabWorkArea * addTabWorkArea();
168 /// connect to signals in the given BufferView
169 void connectBufferView(BufferView & bv);
170 /// disconnect from signals in the given BufferView
171 void disconnectBufferView();
172 /// connect to signals in the given buffer
173 void connectBuffer(Buffer & buf);
174 /// disconnect from signals in the given buffer
175 void disconnectBuffer();
177 void dragEnterEvent(QDragEnterEvent * ev);
179 void dropEvent(QDropEvent * ev);
180 /// make sure we quit cleanly
181 void closeEvent(QCloseEvent * e);
183 void showEvent(QShowEvent *);
185 /// in order to catch Tab key press.
186 bool event(QEvent * e);
187 bool focusNextPrevChild(bool);
190 struct GuiViewPrivate;
195 /// dialogs for this view
201 /// Hide all visible dialogs
202 void hideAll() const;
204 /// Update all visible dialogs.
206 * Check the status of all visible dialogs and disable or reenable
207 * them as appropriate.
209 * Disabling is needed for example when a dialog is open and the
210 * cursor moves to a position where the corresponding inset is not
213 void updateDialogs();
215 /** \param name == "bibtex", "citation" etc; an identifier used to
216 launch a particular dialog.
217 \param data is a string representation of the Inset contents.
218 It is often little more than the output from Inset::write.
219 It is passed to, and parsed by, the frontend dialog.
220 Several of these dialogs do not need any data,
221 so it defaults to string().
222 \param inset ownership is _not_ passed to the frontend dialog.
223 It is stored internally and used by the kernel to ascertain
224 what to do with the FuncRequest dispatched from the frontend
225 dialog on 'Apply'; should it be used to create a new inset at
226 the current cursor position or modify an existing, 'open' inset?
228 void showDialog(std::string const & name,
229 std::string const & data, Inset * inset = 0);
231 /** \param name == "citation", "bibtex" etc; an identifier used
232 to reset the contents of a particular dialog with \param data.
233 See the comments to 'show', above.
235 void updateDialog(std::string const & name, std::string const & data);
237 /** All Dialogs of the given \param name will be closed if they are
238 connected to the given \param inset.
240 void hideDialog(std::string const & name, Inset * inset);
242 void disconnectDialog(std::string const & name);
245 void updateCompletion(Cursor & cur, bool start, bool keep);
249 void saveLayout() const;
251 bool restoreLayout();
253 GuiToolbar * toolbar(std::string const & name);
255 void constructToolbars();
259 void lfunUiToggle(FuncRequest const & cmd);
261 void toggleFullScreen();
263 void insertLyXFile(docstring const & fname);
265 void insertPlaintextFile(docstring const & fname,
268 /// Save a buffer as a new file.
270 Write a buffer to a new file name and rename the buffer
271 according to the new file name.
273 This function is e.g. used by menu callbacks and
274 LFUN_BUFFER_WRITE_AS.
276 If 'newname' is empty, the user is asked via a
277 dialog for the buffer's new name and location.
279 If 'newname' is non-empty and has an absolute path, that is used.
280 Otherwise the base directory of the buffer is used as the base
281 for any relative path in 'newname'.
283 bool renameBuffer(Buffer & b, docstring const & newname);
285 bool saveBuffer(Buffer & b);
287 bool closeBuffer(Buffer & buf, bool tolastopened = false);
290 Inset * getOpenInset(std::string const & name) const;
292 /// Is the dialog currently visible?
293 bool isDialogVisible(std::string const & name) const;
295 Dialog * find_or_build(std::string const & name);
297 Dialog * build(std::string const & name);
302 /// flag to avoid two concurrent close events.
306 } // namespace frontend