* Full author contact details are available in file CREDITS.
*/
-#ifndef LYX_APPLICATION_H
-#define LYX_APPLICATION_H
+#ifndef APPLICATION_H
+#define APPLICATION_H
+
+#include "ColorCode.h"
+#include "FuncCode.h"
+
+#include "KeyModifier.h"
+
+#include "support/strfwd.h"
#include <boost/function.hpp>
-#include <string>
+#include <vector>
+
namespace lyx {
class BufferView;
-class Color_color;
+class Buffer;
+class DispatchResult;
+class docstring_list;
+class FuncRequest;
+class FuncStatus;
+class Inset;
+class Lexer;
struct RGBColor;
namespace frontend {
class Clipboard;
class FontLoader;
-class Gui;
-class LyXView;
class Selection;
/// The main application class
Application (this is the frontend really, should probably be renamed).
|
- LyXView-1 (M1 WorkAreas, M1 <= N)
+ GuiView-1 (one or more in case of split-view mode).
| |
- | <tab-widget>
- | | (many)
- | WorkArea-1
- | |
- | BufferView <-----------> Buffer-c
- | |
- | Cursor
+ | <tab-widget-1-1>
+ | | |
+ | | WorkArea-1-1-1 (M1-1 WorkAreas, M1-1 <= N)
+ | | | |
+ | | | BufferView <-----------> Buffer-c
+ | | | |
+ | | | Cursor
+ | | |
+ | | WorkArea-1-1-2
+ | | | |
+ | | | BufferView <-----------> Buffer-a
+ | | | |
+ | | | Cursor
+ | |
+ | <tab-widget-1-2>
|
- LyXView-2 (M2 WorkAreas, M2 <= N, M2 independent of M1)
- |
+ GuiView-2 (one or more in case of split-view mode).
+ | |
+ | <tab-widget-2-1>
+ | | |
+ | | WorkArea-2-1-1 (M2-1 WorkAreas, M2-1 <= N, M2-1 independent of M1-1)
...
automatically destroyed by the parent WorkArea when its Buffer is
closed.
- \todo Move all Buffer changing LFUN to LyXFunc or Cursor.
+ \todo Move all Buffer changing LFUN to Buffer::dispatch(),
+ LyXFunc::dispatch() or Cursor::dispatch().
\todo BufferView::buffer() should only offer const access.
The \c Painter is just a virtual interface to formalize each kind of
- etc.
- 4) The Window: \c LyXView (and its qt4 specialisation \c GuiView)
+ 4) The Window: \c GuiView
This is a full window containing a menubar, toolbars and a central
- widget. A LyXView is in charge of creating and closing a View for a
+ widget. A GuiView is in charge of creating and closing a View for a
given Buffer.
In the qt4 specialisation, \c GuiView, the central widget is a tab
widget. Each tab is reverved to the visualisation of one Buffer and
- contains one WorkArea. In the qt4 frontend, one LyXView thus contains
+ contains one WorkArea. In the qt4 frontend, one GuiView thus contains
multiple WorkAreas but this number can limited to one for another
frontend. The idea is that the kernel should not know how a Buffer
is displayed on screen; it's the frontend business.
- In the future, we may also have multiple Workareas showing
- simultaneously in the same GuiView (ex: with split window).
+ It is also possible to have multiple Workareas showing
+ simultaneously in the same GuiView (ex: with split window), thus
+ sharing the menubar and toolbars.
- \todo Implement split-window
-
- In any case, there would be only one WorkArea that gets the focus
+ In any case, there should be only one WorkArea that gets the focus
at a time.
With our current implementation using a QTabWidget, each Tab own its
{
public:
///
- Application(int & argc, char ** argv);
+ Application() {}
///
virtual ~Application() {}
+ /// LyX dispatcher: executes lyx actions and does necessary
+ /// screen updates depending on results.
+ /// This method encapsulates all the LyX command operations.
+ /// This is the class of the LyX's "high level event handler".
+ /// Every user command is processed here, either invocated from
+ /// keyboard or from the GUI. All GUI objects, including buttons and
+ /// menus should use this class and never call kernel functions directly.
+ virtual void dispatch(FuncRequest const &) = 0;
+
+ /// LyX dispatcher: executes lyx actions and returns result.
+ virtual void dispatch(FuncRequest const &, DispatchResult & dr) = 0;
+
+ ///
+ virtual FuncStatus getStatus(FuncRequest const & cmd) const = 0;
+
+ /// Load files and restore GUI Session.
+ virtual void restoreGuiSession() = 0;
+
///
- virtual Gui & gui() = 0;
+ virtual Buffer const * updateInset(Inset const * inset) const = 0;
/// Start the main event loop.
/// The batch command is programmed to be execute once
*/
virtual void exit(int status) = 0;
- /**
- * Synchronise all pending events.
- */
- virtual void syncEvents() = 0;
- ///
- virtual Clipboard & clipboard() = 0;
- ///
- virtual Selection & selection() = 0;
- ///
- virtual FontLoader & fontLoader() = 0;
-
- /// return a suitable serif font name.
- virtual std::string const romanFontName() = 0;
-
- /// return a suitable sans serif font name.
- virtual std::string const sansFontName() = 0;
-
- /// return a suitable monospaced font name.
- virtual std::string const typewriterFontName() = 0;
-
/**
* Given col, fills r, g, b in the range 0-255.
* The function returns true if successful.
* It returns false on failure and sets r, g, b to 0.
*/
- virtual bool getRgbColor(Color_color col, RGBColor & rgbcol) = 0;
+ virtual bool getRgbColor(ColorCode col, RGBColor & rgbcol) = 0;
+ /// Like getRgbColor(), but static and slower
+ static bool getRgbColorUncached(ColorCode col, RGBColor & rgbcol);
- /** Eg, passing Color::black returns "000000",
- * passing Color::white returns "ffffff".
+ /** Eg, passing Color_black returns "000000",
+ * passing Color_white returns "ffffff".
*/
- virtual std::string const hexName(Color_color col) = 0;
-
- /**
- * update an altered GUI color
- */
- virtual void updateColor(Color_color col) = 0;
-
+ virtual std::string const hexName(ColorCode col) = 0;
+
/**
* add a callback for socket read notification
* @param fd socket descriptor (file/socket/etc)
*/
typedef boost::function<void()> SocketCallback;
- virtual void registerSocketCallback( int fd, SocketCallback func) = 0;
+ virtual void registerSocketCallback(int fd, SocketCallback func) = 0;
/**
* remove a I/O read callback
*/
virtual void unregisterSocketCallback(int fd) = 0;
- /// Create the main window with given geometry settings.
- LyXView & createView(unsigned int width, unsigned int height,
- int posx, int posy, int maximized,
- unsigned int iconSizeXY, const std::string & geometryArg);
+ virtual bool searchMenu(FuncRequest const & func,
+ docstring_list & names) const = 0;
- ///
- LyXView const * currentView() const;
+ /// \return the icon file name for the given action.
+ static docstring iconName(FuncRequest const & f, bool unknown);
- ///
- LyXView * currentView();
+ /// Handle a accented char key sequence
+ /// FIXME: this is only needed for LFUN_ACCENT_* in Text::dispatch()
+ virtual void handleKeyFunc(FuncCode action) = 0;
+};
- ///
- void setCurrentView(LyXView & current_view);
-
-private:
- /// This LyXView is the one receiving Clipboard and Selection
- /// Events
- LyXView * current_view_;
-
-}; // Application
+/// Return the list of loadable formats.
+std::vector<std::string> loadableImageFormats();
} // namespace frontend
frontend::Application * theApp();
frontend::Application * createApplication(int & argc, char * argv[]);
-
+void hideDialogs(std::string const & name, Inset * inset);
} // namespace lyx
-#endif // LYX_APPLICATION_H
+#endif // APPLICATION_H
projects / lyx.git / blobdiff