lyx_mirror/src/frontends/xforms/forms
John Levon 2b2c661f84 Michael's text fixes
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@5980 a592a061-630c-0410-9148-cb99ea01b6c8
2003-01-23 16:23:43 +00:00
..
.cvsignore
c_str.sed I declare these scripts finished. Probably. 2002-11-27 17:15:23 +00:00
fdfix.sh I declare these scripts finished. Probably. 2002-11-27 17:15:23 +00:00
fdfixc.sed Minor bits 'n' bobs from Michael, J�rgen and Jean-Marc. 2003-01-06 14:02:24 +00:00
fdfixh.sed (Rob Lahaye): bug fix. 2002-11-28 11:59:28 +00:00
form_aboutlyx.fd Rob's about LyX dialog, tweaked a little. 2002-10-22 15:00:45 +00:00
form_bibitem.fd Rob's dialog clean-up and Martin's 'disfucation' of insetgraphics. 2002-09-09 09:49:47 +00:00
form_bibtex.fd Minor bits 'n' bobs from Michael, J�rgen and Jean-Marc. 2003-01-06 14:02:24 +00:00
form_browser.fd (Rob Lahaye): minor xforms nits 'n' bobs. 2002-10-24 12:56:44 +00:00
form_character.fd Michael's text fixes 2003-01-23 16:23:43 +00:00
form_citation.fd Minor bits 'n' bobs from Michael, J�rgen and Jean-Marc. 2003-01-06 14:02:24 +00:00
form_document.fd Michael's text fixes 2003-01-23 16:23:43 +00:00
form_error.fd Consistent use of Escape and Return as accelerators for Cancel/Close and OK. 2003-01-15 21:21:01 +00:00
form_ert.fd
form_external.fd Michael's text fixes 2003-01-23 16:23:43 +00:00
form_filedialog.fd Yet more dialog tweaking from Rob. 2002-09-12 09:07:58 +00:00
form_float.fd (Rob Lahaye): small clean-up of the clean-ups already applied. 2002-10-24 09:48:56 +00:00
form_forks.fd Michael's text fixes 2003-01-23 16:23:43 +00:00
form_graphics.fd Michael's text fixes 2003-01-23 16:23:43 +00:00
form_include.fd remove noload/don't typeset 2002-09-09 17:32:53 +00:00
form_index.fd Michael's text fixes 2003-01-23 16:23:43 +00:00
form_maths_delim.fd * A controller-view split of the math panel and its daughter dialogs. 2002-11-25 18:58:15 +00:00
form_maths_matrix.fd Michael's text fixes 2003-01-23 16:23:43 +00:00
form_maths_panel.fd Michael's text fixes 2003-01-23 16:23:43 +00:00
form_maths_space.fd Consistent use of Escape and Return as accelerators for Cancel/Close and OK. 2003-01-15 21:21:01 +00:00
form_maths_style.fd Consistent use of Escape and Return as accelerators for Cancel/Close and OK. 2003-01-15 21:21:01 +00:00
form_minipage.fd
form_paragraph.fd remove extra spaces; fix error message with xforms menus 2002-12-26 14:14:29 +00:00
form_preamble.fd fix preamble dialog 2002-10-26 02:19:03 +00:00
form_preferences.fd Michael's text fixes 2003-01-23 16:23:43 +00:00
form_print.fd Michael's text fixes 2003-01-23 16:23:43 +00:00
form_ref.fd Michael's text fixes 2003-01-23 16:23:43 +00:00
form_search.fd Minor bits 'n' bobs from Michael, J�rgen and Jean-Marc. 2003-01-06 14:02:24 +00:00
form_sendto.fd Michael's text fixes 2003-01-23 16:23:43 +00:00
form_spellchecker.fd Michael's text fixes 2003-01-23 16:23:43 +00:00
form_tabular_create.fd Michael's text fixes 2003-01-23 16:23:43 +00:00
form_tabular.fd Michael's text fixes 2003-01-23 16:23:43 +00:00
form_texinfo.fd (Rob Lahaye): updates to the xforms print, spellchecker, texinfo and wrap 2002-10-25 09:16:22 +00:00
form_thesaurus.fd Michael's text fixes 2003-01-23 16:23:43 +00:00
form_toc.fd Michael's text fixes 2003-01-23 16:23:43 +00:00
form_url.fd Michael's text fixes 2003-01-23 16:23:43 +00:00
form_wrap.fd (Rob Lahaye): updates to the xforms print, spellchecker, texinfo and wrap 2002-10-25 09:16:22 +00:00
Makefile.am make distcheck work 2003-01-12 22:24:47 +00:00
README

All .fd files go in this directory.
Each .fd file should have just one form in them

NOTE: An exception to the above is any tabbed form which 
      xforms requires multiple forms to create.  In that case
      the group of forms constitutes one gui form.

* All forms should be named form_xxx and saved into a file of the same name.
For example, the copyright notice is called form_copyright and is stored in
form_copyright.fd.
Tabbed folders should be named form_xxx_yyy.
For example, the file folder in the graphics dialog has the identifier
form_graphics_file.

If you match this pattern, the fdfix.sh script will be able to manipulate
the generated .c and .h files to produce the .C and .h files used by LyX. A form
called form_xxx will result in a struct FD_xxx.

* Name all buttons and other form components that are likely to cause a
callback. The names should be of the form:  button_ok, radio_group_item and
so on.

Being more explicit:
	class             | prefix
	------------------+-------
	FL_BROWSER        | browser
	FL_BUTTON         | button
	FL_PIXMAPBUTTON   | button
	FL_CHECKBUTTON    | check
	FL_CHOICE         | choice
	FL_COUNTER        | counter
	FL_DIAL           | dial
	FL_INPUT          | input
	FL_FRAME          | frame
	FL_LABELFRAME     | frame
	FL_ROUND3DBUTTON,
	RADIO_BUTTON      | radio
	FL_SLIDER         | slider
	FL_VALSLIDER      | slider
	FL_TABFOLDER      | tabfolder
	FL_TEXT           | text

The only exceptions to this are objects that are to be converted in the sed
scripts. At the moment this applies only to bmtable:

	Convert an FL_BUTTON to a FL_BMTABLE by using prefix "bmtable".

Enter the full name of the callback eg.:
        C_FormBaseOkCB

If you follow these simple rules then you will generate code for functions
build_xxx that will need no further editing to make them work. For example,
form_graphics.h contains the struct declarations and build methods, so:

extern FD_graphics * build_graphics(void *);
extern FD_graphics_file * build_graphics_file(void *);
extern FD_graphics_size * build_graphics_size(void *);
extern FD_graphics_bbox * build_graphics_bbox(void *);
extern FD_graphics_special * build_graphics_special(void *);
extern FD_graphics_lyxview * build_graphics_lyxview(void *);

where the function is to be passed a pointer to the parent dialog
(usually "this") so that this pointer can be cast off to FormBase * in the
assigned callback function and the appropriate class method called.