lyx_mirror/src/frontends/xforms/forms
Angus Leeming b86cc3a9af (Rob Lahaye): reworking of the BibTeX and citation dialogs.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@5478 a592a061-630c-0410-9148-cb99ea01b6c8
2002-10-23 10:08:55 +00:00
..
.cvsignore
fdfix.sh This file is part of LyX, the document processor. 2002-09-05 15:14:23 +00:00
fdfixc.sed This file is part of LyX, the document processor. 2002-09-05 15:14:23 +00:00
fdfixh.sed This file is part of LyX, the document processor. 2002-09-05 15:14:23 +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 (Rob Lahaye): reworking of the BibTeX and citation dialogs. 2002-10-23 10:08:55 +00:00
form_browser.fd
form_character.fd esc to cancel 2002-09-16 23:01:53 +00:00
form_citation.fd (Rob Lahaye): reworking of the BibTeX and citation dialogs. 2002-10-23 10:08:55 +00:00
form_document.fd Fix crash in Document dialog + small sundries. 2002-08-14 21:05:10 +00:00
form_error.fd
form_ert.fd
form_external.fd
form_filedialog.fd Yet more dialog tweaking from Rob. 2002-09-12 09:07:58 +00:00
form_float.fd
form_forks.fd
form_graphics.fd Refine yesterday's bug fix a little and apply to the combox also. 2002-10-04 10:39:01 +00:00
form_include.fd remove noload/don't typeset 2002-09-09 17:32:53 +00:00
form_index.fd
form_maths_deco.fd
form_maths_delim.fd
form_maths_matrix.fd
form_maths_panel.fd
form_maths_space.fd second part of Martin's patch 2002-09-20 12:38:48 +00:00
form_maths_style.fd
form_minipage.fd
form_paragraph.fd
form_preamble.fd
form_preferences.fd Rob's followup (nr. 1 ;) 2002-08-27 20:30:20 +00:00
form_print.fd Rob's minor patch 2002-09-13 01:58:05 +00:00
form_ref.fd Rob's latest and greatest dialog tweaking. 2002-09-12 08:44:23 +00:00
form_search.fd
form_sendto.fd
form_spellchecker.fd Rob's dialog clean-up and Martin's 'disfucation' of insetgraphics. 2002-09-09 09:49:47 +00:00
form_tabular_create.fd
form_tabular.fd
form_texinfo.fd Yet more dialog tweaking from Rob. 2002-09-12 09:07:58 +00:00
form_thesaurus.fd escape can close thesaurus 2002-08-08 01:19:47 +00:00
form_toc.fd Rob's dialog clean-up and Martin's 'disfucation' of insetgraphics. 2002-09-09 09:49:47 +00:00
form_url.fd Rob's latest and greatest dialog tweaking. 2002-09-12 08:44:23 +00:00
form_wrap.fd floatflt has no "Inner" placement option. 2002-09-25 07:58:48 +00:00
Makefile.am Add insetwrap. 2002-09-10 10:18:58 +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.