]> git.lyx.org Git - lyx.git/blobdiff - src/frontends/Application.h
More notes.
[lyx.git] / src / frontends / Application.h
index a682207c0581976a797f540628f48ed6aa006580..b73256db882f42ebd8ae087956e846a5e70446e5 100644 (file)
@@ -8,17 +8,31 @@
  * 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 {
@@ -45,18 +59,29 @@ initialisation should be done before the instanciation of this class.
 
  Application (this is the frontend really, should probably be renamed).
    |
-   LyXView-1 (M1 WorkAreas, M1 <= N)
+   LyXView-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)
-      |
+   LyXView-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)
      ...
 
 
@@ -82,7 +107,8 @@ initialisation should be done before the instanciation of this class.
  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
@@ -121,12 +147,11 @@ initialisation should be done before the instanciation of this class.
  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
@@ -143,12 +168,26 @@ class Application
 {
 public:
        ///
-       Application(int & argc, char ** argv);
+       Application() {}
        ///
        virtual ~Application() {}
+       ///
+       virtual LyXView * currentWindow() = 0;
+       ///
+       virtual bool getStatus(FuncRequest const & cmd, FuncStatus & flag) const = 0;
+       /// dispatch command.
+       virtual void dispatch(FuncRequest const & cmd, DispatchResult & dr) = 0;
+
+       ///
+       virtual void resetGui() = 0;
+
+       /// Load files and restore GUI Session.
+       virtual void restoreGuiSession() = 0;
 
        ///
-       virtual Gui & gui() = 0;
+       virtual void hideDialogs(std::string const & name, Inset * inset) const = 0;
+       ///
+       virtual Buffer const * updateInset(Inset const * inset) const = 0;
 
        /// Start the main event loop.
        /// The batch command is programmed to be execute once
@@ -162,43 +201,18 @@ public:
        */
        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;
-
-       /** Eg, passing Color::black returns "000000",
-       *      passing Color::white returns "ffffff".
-       */
-       virtual std::string const hexName(Color_color col) = 0;
+       virtual bool getRgbColor(ColorCode col, RGBColor & rgbcol) = 0;
 
-       /**
-       * update an altered GUI color
+       /** Eg, passing Color_black returns "000000",
+       *      passing Color_white returns "ffffff".
        */
-       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)
@@ -212,34 +226,27 @@ public:
        */
        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);
-
-       ///
-       LyXView const * currentView() const;
-
-       ///
-       LyXView * currentView();
+       virtual bool searchMenu(FuncRequest const & func,
+               docstring_list & names) const = 0;
 
-       ///
-       void setCurrentView(LyXView & current_view);
+       /// \return the icon file name for the given action.
+       virtual docstring iconName(FuncRequest const & f, bool unknown) = 0;
 
-private:
-       /// This LyXView is the one receiving Clipboard and Selection
-       /// Events
-       LyXView * current_view_;
+       /// Handle a accented char key sequence
+       /// FIXME: this is only needed for LFUN_ACCENT_* in Text::dispatch()
+       virtual void handleKeyFunc(FuncCode action) = 0;
+};
 
-}; // 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