]> git.lyx.org Git - lyx.git/blobdiff - src/frontends/lyx_gui.h
namespace grfx -> lyx::graphics
[lyx.git] / src / frontends / lyx_gui.h
index 83b674d90e713160d907e344940720837b18f3fb..f0b2447a4c866b660c8ffb2b19a1118cb08a2feb 100644 (file)
 // -*- C++ -*-
 /**
  * \file lyx_gui.h
- * Copyright 2002 the LyX Team
- * Read the file COPYING
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- * \author John Levon <moz@compsoc.man.ac.uk>
+ * \author John Levon
+ *
+ * Full author contact details are available in file CREDITS
  */
 
 #ifndef LYX_GUI_H
 #define LYX_GUI_H
 
-#include <config.h>
-
+#include "LColor.h"
 #include "LString.h"
+#include "FuncStatus.h"
 
 #include <vector>
 
 class Dialogs;
+class LyXFont;
+class LyXComm;
+class FuncRequest;
 
 /// GUI interaction
 namespace lyx_gui {
 
-       /// parse command line and do basic initialisation
-       void parse_init(int & argc, char * argv[]);
+/// are we using the GUI at all
+extern bool use_gui;
+
+/// return a suitable serif font name (called from non-gui context too !)
+string const roman_font_name();
+
+/// return a suitable sans serif font name (called from non-gui context too !)
+string const sans_font_name();
+
+/// return a suitable monospaced font name (called from non-gui context too !)
+string const typewriter_font_name();
+
+/// parse command line and do basic initialisation
+void parse_init(int & argc, char * argv[]);
+
+/**
+ * set up GUI parameters. At this point lyxrc may
+ * be used.
+ */
+void parse_lyxrc();
+
+/**
+ * Start the main event loop, after executing the given
+ * batch commands, and loading the given documents
+ */
+void start(string const & batch, std::vector<string> const & files);
+
+/**
+ * Synchronise all pending events.
+ */
+void sync_events();
+
+/**
+ * quit running LyX
+ */
+void exit();
+
+/**
+ * return the status flag for a given action. This can be used to tell
+ * that a given lfun is not implemented by a frontend
+ */
+FuncStatus getStatus(FuncRequest const & ev);
+
+/** Eg, passing LColor::black returns "000000",
+ *      passing LColor::white returns "ffffff".
+ */
+string const hexname(LColor::color col);
+
+/**
+ * update an altered GUI color
+ */
+void update_color(LColor::color col);
+
+/**
+ * update the font cache
+ */
+void update_fonts();
 
-       /**
-        * set up GUI parameters. At this point lyxrc may
-        * be used.
-        */
-       void parse_lyxrc();
+/**
+ * is the given font available ?
+ */
+bool font_available(LyXFont const & font);
 
-       /**
-        * Start the main event loop, after executing the given
-        * batch commands, and loading the given documents
-        */
-       void start(string const & batch, std::vector<std::string> files);
+/**
+ * add a callback for I/O read notification
+ */
+void set_read_callback(int fd, LyXComm * comm);
+
+/**
+ * remove a I/O read callback
+ * @param fd file descriptor
+ */
+void remove_read_callback(int fd);
 
-       /// initialise graphics
-       void init_graphics();
-}
+} // namespace lyx_gui
 
 #endif // LYX_GUI_H