Intuition Gadgets - Revision history

Costel Mincea: Text replacement - "" to ""

2025-01-26T19:15:59Z

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

← Older revision		Revision as of 19:15, 26 January 2025
Line 58:		Line 58:
	The example below demonstrates a simple application gadget. The program declares a Gadget structure set up as a boolean gadget with complement mode highlighting. The gadget is attached to the window when it is opened by using the WA_Gadgets tag in the OpenWindowTags() call.		The example below demonstrates a simple application gadget. The program declares a Gadget structure set up as a boolean gadget with complement mode highlighting. The gadget is attached to the window when it is opened by using the WA_Gadgets tag in the OpenWindowTags() call.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	/*		/*
	** simplegad.c - show the use of a button gadget.		** simplegad.c - show the use of a button gadget.
Line 186:		Line 186:
	AddGList() adds a gadget list that you specify to the existing gadget list of a window or requester:		AddGList() adds a gadget list that you specify to the existing gadget list of a window or requester:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	UWORD AddGList( struct Window window, struct Gadget agadget,		UWORD AddGList( struct Window window, struct Gadget agadget,
	ULONG position, LONG numGad, struct Requester *requester );		ULONG position, LONG numGad, struct Requester *requester );
Line 195:		Line 195:
	To remove gadgets from a window or requester use RemoveGList():		To remove gadgets from a window or requester use RemoveGList():

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	UWORD RemoveGList( struct Window remPtr, struct Gadget agadget, LONG numGad );		UWORD RemoveGList( struct Window remPtr, struct Gadget agadget, LONG numGad );
	</syntaxhighlight>		</syntaxhighlight>
Line 449:		Line 449:
	Using the intuition.library function HelpControl(), an application can turn Gadget Help on and off for a window:		Using the intuition.library function HelpControl(), an application can turn Gadget Help on and off for a window:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	VOID HelpControl(struct Window *my_win, ULONG help_flags);		VOID HelpControl(struct Window *my_win, ULONG help_flags);
	</syntaxhighlight>		</syntaxhighlight>
Line 464:		Line 464:
	field of the gadget:		field of the gadget:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	sysgtype = ((struct Gadget *)imsg->IAddress)->GadgetType & GTYP_SYSTYPEMASK;		sysgtype = ((struct Gadget *)imsg->IAddress)->GadgetType & GTYP_SYSTYPEMASK;
	</syntaxhighlight>		</syntaxhighlight>
Line 496:		Line 496:
	Adding the bounding box feature to Intuition gadgets required extending the Gadget structure. The ExtGadget structure is a superset of the old Gadget structure (from <intuition/intuition.h>):		Adding the bounding box feature to Intuition gadgets required extending the Gadget structure. The ExtGadget structure is a superset of the old Gadget structure (from <intuition/intuition.h>):

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct ExtGadget		struct ExtGadget
	{		{
Line 530:		Line 530:
	Here is the specification for the Gadget structure defined in <intuition/intuition.h>. You create an instance of this structure for each gadget you place in a window or requester:		Here is the specification for the Gadget structure defined in <intuition/intuition.h>. You create an instance of this structure for each gadget you place in a window or requester:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct Gadget		struct Gadget
	{		{

Steven Solie: /* Hand drawn Gadgets */

2015-11-03T20:28:25Z

Hand drawn Gadgets

← Older revision		Revision as of 20:28, 3 November 2015
Line 211:		Line 211:
	=== Hand drawn Gadgets ===		=== Hand drawn Gadgets ===

	Bitmap or custom images are used as imagery for a gadget by setting the GFLG_GADGIMAGE flag in the Flags field of the Gadget structure. An Image structure must be set up to manage the bitmap data. The address of the Image structure is placed into the gadget's GadgetRender field. The bitmap image will be positioned relative to the gadget's select box. For more information about creating Intuition images, see [[Intuition_Images,_Line_Drawing_and_Text\|Intuition Images, Line Drawing, and Text]]. For a listing of the Gadget structure and all its flags see the "Gadget Structure" section ~~later in this chapter~~.		Bitmap or custom images are used as imagery for a gadget by setting the GFLG_GADGIMAGE flag in the Flags field of the Gadget structure. An Image structure must be set up to manage the bitmap data. The address of the Image structure is placed into the gadget's GadgetRender field. The bitmap image will be positioned relative to the gadget's select box. For more information about creating Intuition images, see [[Intuition_Images,_Line_Drawing_and_Text\|Intuition Images, Line Drawing, and Text]]. For a listing of the Gadget structure and all its flags see the [[#Gadget Structure\|Gadget Structure]] section.

	=== Line drawn Gadgets ===		=== Line drawn Gadgets ===

Steven Solie: /* About Gadgets */

2015-11-03T20:27:55Z

About Gadgets

← Older revision		Revision as of 20:27, 3 November 2015
Line 11:		Line 11:
	There are two kinds of gadgets: ''system gadgets'' and ''application gadgets''. System gadgets are set up by Intuition to handle the positioning and depth arranging of screens, and to handle the positioning, sizing, closing and depth arranging of windows. System gadgets always use the same imagery and location giving the windows and screens of any application a basic set of controls that are familiar and easy to operate. In general, applications do not have to do any processing for system gadgets; Intuition does all the work.		There are two kinds of gadgets: ''system gadgets'' and ''application gadgets''. System gadgets are set up by Intuition to handle the positioning and depth arranging of screens, and to handle the positioning, sizing, closing and depth arranging of windows. System gadgets always use the same imagery and location giving the windows and screens of any application a basic set of controls that are familiar and easy to operate. In general, applications do not have to do any processing for system gadgets; Intuition does all the work.

	Application gadgets are set up by an application program. These may be the basic gadget types described in this ~~chapter~~, the pre-fabricated gadgets supplied by the GadTools library, or special gadget types defined through Intuition's custom gadget and BOOPSI facilities. Application gadgets can be placed anywhere within a window and can use just about any image. The action associated with an application gadget is carried out by the application.		Application gadgets are set up by an application program. These may be the basic gadget types described in this article, the pre-fabricated gadgets supplied by the GadTools library, or special gadget types defined through Intuition's custom gadget and BOOPSI facilities. Application gadgets can be placed anywhere within a window and can use just about any image. The action associated with an application gadget is carried out by the application.

	There are four basic types of application gadgets:		There are four basic types of application gadgets:
Line 203:		Line 203:
	The Gadget structure should never be directly modified after it has been added to a window or requester. To modify a gadget, first remove it with RemoveGList(), modify the structure as needed, and then add the gadget back to the system with AddGList(). Finally, refresh the gadget imagery with RefreshGList(). (See [[#Gadget Refreshing\|Gadget Refreshing]] for more information.)		The Gadget structure should never be directly modified after it has been added to a window or requester. To modify a gadget, first remove it with RemoveGList(), modify the structure as needed, and then add the gadget back to the system with AddGList(). Finally, refresh the gadget imagery with RefreshGList(). (See [[#Gadget Refreshing\|Gadget Refreshing]] for more information.)

	Some attributes of a gadget may be modified through special Intuition functions that perform the modification. When using such functions it is not necessary to remove, add or refresh the gadget. These functions, such as NewModifyProp(), OnGadget() and OffGadget(), are described later in this ~~chapter~~.		Some attributes of a gadget may be modified through special Intuition functions that perform the modification. When using such functions it is not necessary to remove, add or refresh the gadget. These functions, such as NewModifyProp(), OnGadget() and OffGadget(), are described later in this article.

	== Gadget Imagery ==		== Gadget Imagery ==

Steven Solie: /* Intuition Gadgets */

2015-11-03T20:27:25Z

Intuition Gadgets

← Older revision		Revision as of 20:27, 3 November 2015
Line 1:		Line 1:
	== Intuition Gadgets ==		== Intuition Gadgets ==

	This ~~chapter~~ describes the multi-purpose software controls called gadgets. Gadgets are software controls symbolized by an image that the user can operate with the mouse or keyboard. They are the Amiga's equivalent of buttons, knobs and dials.		This article describes the multi-purpose software controls called gadgets. Gadgets are software controls symbolized by an image that the user can operate with the mouse or keyboard. They are the Amiga's equivalent of buttons, knobs and dials.

	Much of the user's input to an application takes place through gadgets in the application's windows and requesters. Gadgets are also used by Intuition itself for handling screen and window movement and depth arrangement, as well as window sizing and closing.		Much of the user's input to an application takes place through gadgets in the application's windows and requesters. Gadgets are also used by Intuition itself for handling screen and window movement and depth arrangement, as well as window sizing and closing.

Steven Solie: /* Adding and Removing Gadgets */

2015-11-03T20:27:01Z

Adding and Removing Gadgets

← Older revision		Revision as of 20:27, 3 November 2015
Line 182:		Line 182:
	Gadgets may be added to a window or requester when the window or requester is opened, or they may be added later. To add the gadgets when a window is opened, use the WA_Gadgets tag with the OpenWindowTagList() call. This technique is demonstrated in the example above. For a requester, set the ReqGadget field in the Requester structure to point to the first gadget in the list.		Gadgets may be added to a window or requester when the window or requester is opened, or they may be added later. To add the gadgets when a window is opened, use the WA_Gadgets tag with the OpenWindowTagList() call. This technique is demonstrated in the example above. For a requester, set the ReqGadget field in the Requester structure to point to the first gadget in the list.

	To add or remove gadgets in a window or requester that is already open, use AddGList() or RemoveGList(). These functions operate on gadgets arranged in a list. A gadget list is linked together by the NextGadget field of the Gadget structure (see the description of the Gadget ~~structure later in this~~ ~~chapter~~).		To add or remove gadgets in a window or requester that is already open, use AddGList() or RemoveGList(). These functions operate on gadgets arranged in a list. A gadget list is linked together by the NextGadget field of the Gadget structure (see the description of the [[#Gadget Structure\|Gadget Structure]]).

	AddGList() adds a gadget list that you specify to the existing gadget list of a window or requester:		AddGList() adds a gadget list that you specify to the existing gadget list of a window or requester:
Line 201:		Line 201:
	This function removes up to numGad gadgets from a window or requester, beginning with the specified one. If one of the gadgets that is being removed is the active gadget, this routine will wait for the user to release the mouse button before deactivating and removing the gadget. This function returns the former position of the removed gadget or -1 if the specified gadget was not found.		This function removes up to numGad gadgets from a window or requester, beginning with the specified one. If one of the gadgets that is being removed is the active gadget, this routine will wait for the user to release the mouse button before deactivating and removing the gadget. This function returns the former position of the removed gadget or -1 if the specified gadget was not found.

	The Gadget structure should never be directly modified after it has been added to a window or requester. To modify a gadget, first remove it with RemoveGList(), modify the structure as needed, and then add the gadget back to the system with AddGList(). Finally, refresh the gadget imagery with RefreshGList(). (See ~~the~~ ~~section on "~~Gadget Refreshing~~" below~~ for more information.)		The Gadget structure should never be directly modified after it has been added to a window or requester. To modify a gadget, first remove it with RemoveGList(), modify the structure as needed, and then add the gadget back to the system with AddGList(). Finally, refresh the gadget imagery with RefreshGList(). (See [[#Gadget Refreshing\|Gadget Refreshing]] for more information.)

	Some attributes of a gadget may be modified through special Intuition functions that perform the modification. When using such functions it is not necessary to remove, add or refresh the gadget. These functions, such as NewModifyProp(), OnGadget() and OffGadget(), are described later in this chapter.		Some attributes of a gadget may be modified through special Intuition functions that perform the modification. When using such functions it is not necessary to remove, add or refresh the gadget. These functions, such as NewModifyProp(), OnGadget() and OffGadget(), are described later in this chapter.

Steven Solie: /* Application Gadgets */

2015-11-03T20:25:27Z

Application Gadgets

← Older revision		Revision as of 20:25, 3 November 2015
Line 42:		Line 42:
	Application gadgets imitate real life controls: they are the switches, knobs, handles and buttons of the Intuition environment. Gadgets can be created with almost any imaginable type of imagery and function. Visual imagery for gadgets can combine text with hand drawn imagery or lines of multiple colors.		Application gadgets imitate real life controls: they are the switches, knobs, handles and buttons of the Intuition environment. Gadgets can be created with almost any imaginable type of imagery and function. Visual imagery for gadgets can combine text with hand drawn imagery or lines of multiple colors.

	A gadget is created by declaring and initializing a Gadget structure as defined in <intuition/intuition.h>. See ~~the "~~Gadget Structure" ~~section~~ later in this article for more details.		A gadget is created by declaring and initializing a Gadget structure as defined in <intuition/intuition.h>. See [[#Gadget Structure\|Gadget Structure]] later in this article for more details.

	Gadgets always appear in a window or requester. All windows and requesters keep a list of the gadgets they contain. Gadgets can be added when the window or requester is opened, or they can be added or removed from the window or requester after it is open.		Gadgets always appear in a window or requester. All windows and requesters keep a list of the gadgets they contain. Gadgets can be added when the window or requester is opened, or they can be added or removed from the window or requester after it is open.

Steven Solie: /* Application Gadgets */

2015-11-03T20:21:44Z

Application Gadgets

← Older revision		Revision as of 20:21, 3 November 2015
Line 42:		Line 42:
	Application gadgets imitate real life controls: they are the switches, knobs, handles and buttons of the Intuition environment. Gadgets can be created with almost any imaginable type of imagery and function. Visual imagery for gadgets can combine text with hand drawn imagery or lines of multiple colors.		Application gadgets imitate real life controls: they are the switches, knobs, handles and buttons of the Intuition environment. Gadgets can be created with almost any imaginable type of imagery and function. Visual imagery for gadgets can combine text with hand drawn imagery or lines of multiple colors.

	A gadget is created by declaring and initializing a Gadget structure as defined in <intuition/intuition.h>. See the "Gadget Structure" section later in this ~~chapter~~ for more details.		A gadget is created by declaring and initializing a Gadget structure as defined in <intuition/intuition.h>. See the "Gadget Structure" section later in this article for more details.

	Gadgets always appear in a window or requester. All windows and requesters keep a list of the gadgets they contain. Gadgets can be added when the window or requester is opened, or they can be added or removed from the window or requester after it is open.		Gadgets always appear in a window or requester. All windows and requesters keep a list of the gadgets they contain. Gadgets can be added when the window or requester is opened, or they can be added or removed from the window or requester after it is open.

	As with other types of input events, Intuition notifies your application about gadget activity by sending a message to your window's I/O channels: the IDCMP (Window.UserPort) or the console device. The message is sent as an Intuition IntuiMessage structure. The Class field of this structure is set to IDCMP_GADGETDOWN or IDCMP_GADGETUP with the IAddress field set to the address of the Gadget that was activated. (See ~~the chapter on "~~Intuition Input and Output Methods" for details.)		As with other types of input events, Intuition notifies your application about gadget activity by sending a message to your window's I/O channels: the IDCMP (Window.UserPort) or the console device. The message is sent as an Intuition IntuiMessage structure. The Class field of this structure is set to IDCMP_GADGETDOWN or IDCMP_GADGETUP with the IAddress field set to the address of the Gadget that was activated. (See [[Intuition_Input_and_Output_Methods\|Intuition Input and Output Methods]] for details.)

	Application gadgets can go anywhere in windows or requesters, including in the borders, and can be any size or shape. When application gadgets are placed into the window's border at the time the window is opened, Intuition will adjust the border size accordingly. Application gadgets are not supported in screens (although this may be simulated by placing the gadget in a backdrop window).		Application gadgets can go anywhere in windows or requesters, including in the borders, and can be any size or shape. When application gadgets are placed into the window's border at the time the window is opened, Intuition will adjust the border size accordingly. Application gadgets are not supported in screens (although this may be simulated by placing the gadget in a backdrop window).

Steven Solie: /* System Gadgets */

2015-11-03T20:20:29Z

System Gadgets

← Older revision		Revision as of 20:20, 3 November 2015
Line 34:		Line 34:
	System gadgets are predefined gadgets provided by Intuition to support standard operations of windows and screens. System gadgets have a standard image and location in the borders of screens or windows. Intuition manages the operation of all system gadgets except the close gadget.		System gadgets are predefined gadgets provided by Intuition to support standard operations of windows and screens. System gadgets have a standard image and location in the borders of screens or windows. Intuition manages the operation of all system gadgets except the close gadget.

	The drag and depth gadgets are automatically attached to each screen in the system. The application cannot control the creation of these gadgets, but can control their display and operation. Screens may be opened "quiet" without any of the gadget imagery displayed. Applications should avoid covering the screen's gadgets with windows as this may prevent the user from freely positioning the screen. See ~~the "~~Intuition Screens~~" chapter~~ for more information on the positioning and use of system gadgets for screens.		The drag and depth gadgets are automatically attached to each screen in the system. The application cannot control the creation of these gadgets, but can control their display and operation. Screens may be opened "quiet" without any of the gadget imagery displayed. Applications should avoid covering the screen's gadgets with windows as this may prevent the user from freely positioning the screen. See [[Intuition_Screens\|Intuition Screens]] for more information on the positioning and use of system gadgets for screens.

	The drag, depth, close, sizing and zoom gadgets are available to be attached to each window. These gadgets are not provided automatically, the application must specify which gadgets it requires. See ~~the "~~Intuition Windows~~" chapter~~ for more information on the positioning and use of system gadgets for windows.		The drag, depth, close, sizing and zoom gadgets are available to be attached to each window. These gadgets are not provided automatically, the application must specify which gadgets it requires. See [[Intuition_Windows\|Intuition Windows]] for more information on the positioning and use of system gadgets for windows.

	=== Application Gadgets ===		=== Application Gadgets ===

Steven Solie at 20:04, 11 April 2014

2014-04-11T20:04:14Z

← Older revision		Revision as of 20:04, 11 April 2014
Line 1:		Line 1:
	{{CodeReview}}
	== Intuition Gadgets ==		== Intuition Gadgets ==

Steven Solie: /* Adding and Removing Gadgets */

2014-04-11T20:02:45Z

Adding and Removing Gadgets

← Older revision		Revision as of 20:02, 11 April 2014
Line 187:		Line 187:
	AddGList() adds a gadget list that you specify to the existing gadget list of a window or requester:		AddGList() adds a gadget list that you specify to the existing gadget list of a window or requester:

			<syntaxhighlight>
	<pre>
	UWORD AddGList( struct Window window, struct Gadget agadget,		UWORD AddGList( struct Window window, struct Gadget agadget,
	ULONG position, LONG numGad, struct Requester *requester );		ULONG position, LONG numGad, struct Requester *requester );
			</syntaxhighlight>
	</pre>

	Up to numGad gadgets will be added from the gadget list you specify beginning with a gadget. The position argument determines where your gadgets will be placed in the existing list of gadgets for the window or requester. Use (~0) to add your gadget list to the end of the window or ~~requester‚Äôs~~ gadget list. This function returns the actual position where your gadgets are added in the existing list.		Up to numGad gadgets will be added from the gadget list you specify beginning with a gadget. The position argument determines where your gadgets will be placed in the existing list of gadgets for the window or requester. Use (~0) to add your gadget list to the end of the window or requester's gadget list. This function returns the actual position where your gadgets are added in the existing list.

	To remove gadgets from a window or requester use RemoveGList():		To remove gadgets from a window or requester use RemoveGList():

			<syntaxhighlight>
	<pre>
	UWORD RemoveGList( struct Window remPtr, struct Gadget agadget, LONG numGad );		UWORD RemoveGList( struct Window remPtr, struct Gadget agadget, LONG numGad );
			</syntaxhighlight>
	</pre>

	This function removes up to numGad gadgets from a window or requester, beginning with the specified one. ~~Starting with V37, if~~ one of the gadgets that is being removed is the active gadget, this routine will wait for the user to release the mouse button before deactivating and removing the gadget. This function returns the former position of the removed gadget or -1 if the specified gadget was not found.		This function removes up to numGad gadgets from a window or requester, beginning with the specified one. If one of the gadgets that is being removed is the active gadget, this routine will wait for the user to release the mouse button before deactivating and removing the gadget. This function returns the former position of the removed gadget or -1 if the specified gadget was not found.

	The Gadget structure should never be directly modified after it has been added to a window or requester. To modify a gadget, first remove it with RemoveGList(), modify the structure as needed, and then add the gadget back to the system with AddGList(). Finally, refresh the gadget imagery with RefreshGList(). (See the section on "Gadget Refreshing" below for more information.)		The Gadget structure should never be directly modified after it has been added to a window or requester. To modify a gadget, first remove it with RemoveGList(), modify the structure as needed, and then add the gadget back to the system with AddGList(). Finally, refresh the gadget imagery with RefreshGList(). (See the section on "Gadget Refreshing" below for more information.)