A lean, clean and working start to the new, improved gnome frontend.

[lyx.git] / src / frontends / gnome / README

diff --git a/src/frontends/gnome/README b/src/frontends/gnome/README
index 291b7de43509680989d8ae0097c31eb534fdbb12..322cb2e8c99acbccc456f0fa6989a4042cc1c942 100644 (file)
--- a/src/frontends/gnome/README
+++ b/src/frontends/gnome/README
@@ -2,11 +2,16 @@ GNOME FRONT END
 ===============
 
 Firstly, this stuff is pre-alpha.  I don't use it so you shouldn't
-either.  At all, no exceptions :). 
+either.  At all, no exceptions :). Secondly I'm no c++ guru, I'm
+learning as I go along so if something looks stupid, there's a good
+chance it is.
+
+Adding Dialogs
+--------------
 
 The GNOME frontend of LyX uses libglade to draw the dialogs.  The base
 (GnomeBase.C) class handles the drawing and activating of the Dialogs,
-for an example of contructing a simple dialog see FormUrl.[Ch]
+for an example of contructing a simple dialog see GUrl.[Ch]
 
 FormUrl::FormUrl(ControlUrl & c)
        : FormCB<ControlUrl>(c, "FormUrl")
@@ -20,21 +25,35 @@ If you look at FormUrl you'll see that there are a number of
 helper functions at the bottom of the .C file.  These are
 automatically generated by accessors.py
 
-Glade files now must follow the following conventions:
+For accessors.py to work glade files now must adhere to the following
+conventions: 
+
+ * The root widget and the file should be named after the form (i.e
+   FormTabularCreate & FormTabularCreate.glade)  
+ * Functional widgets, those actually used rather than the filler
+   widgets like Gtk::HBox etc,  should have an r_ as the first two
+   characters of their name. (see below)
+
+To make the build system include your new dialog edit Makefile.am as
+follows:
+ 1) make clean in src/frontends/gnome/
+ 2) Add GX.C and GX.h to libgnome_la_SOURCES
+ 3) Remove FormX.lo and form_x.lo (if applicable) from xforms_objects
+ 4) make clean && make in src/frontends/
+ 5) make in src/
 
- * The filename should be the same as the .C and .h Files (i.e
-   FormTabularCreate.glade) 
- * The root widget should have the same name
- * Functional widgets should have an r_ as the first two characters of
-   their name. (see below)
 
-USING ACCESSORS.PY
-==================
+Using accessors.py
+------------------
 
 Usage:
 
 python accessors.py glade_ui_file DialogClass
 
+e.g
+
+python accessors.py FormTabularCreate.glade GTabularCreate
+
 Accessors.py will write the helper functions to DialogClass.C_gen and
 the function declarations to DialogClass.g_gen.  To ensure the widgets
 you're interested in are made available using this method, prefix the