4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
10 * Full author contact details are available in file CREDITS.
16 #include "support/strfwd.h"
20 namespace support { class FileName; }
31 * LyXView - main LyX window
33 * This class represents the main LyX window and provides
34 * accessor functions to its content.
36 * The eventual intention is that LyX will support a number
37 * of containing LyXViews. Currently a lot of code still
38 * relies on there being a single top-level view.
40 * Additionally we would like to support multiple views
41 * in a single LyXView.
51 virtual int id() const = 0;
53 virtual void close() = 0;
56 virtual void setBusy(bool) = 0;
58 //@{ generic accessor functions
60 /// \return the current buffer view.
61 virtual BufferView * view() = 0;
63 /// \return the buffer currently shown in this window
64 virtual Buffer * buffer() = 0;
65 virtual Buffer const * buffer() const = 0;
66 /// set a buffer to the current workarea.
67 virtual void setBuffer(Buffer * b) = 0; ///< \c Buffer to set.
69 virtual bool closeBuffer() = 0;
71 /// load a document into the current workarea.
72 virtual Buffer * loadDocument(
73 support::FileName const & name, ///< File to load.
74 bool tolastfiles = true ///< append to the "Open recent" menu?
77 virtual void newDocument(std::string const & filename,
78 bool fromTemplate) = 0;
82 /// display a message in the view
83 virtual void message(docstring const &) = 0;
86 virtual FuncStatus getStatus(FuncRequest const & cmd) = 0;
88 /// \return true if the \c FuncRequest has been dispatched.
89 virtual bool dispatch(FuncRequest const & cmd) = 0;
92 virtual void restartCursor() = 0;
94 /// Update the completion popup and the inline completion state.
95 /// If \c start is true, then a new completion might be started.
96 /// If \c keep is true, an active completion will be kept active
97 /// even though the cursor moved.
98 virtual void updateCompletion(bool start, bool keep) = 0;
102 LyXView(LyXView const &);
103 void operator=(LyXView const &);
106 } // namespace frontend