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; }
32 * LyXView - main LyX window
34 * This class represents the main LyX window and provides
35 * accessor functions to its content.
37 * The eventual intention is that LyX will support a number
38 * of containing LyXViews. Currently a lot of code still
39 * relies on there being a single top-level view.
41 * Additionally we would like to support multiple views
42 * in a single LyXView.
52 virtual int id() const = 0;
55 virtual void setBusy(bool) = 0;
57 //@{ generic accessor functions
59 /// \return the current buffer view.
60 virtual BufferView * view() = 0;
62 /// \return the buffer currently shown in this window
63 virtual Buffer * buffer() = 0;
64 virtual Buffer const * buffer() const = 0;
65 /// set a buffer to the current workarea.
66 virtual void setBuffer(Buffer * b) = 0; ///< \c Buffer to set.
68 virtual bool closeBuffer() = 0;
70 /// load a document into the current workarea.
71 virtual Buffer * loadDocument(
72 support::FileName const & name, ///< File to load.
73 bool tolastfiles = true ///< append to the "Open recent" menu?
76 virtual void newDocument(std::string const & filename,
77 bool fromTemplate) = 0;
81 /// display a message in the view
82 virtual void message(docstring const &) = 0;
85 virtual bool getStatus(FuncRequest const & cmd, FuncStatus & flag) = 0;
87 /// \return true if the \c FuncRequest has been dispatched.
88 virtual bool dispatch(FuncRequest const & cmd) = 0;
91 virtual void restartCursor() = 0;
93 /// Update the completion popup and the inline completion state.
94 /// If \c start is true, then a new completion might be started.
95 /// If \c keep is true, an active completion will be kept active
96 /// even though the cursor moved. The update flags of \c cur might
98 virtual void updateCompletion(Cursor & cur, bool start, bool keep) = 0;
102 LyXView(LyXView const &);
103 void operator=(LyXView const &);
106 } // namespace frontend