GadTools Gadgets - Revision history

Costel Mincea: Text replacement - "" to ""

2025-01-26T19:25:24Z

Text replacement - "<syntaxhighlight>" to "<syntaxhighlight lang="C" line>"

Rob Cranley: /* Slider Gadgets */ Fixed typo (possible Unicode copy/paste error).

2017-06-29T16:35:57Z

Slider Gadgets: Fixed typo (possible Unicode copy/paste error).

← Older revision		Revision as of 16:35, 29 June 2017
Line 625:		Line 625:
	: Set this attribute to TRUE to disable the slider, to FALSE otherwise. The default is FALSE. (Create and set.)		: Set this attribute to TRUE to disable the slider, to FALSE otherwise. The default is FALSE. (Create and set.)

	Up to three different classes of IntuiMessage may be received at the port when the user plays with a slider, these are IDCMP_MOUSEMOVE, IDCMP_GADGETUP and IDCMP_GADGETDOWN. The program may examine the IntuiMessage Code field to discover the ~~slider‚Äôs~~ level.		Up to three different classes of IntuiMessage may be received at the port when the user plays with a slider, these are IDCMP_MOUSEMOVE, IDCMP_GADGETUP and IDCMP_GADGETDOWN. The program may examine the IntuiMessage Code field to discover the slider's level.

	IDCMP_MOUSEMOVE IntuiMessages will be heard whenever the slider's level changes. IDCMP_MOUSEMOVE IntuiMessages will not be heard if the knob has not moved far enough for the level to actually change. For example if the slider runs from 0 to 15 and is currently set to 12, if the user drags the slider all the way up the program will hear no more than three IDCMP_MOUSEMOVEs, one each for 13, 14 and 15.		IDCMP_MOUSEMOVE IntuiMessages will be heard whenever the slider's level changes. IDCMP_MOUSEMOVE IntuiMessages will not be heard if the knob has not moved far enough for the level to actually change. For example if the slider runs from 0 to 15 and is currently set to 12, if the user drags the slider all the way up the program will hear no more than three IDCMP_MOUSEMOVEs, one each for 13, 14 and 15.

Steven Solie: /* Functions for Setting up GadTools Menus and Gadgets */

2015-11-03T23:02:37Z

Functions for Setting up GadTools Menus and Gadgets

← Older revision		Revision as of 23:02, 3 November 2015
Line 830:		Line 830:
	=== Functions for Setting up GadTools Menus and Gadgets ===		=== Functions for Setting up GadTools Menus and Gadgets ===

	This section gives all the details on the functions used to set up GadTools menus and gadgets that were mentioned briefly earlier in this ~~chapter~~.		This section gives all the details on the functions used to set up GadTools menus and gadgets that were mentioned briefly earlier in this article.

	==== GetVisualInfo() and FreeVisualInfo() ====		==== GetVisualInfo() and FreeVisualInfo() ====

Steven Solie: /* Modifying Gadgets */

2015-11-03T23:02:23Z

Modifying Gadgets

← Older revision		Revision as of 23:02, 3 November 2015
Line 422:		Line 422:
	When changing a gadget using these functions, the gadget will automatically update its visuals. No refresh is required, nor should any refresh call be performed.		When changing a gadget using these functions, the gadget will automatically update its visuals. No refresh is required, nor should any refresh call be performed.

	{{Note\|title=Warning\|text=The GT_SetGadgetAttrs() functions may not be called inside of a GT_BeginRefresh()/GT_EndRefresh() pair. This is true of Intuition gadget functions generally, including those discussed in ~~the~~ [[Intuition_Gadgets\|Intuition Gadgets]] ~~chapter~~.}}		{{Note\|title=Warning\|text=The GT_SetGadgetAttrs() functions may not be called inside of a GT_BeginRefresh()/GT_EndRefresh() pair. This is true of Intuition gadget functions generally, including those discussed in [[Intuition_Gadgets\|Intuition Gadgets]].}}

	In the sections that follow all the possible attributes for each kind of gadget are discussed. The tags are also described in the Autodocs for GT_SetGadgetAttrs() in the SDK.		In the sections that follow all the possible attributes for each kind of gadget are discussed. The tags are also described in the Autodocs for GT_SetGadgetAttrs() in the SDK.

Steven Solie: /* IDCMP Flags */

2015-11-03T23:01:58Z

IDCMP Flags

← Older revision		Revision as of 23:01, 3 November 2015
Line 182:		Line 182:
	=== IDCMP Flags ===		=== IDCMP Flags ===

	The various GadTools gadget types require certain classes of IDCMP messages in order to work. Applications specify these IDCMP classes when the window is opened or later with ModifyIDCMP() (see [[Intuition_Windows\|Intuition Windows]] ~~chapter~~ for more on this). Each kind of GadTools gadget requires one or more of these IDCMP classes: IDCMP_GADGETUP, IDCMP_GADGETDOWN, IDCMP_MOUSEMOVE, IDCMP_MOUSEBUTTONS and IDCMP_INTUITICKS. As a convenience, the IDCMP classes required by each kind of gadget are defined in <libraries/gadtools.h>. For example, SLIDERIDCMP is defined to be:		The various GadTools gadget types require certain classes of IDCMP messages in order to work. Applications specify these IDCMP classes when the window is opened or later with ModifyIDCMP() (see [[Intuition_Windows\|Intuition Windows]] for more on this). Each kind of GadTools gadget requires one or more of these IDCMP classes: IDCMP_GADGETUP, IDCMP_GADGETDOWN, IDCMP_MOUSEMOVE, IDCMP_MOUSEBUTTONS and IDCMP_INTUITICKS. As a convenience, the IDCMP classes required by each kind of gadget are defined in <libraries/gadtools.h>. For example, SLIDERIDCMP is defined to be:

	<syntaxhighlight>		<syntaxhighlight>

Steven Solie: /* Handling Gadget Messages */

2015-11-03T23:01:43Z

Handling Gadget Messages

← Older revision		Revision as of 23:01, 3 November 2015
Line 176:		Line 176:
	The GT_ReplyIMsg() call will take care of cleaning up and replying to the real IntuiMessage.		The GT_ReplyIMsg() call will take care of cleaning up and replying to the real IntuiMessage.

	{{Note\|title=Warning\|text=When an IDCMP_MOUSEMOVE message is received from a GadTools gadget, GadTools arranges to have the gadget's pointer in the IAddress field of the IntuiMessage. While this is extremely convenient, it is also untrue of messages from regular Intuition gadgets (described in ~~the~~ [[Intuition_Gadgets\|Intuition Gadgets]] ~~chapter~~). Do not make the mistake of assuming it to be true.}}		{{Note\|title=Warning\|text=When an IDCMP_MOUSEMOVE message is received from a GadTools gadget, GadTools arranges to have the gadget's pointer in the IAddress field of the IntuiMessage. While this is extremely convenient, it is also untrue of messages from regular Intuition gadgets (described in [[Intuition_Gadgets\|Intuition Gadgets]]). Do not make the mistake of assuming it to be true.}}

	This description of the inner workings of GT_GetIMsg() and GT_ReplyIMsg() is provided for understanding only; it is crucial that the program make no assumptions or interpretations about the real IntuiMessage. Any such inferences are not likely to hold true in the future. See the section on documented side-effects for more information.		This description of the inner workings of GT_GetIMsg() and GT_ReplyIMsg() is provided for understanding only; it is crucial that the program make no assumptions or interpretations about the real IntuiMessage. Any such inferences are not likely to hold true in the future. See the section on documented side-effects for more information.

Steven Solie at 22:55, 3 November 2015

2015-11-03T22:55:48Z

← Older revision		Revision as of 22:55, 3 November 2015
Line 1:		Line 1:
	{{CodeReview}}
	=== Introduction ===		=== Introduction ===

Steven Solie: /* Complete GadTools Gadget Example */

2015-11-03T22:55:32Z

Complete GadTools Gadget Example

Show changes

Steven Solie: /* Denoting a Gadget's Keyboard Equivalent */

2015-11-03T22:42:52Z

Denoting a Gadget's Keyboard Equivalent

← Older revision		Revision as of 22:42, 3 November 2015
Line 1,104:		Line 1,104:
	In order to denote the key equivalent, the application may add a marker-symbol to the gadget label. This is done by placing the marker-symbol immediately before the character to be underscored. This symbol can be any character that is not used in the label. The underscore character, "_" is the recommended marker-symbol. So, for example, to mark the letter "F" as the keyboard equivalent for a button labelled "Select Font ...", create the gadget text:		In order to denote the key equivalent, the application may add a marker-symbol to the gadget label. This is done by placing the marker-symbol immediately before the character to be underscored. This symbol can be any character that is not used in the label. The underscore character, "_" is the recommended marker-symbol. So, for example, to mark the letter "F" as the keyboard equivalent for a button labelled "Select Font ...", create the gadget text:

			<syntaxhighlight>
	<pre>
	ng.ng_GadgetText = ~~"~~Select _Font ...~~"~~;		ng.ng_GadgetText = "Select _Font ...";
			</syntaxhighlight>
	</pre>

	To inform GadTools of the underscore in the label, pass the GA_Underscore tag to CreateGadget() or CreateGadgetA(). The data-value associated with this tag is a character, not a string, which is the marker-symbol used in the gadget label:		To inform GadTools of the underscore in the label, pass the GA_Underscore tag to CreateGadget() or CreateGadgetA(). The data-value associated with this tag is a character, not a string, which is the marker-symbol used in the gadget label:

			<syntaxhighlight>
	<pre>
	GA_Underscore, '_', /* Note '_', not ~~"~~_~~"~~ !!! */		GA_Underscore, '_', /* Note '_', not "_" !!! */
			</syntaxhighlight>
	</pre>

	GadTools will create a gadget label which consists of the text supplied with the marker-symbol removed and the character following the marker-symbol underscored.		GadTools will create a gadget label which consists of the text supplied with the marker-symbol removed and the character following the marker-symbol underscored.
Line 1,118:		Line 1,118:
	The gadget's label would look something like:		The gadget's label would look something like:

		⚫	Select <u>F</u>ont ...
	<pre>
⚫	Select ~~Font~~ ...
	</pre>

	==== Implementing a Gadget's Keyboard Equivalent Behavior ====		==== Implementing a Gadget's Keyboard Equivalent Behavior ====

Steven Solie: /* DrawBevelBox() */

2015-11-03T22:40:28Z

DrawBevelBox()

← Older revision		Revision as of 22:40, 3 November 2015
Line 1,077:		Line 1,077:
	A key visual signature shared by most GadTools gadgets is the raised or recessed beveled box imagery. Since the program may wish to create its own boxes to match, GadTools provides the DrawBevelBox() and DrawBevelBoxA() functions.		A key visual signature shared by most GadTools gadgets is the raised or recessed beveled box imagery. Since the program may wish to create its own boxes to match, GadTools provides the DrawBevelBox() and DrawBevelBoxA() functions.

			<syntaxhighlight>
	<pre>
	VOID DrawBevelBoxA( struct RastPort *rport, LONG left, LONG top, LONG width, LONG height,		VOID DrawBevelBoxA( struct RastPort *rport, LONG left, LONG top, LONG width, LONG height,
	struct TagItem *taglist );		struct TagItem *taglist );
	VOID DrawBevelBox ( struct RastPort *rport, LONG left, LONG top, LONG width, LONG height,		VOID DrawBevelBox ( struct RastPort *rport, LONG left, LONG top, LONG width, LONG height,
	Tag tag1, ... );		Tag tag1, ... );
			</syntaxhighlight>
	</pre>

	The rport argument is a pointer to the RastPort into which the box is to be rendered. The left, top, width and height arguments specify the dimensions of the desired box.		The rport argument is a pointer to the RastPort into which the box is to be rendered. The left, top, width and height arguments specify the dimensions of the desired box.