2 * \file frontend/Application.h
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Abdelrazak Younes
8 * Full author contact details are available in file CREDITS.
14 #include "ColorCode.h"
16 #include "support/strfwd.h"
18 #include <boost/function.hpp>
39 /// The main application class
41 There should be only one instance of this class. No Qt object
42 initialisation should be done before the instanciation of this class.
44 Model/View/Controller separation at frontend level in LyX-qt4:
46 BufferList (N Buffers)
53 Application (this is the frontend really, should probably be renamed).
55 LyXView-1 (one or more in case of split-view mode).
59 | | WorkArea-1-1-1 (M1-1 WorkAreas, M1-1 <= N)
61 | | | BufferView <-----------> Buffer-c
67 | | | BufferView <-----------> Buffer-a
73 LyXView-2 (one or more in case of split-view mode).
77 | | WorkArea-2-1-1 (M2-1 WorkAreas, M2-1 <= N, M2-1 independent of M1-1)
81 1) The Model: \c Buffer
83 The Buffer is the in-memory representation of a LyX file format. The
84 Buffer does not (should not) have any information on what part of it
85 is represented on screen. There is one unique Buffer per opened LyX
86 file. A Buffer may or may not be represented on screen; typically, a
87 child document does not have an associated BufferView unless the user
88 choose to visualize it.
91 2) The Controller: \c BufferView / \c Painter \c Cursor
93 The BufferView is a tool used by the view (\sa WorkArea) that
94 translates a part of the Buffer contents into drawing routines. The
95 BufferView asks each inset of the Buffer to draw itself onto the
96 screen using the Painter. There can be only one Buffer displayed in
97 a BufferView and it is set on construction. Ideally, a BufferView
98 should not be able to change the contents of its associated Buffer.
99 A BufferView is instanciated and destroyed by a \c WorkArea; it is
100 automatically destroyed by the parent WorkArea when its Buffer is
103 \todo Move all Buffer changing LFUN to LyXFunc or Cursor.
104 \todo BufferView::buffer() should only offer const access.
106 The \c Painter is just a virtual interface to formalize each kind of
107 drawing routines (text, line, rectangle, etc).
109 The \c BufferView also contains a Cursor which may or may not be
110 visible on screen. The cursor is really just a bookmark to remember
111 where the next Buffer insertion/deletion is going to take place.
114 3) The View: \c WorkArea (and it's qt4 specialisation GuiWorkArea)
116 This contains the real screen area where the drawing is done by the
117 Painter. One WorkArea holds one unique \c BufferView. While it could
118 be possible that multiple WorkArea share one BufferView, this is not
119 something desirable because a BufferView is dependent of the WorkArea
121 The WorkArea also provide a scrollbar which position is translated
122 into scrolling command to the inner \c BufferView.
124 The WorkArea use the BufferView to translate each keyboard or mouse
125 events into terms that the Buffer can understand:
131 4) The Window: \c LyXView (and its qt4 specialisation \c GuiView)
133 This is a full window containing a menubar, toolbars and a central
134 widget. A LyXView is in charge of creating and closing a View for a
136 In the qt4 specialisation, \c GuiView, the central widget is a tab
137 widget. Each tab is reverved to the visualisation of one Buffer and
138 contains one WorkArea. In the qt4 frontend, one LyXView thus contains
139 multiple WorkAreas but this number can limited to one for another
140 frontend. The idea is that the kernel should not know how a Buffer
141 is displayed on screen; it's the frontend business.
142 In the future, we may also have multiple Workareas showing
143 simultaneously in the same GuiView (ex: with split window).
145 \todo Implement split-window
147 In any case, there would be only one WorkArea that gets the focus
150 With our current implementation using a QTabWidget, each Tab own its
151 own \c WorkArea. Clicking on a tab switch a WorkArea and not really
152 a Buffer. LFUN_BUFFER_SWITCH will tell the frontend to search the
153 WorkArea associated to this Buffer. The WorkArea is automatically
154 created if not already present.
156 A WorkArea is connected to the Buffer::closing signal and is thus
157 automatically destroyed when its Buffer is closed.
166 virtual ~Application() {}
169 virtual FuncStatus getStatus(FuncRequest const & cmd) = 0;
170 /// dispatch command.
171 /// \return true if the \c FuncRequest has been dispatched.
172 virtual bool dispatch(FuncRequest const & cmd) = 0;
175 virtual void resetGui() = 0;
177 /// Load files and restore GUI Session.
178 virtual void restoreGuiSession() = 0;
181 virtual void hideDialogs(std::string const & name, Inset * inset) const = 0;
183 virtual Buffer const * updateInset(Inset const * inset) const = 0;
185 /// Start the main event loop.
186 /// The batch command is programmed to be execute once
187 /// the event loop is started.
188 virtual int exec() = 0;
190 /// Quit running LyX.
192 * This may either quit directly or record the exit status
193 * and only stop the event loop.
195 virtual void exit(int status) = 0;
198 * Given col, fills r, g, b in the range 0-255.
199 * The function returns true if successful.
200 * It returns false on failure and sets r, g, b to 0.
202 virtual bool getRgbColor(ColorCode col, RGBColor & rgbcol) = 0;
204 /** Eg, passing Color_black returns "000000",
205 * passing Color_white returns "ffffff".
207 virtual std::string const hexName(ColorCode col) = 0;
210 * update an altered GUI color
212 virtual void updateColor(ColorCode col) = 0;
215 * add a callback for socket read notification
216 * @param fd socket descriptor (file/socket/etc)
218 typedef boost::function<void()> SocketCallback;
219 virtual void registerSocketCallback(int fd, SocketCallback func) = 0;
222 * remove a I/O read callback
223 * @param fd socket descriptor (file/socket/etc)
225 virtual void unregisterSocketCallback(int fd) = 0;
228 virtual MenuBackend const & menuBackend() const = 0;
229 virtual MenuBackend & menuBackend() = 0;
232 } // namespace frontend
234 frontend::Application * theApp();
235 frontend::Application * createApplication(int & argc, char * argv[]);
240 #endif // APPLICATION_H