"Inter-word Space"

[lyx.git] / src / lyx_main.h

diff --git a/src/lyx_main.h b/src/lyx_main.h
index 5da9be017369c2bdc9aec55163f3ee4b26d354e8..e8769300feb4e646446f24e53e71938c9186ff7c 100644 (file)
--- a/src/lyx_main.h
+++ b/src/lyx_main.h
@@ -1,24 +1,15 @@
 // -*- C++ -*-
-/* This file is part of
-* ======================================================
-*
-*           LyX, The Document Processor
-*
-*           Copyright 1995 Matthias Ettrich
-*           Copyright 1995-2001 The LyX Team.
-*
-* ====================================================== */
-
-/* This is the declaration of the LyX class, there should only
- * exist _one_ instance of this in the application. */
+/**
+ * \file lyx_main.h
+ * Copyright 2002 the LyX Team
+ * Read the file COPYING
+ *
+ * \author unknown
+ */
 
 #ifndef LYX_MAIN_H
 #define LYX_MAIN_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 #include "LString.h"
 
 #include <boost/scoped_ptr.hpp>
@@ -26,66 +17,54 @@
 
 #include <csignal>
 
-class LyXGUI;
 class LyXRC;
 class LastFiles;
 class Buffer;
 class kb_keymap;
 
-///
-extern string system_lyxdir;
-///
+
+/// e.g. $HOME/.lyx/
 extern string user_lyxdir;
-///
+/// e.g. /usr/share/lyx/
+extern string system_lyxdir;
+/// e.g. /tmp
 extern string system_tempdir;
-///
+/// last files loaded
 extern boost::scoped_ptr<LastFiles> lastfiles;
-/* we should hopefully be able to move this
- * inside the LyX class */
 
 
-/**
-  This is the main LyX object it encapsulates most of the other objects.
-*/
+/// initial startup
 class LyX : boost::noncopyable {
 public:
-       /// the only allowed constructor
-       LyX(int * argc, char * argv[]); // constructor
-       /// Always is useful a destructor
-       ~LyX();
+       LyX(int & argc, char * argv[]);
 
        /// in the case of failure
        static void emergencyCleanup();
 
 private:
-       /// Should be a maximum of 1 LyXGUI.
-       boost::scoped_ptr<LyXGUI> lyxGUI;
-       /// does this user start lyx for the first time?
-       bool first_start;
-       ///
-       string batch_command;
-       ///
-       void runtime();
-       ///
+       /// initial LyX set up
        void init(bool);
-       ///
+       /// set up the default key bindings
        void defaultKeyBindings(kb_keymap * kbmap);
-       ///
+       /// set up the default dead key bindings if requested
        void deadKeyBindings(kb_keymap * kbmap);
-       ///
+       /// check, set up and configure the user dir if necessary
        void queryUserLyXDir(bool explicit_userdir);
-       /** Search for and read the LyXRC file name, return
-           true if successfull.
-       */
-       bool readRcFile(string const & name);
-       /// Read the ui file `name'
+       /// read lyxrc/preferences
+       void readRcFile(string const & name);
+       /// read the given ui (menu/toolbar) file
        void readUIFile(string const & name);
-       /// Read the languages file `name'
+       /// read the given languages file
        void readLanguagesFile(string const & name);
-       /// Read the encodings file `name'
+       /// read the given encodings file
        void readEncodingsFile(string const & name);
-       ///
-       bool easyParse(int * argc, char * argv[]);
+       /// parsing of non-gui LyX options. Returns true if gui
+       bool easyParse(int & argc, char * argv[]);
+
+       /// has this user started lyx for the first time?
+       bool first_start;
+       /// the parsed command line batch command if any
+       string batch_command;
 };
 
-#endif
+#endif // LYX_MAIN_H