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>
33 /// The main application class
35 There should be only one instance of this class. No Qt object
36 initialisation should be done before the instanciation of this class.
38 Model/View/Controller separation at frontend level in LyX-qt4:
40 BufferList (N Buffers)
47 Application (this is the frontend really, should probably be renamed).
49 LyXView-1 (M1 WorkAreas, M1 <= N)
55 | BufferView <-----------> Buffer-c
59 LyXView-2 (M2 WorkAreas, M2 <= N, M2 independent of M1)
64 1) The Model: \c Buffer
66 The Buffer is the in-memory representation of a LyX file format. The
67 Buffer does not (should not) have any information on what part of it
68 is represented on screen. There is one unique Buffer per opened LyX
69 file. A Buffer may or may not be represented on screen; typically, a
70 child document does not have an associated BufferView unless the user
71 choose to visualize it.
74 2) The Controller: \c BufferView / \c Painter \c Cursor
76 The BufferView is a tool used by the view (\sa WorkArea) that
77 translates a part of the Buffer contents into drawing routines. The
78 BufferView asks each inset of the Buffer to draw itself onto the
79 screen using the Painter. There can be only one Buffer displayed in
80 a BufferView and it is set on construction. Ideally, a BufferView
81 should not be able to change the contents of its associated Buffer.
82 A BufferView is instanciated and destroyed by a \c WorkArea; it is
83 automatically destroyed by the parent WorkArea when its Buffer is
86 \todo Move all Buffer changing LFUN to LyXFunc or Cursor.
87 \todo BufferView::buffer() should only offer const access.
89 The \c Painter is just a virtual interface to formalize each kind of
90 drawing routines (text, line, rectangle, etc).
92 The \c BufferView also contains a Cursor which may or may not be
93 visible on screen. The cursor is really just a bookmark to remember
94 where the next Buffer insertion/deletion is going to take place.
97 3) The View: \c WorkArea (and it's qt4 specialisation GuiWorkArea)
99 This contains the real screen area where the drawing is done by the
100 Painter. One WorkArea holds one unique \c BufferView. While it could
101 be possible that multiple WorkArea share one BufferView, this is not
102 something desirable because a BufferView is dependent of the WorkArea
104 The WorkArea also provide a scrollbar which position is translated
105 into scrolling command to the inner \c BufferView.
107 The WorkArea use the BufferView to translate each keyboard or mouse
108 events into terms that the Buffer can understand:
114 4) The Window: \c LyXView (and its qt4 specialisation \c GuiView)
116 This is a full window containing a menubar, toolbars and a central
117 widget. A LyXView is in charge of creating and closing a View for a
119 In the qt4 specialisation, \c GuiView, the central widget is a tab
120 widget. Each tab is reverved to the visualisation of one Buffer and
121 contains one WorkArea. In the qt4 frontend, one LyXView thus contains
122 multiple WorkAreas but this number can limited to one for another
123 frontend. The idea is that the kernel should not know how a Buffer
124 is displayed on screen; it's the frontend business.
125 In the future, we may also have multiple Workareas showing
126 simultaneously in the same GuiView (ex: with split window).
128 \todo Implement split-window
130 In any case, there would be only one WorkArea that gets the focus
133 With our current implementation using a QTabWidget, each Tab own its
134 own \c WorkArea. Clicking on a tab switch a WorkArea and not really
135 a Buffer. LFUN_BUFFER_SWITCH will tell the frontend to search the
136 WorkArea associated to this Buffer. The WorkArea is automatically
137 created if not already present.
139 A WorkArea is connected to the Buffer::closing signal and is thus
140 automatically destroyed when its Buffer is closed.
147 Application(int & argc, char ** argv);
149 virtual ~Application() {}
152 virtual Gui & gui() = 0;
154 /// Start the main event loop.
155 /// The batch command is programmed to be execute once
156 /// the event loop is started.
157 virtual int exec() = 0;
159 /// Quit running LyX.
161 * This may either quit directly or record the exit status
162 * and only stop the event loop.
164 virtual void exit(int status) = 0;
167 * Synchronise all pending events.
169 virtual void syncEvents() = 0;
171 virtual Clipboard & clipboard() = 0;
173 virtual Selection & selection() = 0;
175 virtual FontLoader & fontLoader() = 0;
177 /// return a suitable serif font name.
178 virtual std::string const romanFontName() = 0;
180 /// return a suitable sans serif font name.
181 virtual std::string const sansFontName() = 0;
183 /// return a suitable monospaced font name.
184 virtual std::string const typewriterFontName() = 0;
187 * Given col, fills r, g, b in the range 0-255.
188 * The function returns true if successful.
189 * It returns false on failure and sets r, g, b to 0.
191 virtual bool getRgbColor(ColorCode col, RGBColor & rgbcol) = 0;
193 /** Eg, passing Color_black returns "000000",
194 * passing Color_white returns "ffffff".
196 virtual std::string const hexName(ColorCode col) = 0;
199 * update an altered GUI color
201 virtual void updateColor(ColorCode col) = 0;
204 * add a callback for socket read notification
205 * @param fd socket descriptor (file/socket/etc)
207 typedef boost::function<void()> SocketCallback;
208 virtual void registerSocketCallback(int fd, SocketCallback func) = 0;
211 * remove a I/O read callback
212 * @param fd socket descriptor (file/socket/etc)
214 virtual void unregisterSocketCallback(int fd) = 0;
216 /// Create the main window with given geometry settings.
217 virtual LyXView & createView(unsigned int width, unsigned int height,
218 int posx, int posy, int maximized,
219 unsigned int iconSizeXY, const std::string & geometryArg) = 0;
222 LyXView const * currentView() const;
225 LyXView * currentView();
228 void setCurrentView(LyXView & current_view);
231 /// This LyXView is the one receiving Clipboard and Selection
233 LyXView * current_view_;
237 } // namespace frontend
239 frontend::Application * theApp();
240 frontend::Application * createApplication(int & argc, char * argv[]);
246 #endif // APPLICATION_H