remove noload/don't typeset

[lyx.git] / src / lyx_main.h

diff --git a/src/lyx_main.h b/src/lyx_main.h
index c56d5ea9a72b4b4d7c542801aa6d6b911033bd3b..7cffdde9135c3aa974e5b31d76158cecdd98df27 100644 (file)
--- a/src/lyx_main.h
+++ b/src/lyx_main.h
@@ -1,16 +1,11 @@
 // -*- 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
@@ -19,73 +14,61 @@
 #pragma interface
 #endif
 
-#include <csignal>
-
 #include "LString.h"
 
-#include <boost/smart_ptr.hpp>
+#include <boost/scoped_ptr.hpp>
 #include <boost/utility.hpp>
 
-class LyXGUI;
+#include <csignal>
+
 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.
-       */
+       /// return true if the given prefs file was successfully read
        bool readRcFile(string const & name);
-       /// Read the ui file `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