Macro Object Creators

Macro Object Creators Contains function creating macros structures objects ready-to-use (like slider, desktop menu, ...). More...

Defines
#define	dfrm_new_dmenu(d, t, i)   mt_dfrm_new_dmenu(gl_appvar,d,t,i)
	Macro function building a minimal structure for a desktop menu, see mt_dfrm_new_dmenu().
#define	dfrm_new_slider(d, s, o, u, b, sl, dn)   mt_dfrm_new_slider(gl_appvar,d,s,o,u,b,sl,dn)
	Macro function building a slider, see mt_dfrm_new_slider().
#define	dfrm_thumb_new(d, s)   mt_dfrm_thumb_new(gl_appvar,d,s)
	TODO, see mt_dfrm_thumb_new().
#define	dfrm_thumb_add(d, r, l)   mt_dfrm_thumb_add(gl_appvar,d,r,l)
	TODO, see mt_dfrm_thumb_add().
#define	dfrm_thumb_end(d, r, w)   mt_dfrm_thumb_end(gl_appvar,d,r,w)
	TODO, see mt_dfrm_thumb_end().
Functions
int	mt_dfrm_new_dmenu (APPvar *ap, void *dfrm, char *title, char *info)
	Macro function building a minimal structure for a desktop menu.
int	mt_dfrm_new_slider (APPvar *ap, void *dfrm, int size, int ori, int *up, int *bg, int *sld, int *dn)
	Macro function building a slider.
int	mt_dfrm_thumb_new (APPvar *ap, void *dfrm, int style)
int	mt_dfrm_thumb_add (APPvar *ap, void *dfrm, int root, char *label)
void	mt_dfrm_thumb_end (APPvar *ap, void *dfrm, int root, WINDOW *win)

---

Detailed Description

Macro Object Creators Contains function creating macros structures objects ready-to-use (like slider, desktop menu, ...).

---

Define Documentation

#define dfrm_new_dmenu	(	d,
		t,
		i		)	mt_dfrm_new_dmenu(gl_appvar,d,t,i)

Macro function building a minimal structure for a desktop menu, see mt_dfrm_new_dmenu().

#define dfrm_new_slider	(	d,
		s,
		o,
		u,
		b,
		sl,
		dn		)	mt_dfrm_new_slider(gl_appvar,d,s,o,u,b,sl,dn)

Macro function building a slider, see mt_dfrm_new_slider().

#define dfrm_thumb_add	(	d,
		r,
		l		)	mt_dfrm_thumb_add(gl_appvar,d,r,l)

TODO, see mt_dfrm_thumb_add().

#define dfrm_thumb_end	(	d,
		r,
		w		)	mt_dfrm_thumb_end(gl_appvar,d,r,w)

TODO, see mt_dfrm_thumb_end().

#define dfrm_thumb_new	(	d,
		s		)	mt_dfrm_thumb_new(gl_appvar,d,s)

TODO, see mt_dfrm_thumb_new().

---

Function Documentation

int mt_dfrm_new_dmenu	(	APPvar *	app,
		void *	menu,
		char *	title,
		char *	info
	)

Macro function building a minimal structure for a desktop menu.

Parameters:

	app	application descriptor,
	menu	form pointer,
	title	text of application menu,
	info	text of info entry in application menu.

Returns:

mt_dfrm_new_dmenu() adds in a menu dialog tree (created with mt_dfrm_create() using DFRM_MENU mode), the minimal structure for using it as a desktop menu.

The function creates a first entry in the menu bar. The label of this entry is specified by the parameter title. By GEM convention, the label's entry contains the name of application. The function creates in this menu entry 7 entries. The first entry is used to display information about the program and the label is specified by the parameter (!I)info(!i). The six next entries are used by AES to handle desktop accessories.

References ALIGN_JUSTIFY, dfrm_add(), dfrm_align(), dfrm_setstate(), DIR_HORI, DIR_VERT, mt_dfrm_add_menu(), mt_dfrm_new_label(), and TYPE_LABEL.

int mt_dfrm_new_slider	(	APPvar *	app,
		void *	dfrm,
		int	size,
		int	ori,
		int *	up,
		int *	bg,
		int *	sld,
		int *	dn
	)

Macro function building a slider.

Parameters:

	app	application descriptor;
	dfrm	form pointer,
	size	width (for horizontal slider) or height (for vertical slider) of slider,
	ori	orientation of the slider, possible values are : SLD_HORI horizontal slider, SLD_VERT vertical slider.
	up	pointer to the UP object index,
	dn	pointer to the DOWN object index,
	bg	pointer to the BACKGROUND slider object index,
	sld	pointer to the CURSOR object index.

Returns:

dfrm_new_slider() creates a structure of objects which can host a slider. This slider can be handled by the Slider library of WinDom (see WinDom documentation). Slider created contains four objects :

     /---UP object  /----- CURSOR object
     |             /  /--- DOWN object
    --------------------
    |<|          |x| |>|
    --------------------
         |
         \----- BACKGROUND object (father of CURSOR)

References dfrm_add(), dfrm_new_box(), dfrm_new_cbox(), dfrm_setflags(), dfrm_setstate(), dfrm_tree(), DIR_HORI, DIR_VERT, DRAW3D, and TE_TRANS.

int mt_dfrm_thumb_add	(	APPvar *	ap,
		void *	dfrm,
		int	root,
		char *	label
	)

References ALIGN_JUSTIFY, dfrm_thumb::but, dfrm_thumb::count, dfrm_add(), dfrm_align(), dfrm_setflags(), dfrm_seth(), dfrm_tree(), DIR_HORI, DIR_NONE, dfrm_thumb::frm, mt_dfrm_new_button(), dfrm_thumb::rbut, and TYPE_IBUT.

void mt_dfrm_thumb_end	(	APPvar *	ap,
		void *	dfrm,
		int	root,
		WINDOW *	win
	)

References dfrm_thumb::but, dfrm_thumb::count, dfrm_order(), dfrm_tree(), dfrm_thumb::frm, dfrm_thumb::obspec, ORD_BOT, dfrm_thumb::rbut, and dfrm_thumb::root.

int mt_dfrm_thumb_new	(	APPvar *	ap,
		void *	dfrm,
		int	style
	)

References dfrm_thumb::but, dfrm_thumb::count, dfrm_add(), dfrm_new_box(), dfrm_tree(), DIR_VERT, dfrm_thumb::frm, dfrm_thumb::obspec, dfrm_thumb::rbut, dfrm_thumb::rfrm, and dfrm_thumb::root.