Programming guideline of WinDom

Extended types and ressource editor

In the ressource editor, you can set the extended type of an object. The following table lists all extended provided by WinDom.

Avalaible extended type

~ means the state/value is forbidden
[] means an optional state/value
STATEn means the n bit of the ob_state field
DRAW3D is an alias of STATE7 (used by Interface)

Note : the first bit has a 0 index.

Extended types provided by WinDom
Nom Description ob_type type ob_flag ob_state Shortcut
XTEDINFO Long boxed text G_(BOX)TEXT 11 No
XBOXLONGTEXT Long boxed text G_(BOX)TEXT 12 No
XCICON Color icons G_CICON 13 [STATE8] No
XEDIT Editable field G_(F)TEXT 14 EDITABLE [DRAW3D] No
MENUTITLE Menu item G_STRING 15 No
MENUTITLE Menu title G_TITLE 15 No
ONGLET Thumb index G_BUTTON 16 RBUTTON [DRAW3D] Yes
button or G_STRING [STATE8]
[STATE15]
ONGLET Thumb index G_BUTTON 16 ~ RBUTTON [DRAW3D] Yes
background or G_STRING
DIALMOVER Background form G_BOX 17 [DRAW3D] No
[OUTLINE]
DCRBUTTON Radio button G_BUTTON 18 RBUTTON [DRAW3D] Yes
or G_STRING [STATE8]
DCRBUTTON Checked button G_BUTTON 18 RBUTTON [DRAW3D] Yes
or G_STRING EXIT [STATE8]
DCRBUTTON Exit button G_BUTTON 18 EXIT [DRAW3D] Yes
or G_STRING RBUTTON
[DEFAULT]
CIRCLEBUT Cycle button G_BUTTON 22 [DRAW3D] No
or G_STRING
UNDERLINE Underlined texte G_BUTTON 19 [DRAW3D] Yes
or G_STRING
TITLEBOX Frame with title G_BUTTON 20 [DRAW3D] No
HELPBUT Help button G_BUTTON 21 No
Text with G_BUTTON 24 [DISABLED] Yes
KPOPUPSTRG keyboard shortcut or G_STRING
SLIDEPART Box Char G_BOXCHAR 25 [DRAW3D] No
UNDOHELP Undo button G_BUTTON 31 No
- Undo object - - FLAG11 No
- Relief button - - [DRAW3D] No
USERDRAW Userdraw object - 255 No

Extended types provided by WinDom
Nom	Description	ob_type	type	ob_flag	ob_state	Shortcut
XTEDINFO	Long boxed text	G_(BOX)TEXT	11			No
XBOXLONGTEXT	Long boxed text	G_(BOX)TEXT	12			No
XCICON	Color icons	G_CICON	13		[STATE8]	No
XEDIT	Editable field	G_(F)TEXT	14	EDITABLE	[DRAW3D]	No
MENUTITLE	Menu item	G_STRING	15			No
MENUTITLE	Menu title	G_TITLE	15			No
ONGLET	Thumb index	G_BUTTON	16	RBUTTON	[DRAW3D]	Yes
	button	or G_STRING			[STATE8]
					[STATE15]
ONGLET	Thumb index	G_BUTTON	16	~ RBUTTON	[DRAW3D]	Yes
	background	or G_STRING
DIALMOVER	Background form	G_BOX	17		[DRAW3D]	No
					[OUTLINE]
DCRBUTTON	Radio button	G_BUTTON	18	RBUTTON	[DRAW3D]	Yes
		or G_STRING			[STATE8]
DCRBUTTON	Checked button	G_BUTTON	18	RBUTTON	[DRAW3D]	Yes
		or G_STRING		EXIT	[STATE8]
DCRBUTTON	Exit button	G_BUTTON	18	EXIT	[DRAW3D]	Yes
		or G_STRING		RBUTTON
				[DEFAULT]
CIRCLEBUT	Cycle button	G_BUTTON	22		[DRAW3D]	No
		or G_STRING
UNDERLINE	Underlined texte	G_BUTTON	19		[DRAW3D]	Yes
		or G_STRING
TITLEBOX	Frame with title	G_BUTTON	20		[DRAW3D]	No
HELPBUT	Help button	G_BUTTON	21			No
	Text with	G_BUTTON	24		[DISABLED]	Yes
KPOPUPSTRG	keyboard shortcut	or G_STRING
SLIDEPART	Box Char	G_BOXCHAR	25		[DRAW3D]	No
UNDOHELP	Undo button	G_BUTTON	31			No
-	Undo object	-	-	FLAG11		No
-	Relief button	-	-		[DRAW3D]	No
USERDRAW	Userdraw object	-	255			No

SLIDEPART is an object used to create boxchar (specially for scrolling objects) having the same apparence under TOS, Naes or MagiC.

Windom specific objects

XTEDINFO is used to display G_TEXT and G_BOXTEXT object with the same aspect (in DRAW3D mode) on TOS, MagiC or any AES replacement.
XBOXLONGTEXT is a BOXTEXT object displaying the text on several lines if needed. ObjcEdit() is used as interface to the object.
XCICON is used to display color icons. Using this king of object allows to supported color icon on any TOS version. RsrcXload() converts automatically G_CICON icon into XCICON icon using RsrcFixCicon() to fix icons to current resolution. XCICON admit additional states : STATE8 enable a transparent text, STATE9, STATE10 and STATE11 controls text effect (as describe below).
XEDIT is an editable objet with an unlimited (except the memory) text length. It is very recommanded to use it rather than classic EDITABLE object. ObjcEdit() is used as interface to the object.
MENUTITLE is used as menu title and menu item object. The text can be display using a specific font (see windom.menu.font). Keyboard shortcut are correctly aligned on the right even with a proportional font.
ONGLET is a special object for multiple formular thumb indexed. As all extended object, it is sensible to the DRAW3D state.
USERDRAW is a special type reserved by RsrcUserDraw. Please, never use this value for your own extended objects.

Mydial objects unsupported

The following objects are currently ignored by WinDom :

POPUPSTRG (23)
LONGINPUT (26)

and the bit 15 of ob_flags for editable object (multiple line editable field).

Usual extended states

Follow, the signification of the ob_state bits unused by AES but used by WinDom.

DRAW3D draws the object with a relief effect,
STATE8 draws the object with an alternative look :
- radio button:
  STATE8: button have an MagiC look,
  ~STATE8: button have a xv look,
- check button:
  STATE8: a square button with a white foreground color and a cross inside,
  ~STATE8: a square button with a ckeck symbol (OpenLook style),
- thumb index:
  STATE8: thumb index are displayed with rounded corners,
  ~STATE8: thumb index are displayed with squarred corners,
- underlined text:
  STATE8: the object is underlined,
  ~STATE8: only the text inside the object is underlined,
All extended object including text support the following text attributs :

Attributs de texte
ob_state bit Attribut
STATE9 Bold
STATE10 Underline
STATE11 Italic
STATE12 Outline
STATE13 Shadow
STATE14 Light

Note: the light attribut is used when an object has the state DISABLED.

Attributs de texte
ob_state bit	Attribut
STATE9	Bold
STATE10	Underline
STATE11	Italic
STATE12	Outline
STATE13	Shadow
STATE14	Light

Keyboard shortcuts

Some objects can display a keybord shortcut (see table ...). A keyboard shortcut is a underlined letter inside the text. It means that the object can be selected by typing the key combinaison [Alternate + letter]. To make appear this shortcut, just add a '[' character behing the letter. For example:

[Cancel -> Cancel -> alt+c.