Intuition Requesters - Revision history

Costel Mincea: Text replacement - "" to ""

2025-01-26T19:28:23Z

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

← Older revision		Revision as of 19:28, 26 January 2025
Line 33:		Line 33:
	To create a requester, the application first allocates memory for or declares an instance of the Requester structure as defined in <intuition/intuition.h>. Once the Requester structure is set up, it is initialized with the InitRequester() function.		To create a requester, the application first allocates memory for or declares an instance of the Requester structure as defined in <intuition/intuition.h>. Once the Requester structure is set up, it is initialized with the InitRequester() function.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	VOID InitRequester( struct Requester *requester);		VOID InitRequester( struct Requester *requester);
	</syntaxhighlight>		</syntaxhighlight>
Line 41:		Line 41:
	A true (modal) requester is attached to its parent window and displayed with the Request() function.		A true (modal) requester is attached to its parent window and displayed with the Request() function.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	BOOL Request(struct Requester requester, struct Window window);		BOOL Request(struct Requester requester, struct Window window);
	</syntaxhighlight>		</syntaxhighlight>
Line 49:		Line 49:
	To remove a requester from its parent window and update the display, use EndRequest().		To remove a requester from its parent window and update the display, use EndRequest().

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	VOID EndRequest( struct Requester requester, struct Window window );		VOID EndRequest( struct Requester requester, struct Window window );
	</syntaxhighlight>		</syntaxhighlight>
Line 146:		Line 146:
	To use a window as a requester, first bring up a zero-sized requester attached to the main window (this provides the blocking feature). Then, bring up your second window, or bring up a busy pointer. The following example illustrates bringing up a busy pointer.		To use a window as a requester, first bring up a zero-sized requester attached to the main window (this provides the blocking feature). Then, bring up your second window, or bring up a busy pointer. The following example illustrates bringing up a busy pointer.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	/*		/*
	** blockinput.c -- program to demonstrate how to block the input from a		** blockinput.c -- program to demonstrate how to block the input from a
Line 379:		Line 379:
	The specification for a Requester structure, defined in the <intuition/intuition.h> file, is as follows.		The specification for a Requester structure, defined in the <intuition/intuition.h> file, is as follows.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct Requester		struct Requester
	{		{
Line 535:		Line 535:
	The text and setup of an easy requester is specified in an EasyStruct structure, defined in <intuition/intuition.h>.		The text and setup of an easy requester is specified in an EasyStruct structure, defined in <intuition/intuition.h>.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct EasyStruct		struct EasyStruct
	{		{
Line 573:		Line 573:
	==== Example Using EasyRequest() ====		==== Example Using EasyRequest() ====

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	/*		/*
	** easyrequest.c - show the use of an easy requester.		** easyrequest.c - show the use of an easy requester.
Line 656:		Line 656:
	The BuildEasyRequest() functions take the same arguments as EasyRequest():		The BuildEasyRequest() functions take the same arguments as EasyRequest():

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct Window BuildEasyRequestArgs( struct Window window,		struct Window BuildEasyRequestArgs( struct Window window,
	struct EasyStruct *easyStruct,		struct EasyStruct *easyStruct,
Line 668:		Line 668:
	To process input event information directly while an easy requester is displayed, first call BuildEasyRequest() then call SysReqHandler() periodically to process user input.		To process input event information directly while an easy requester is displayed, first call BuildEasyRequest() then call SysReqHandler() periodically to process user input.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	LONG SysReqHandler( struct Window window, ULONG idcmpPtr, LONG waitInput );		LONG SysReqHandler( struct Window window, ULONG idcmpPtr, LONG waitInput );
	</syntaxhighlight>		</syntaxhighlight>
Line 676:		Line 676:
	The FreeSysRequest() function must be called after an application has finished with a requester (if it was created with BuildEasyRequest() call).		The FreeSysRequest() function must be called after an application has finished with a requester (if it was created with BuildEasyRequest() call).

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	VOID FreeSysRequest( struct Window *window );		VOID FreeSysRequest( struct Window *window );
	</syntaxhighlight>		</syntaxhighlight>

Steven Solie: /* Types Of Requesters */

2015-11-03T20:32:08Z

Types Of Requesters

← Older revision		Revision as of 20:32, 3 November 2015
Line 9:		Line 9:
	True requesters are general purpose display areas that can be thought of as temporary sub-windows. They display information to the user and allow the user to make a selection. True requesters always open within an existing window and are constrained to the boundaries of that window (often referred to as the ''parent'' window). If a requester extends beyond the edge of its parent window, either its position is adjusted or its graphics are clipped. True requesters always block input to their parent window as long as they are present.		True requesters are general purpose display areas that can be thought of as temporary sub-windows. They display information to the user and allow the user to make a selection. True requesters always open within an existing window and are constrained to the boundaries of that window (often referred to as the ''parent'' window). If a requester extends beyond the edge of its parent window, either its position is adjusted or its graphics are clipped. True requesters always block input to their parent window as long as they are present.

	System requesters are typically used for warnings or to confirm an action the user has just initiated. System requesters differ from true requesters in that they cannot block input to the parent window. In fact, system requesters do not open in a parent window at all, but instead open their own separate window in the screen. Since these requesters are so different from true requesters, they will be discussed separately later in the article. See the sections on [[#Easy Requesters\|Easy Requesters]] and [[#System ~~Requests~~\|System Requesters]] for more information.		System requesters are typically used for warnings or to confirm an action the user has just initiated. System requesters differ from true requesters in that they cannot block input to the parent window. In fact, system requesters do not open in a parent window at all, but instead open their own separate window in the screen. Since these requesters are so different from true requesters, they will be discussed separately later in the article. See the sections on [[#Easy Requesters\|Easy Requesters]] and [[#System Requesters\|System Requesters]] for more information.

	The third type of requester, the ASL requester, is a special purpose requester. ASL requesters provide an easy, standard way to get a filename from the user for load and save operations. They can also be used to get a font selection or screen mode selection from the user. For the details about ASL file and font requesters, see [[ASL_Library\|ASL Library]].		The third type of requester, the ASL requester, is a special purpose requester. ASL requesters provide an easy, standard way to get a filename from the user for load and save operations. They can also be used to get a font selection or screen mode selection from the user. For the details about ASL file and font requesters, see [[ASL_Library\|ASL Library]].

Steven Solie: /* Types Of Requesters */

2015-11-03T20:31:31Z

Types Of Requesters

← Older revision		Revision as of 20:31, 3 November 2015
Line 9:		Line 9:
	True requesters are general purpose display areas that can be thought of as temporary sub-windows. They display information to the user and allow the user to make a selection. True requesters always open within an existing window and are constrained to the boundaries of that window (often referred to as the ''parent'' window). If a requester extends beyond the edge of its parent window, either its position is adjusted or its graphics are clipped. True requesters always block input to their parent window as long as they are present.		True requesters are general purpose display areas that can be thought of as temporary sub-windows. They display information to the user and allow the user to make a selection. True requesters always open within an existing window and are constrained to the boundaries of that window (often referred to as the ''parent'' window). If a requester extends beyond the edge of its parent window, either its position is adjusted or its graphics are clipped. True requesters always block input to their parent window as long as they are present.

	System requesters are typically used for warnings or to confirm an action the user has just initiated. System requesters differ from true requesters in that they cannot block input to the parent window. In fact, system requesters do not open in a parent window at all, but instead open their own separate window in the screen. Since these requesters are so different from true requesters, they will be discussed separately later in the ~~chapter~~. See the sections on "Easy Requesters" and "System Requests" for more information.		System requesters are typically used for warnings or to confirm an action the user has just initiated. System requesters differ from true requesters in that they cannot block input to the parent window. In fact, system requesters do not open in a parent window at all, but instead open their own separate window in the screen. Since these requesters are so different from true requesters, they will be discussed separately later in the article. See the sections on [[#Easy Requesters\|Easy Requesters]] and [[#System Requests\|System Requesters]] for more information.

	The third type of requester, the ASL requester, is a special purpose requester. ASL requesters provide an easy, standard way to get a filename from the user for load and save operations. They can also be used to get a font selection or screen mode selection from the user. For the details about ASL file and font requesters, see [[ASL_Library\|ASL Library]].		The third type of requester, the ASL requester, is a special purpose requester. ASL requesters provide an easy, standard way to get a filename from the user for load and save operations. They can also be used to get a font selection or screen mode selection from the user. For the details about ASL file and font requesters, see [[ASL_Library\|ASL Library]].

Steven Solie: /* Intuition Requesters */

2015-11-03T20:30:31Z

Intuition Requesters

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

	This ~~chapter~~ explains how to create requesters, the information exchange boxes that both the system and applications can use for confirming actions, getting command options and similar operations. These boxes are called requesters because they generally request information from the user.		This article explains how to create requesters, the information exchange boxes that both the system and applications can use for confirming actions, getting command options and similar operations. These boxes are called requesters because they generally request information from the user.

	== Types Of Requesters ==		== Types Of Requesters ==

Steven Solie at 20:24, 25 April 2014

2014-04-25T20:24:04Z

← Older revision		Revision as of 20:24, 25 April 2014
Line 1:		Line 1:
	{{WIP}}
	== Intuition Requesters ==		== Intuition Requesters ==

Steven Solie: /* Low Level Access to Easy Requesters */

2014-04-25T20:23:33Z

Low Level Access to Easy Requesters

← Older revision		Revision as of 20:23, 25 April 2014
Line 657:		Line 657:
	The BuildEasyRequest() functions take the same arguments as EasyRequest():		The BuildEasyRequest() functions take the same arguments as EasyRequest():

			<syntaxhighlight>
	<pre>
	struct Window BuildEasyRequestArgs( struct Window window,		struct Window BuildEasyRequestArgs( struct Window window,
	struct EasyStruct *easyStruct,		struct EasyStruct *easyStruct,
Line 665:		Line 665:
	struct EasyStruct *easyStruct,		struct EasyStruct *easyStruct,
	ULONG idcmp, APTR arg1, ... );		ULONG idcmp, APTR arg1, ... );
			</syntaxhighlight>
	</pre>

	To process input event information directly while an easy requester is displayed, first call BuildEasyRequest() then call SysReqHandler() periodically to process user input.		To process input event information directly while an easy requester is displayed, first call BuildEasyRequest() then call SysReqHandler() periodically to process user input.

			<syntaxhighlight>
	<pre>
	LONG SysReqHandler( struct Window window, ULONG idcmpPtr, LONG waitInput );		LONG SysReqHandler( struct Window window, ULONG idcmpPtr, LONG waitInput );
			</syntaxhighlight>
	</pre>

	This will provide standard handling of events but allow the application to control the timing of checking the events. This handling includes checks for left Amiga keys.		This will provide standard handling of events but allow the application to control the timing of checking the events. This handling includes checks for left Amiga keys.
Line 677:		Line 677:
	The FreeSysRequest() function must be called after an application has finished with a requester (if it was created with BuildEasyRequest() call).		The FreeSysRequest() function must be called after an application has finished with a requester (if it was created with BuildEasyRequest() call).

			<syntaxhighlight>
	<pre>
	VOID FreeSysRequest( struct Window *window );		VOID FreeSysRequest( struct Window *window );
			</syntaxhighlight>
	</pre>

	This function ends the requester and frees any resources allocated with the BuildEasyRequest() call.		This function ends the requester and frees any resources allocated with the BuildEasyRequest() call.

Steven Solie: /* A Requester Example */

2014-04-25T20:20:57Z

A Requester Example

Show changes

Steven Solie: /* Creating Application Requesters */

2014-04-25T20:03:55Z

Creating Application Requesters

← Older revision		Revision as of 20:03, 25 April 2014
Line 34:		Line 34:
	To create a requester, the application first allocates memory for or declares an instance of the Requester structure as defined in <intuition/intuition.h>. Once the Requester structure is set up, it is initialized with the InitRequester() function.		To create a requester, the application first allocates memory for or declares an instance of the Requester structure as defined in <intuition/intuition.h>. Once the Requester structure is set up, it is initialized with the InitRequester() function.

			<syntaxhighlight>
	<pre>
	VOID InitRequester( struct Requester *requester);		VOID InitRequester( struct Requester *requester);
			</syntaxhighlight>
	</pre>

	This function simply clears the Requester structure. The application should do further initialization depending on its needs. See the section on the "Requester Structure" below for an explanation of all the Requester fields and how to set them.		This function simply clears the Requester structure. The application should do further initialization depending on its needs. See the section on the "Requester Structure" below for an explanation of all the Requester fields and how to set them.
Line 42:		Line 42:
	A true (modal) requester is attached to its parent window and displayed with the Request() function.		A true (modal) requester is attached to its parent window and displayed with the Request() function.

			<syntaxhighlight>
	<pre>
	BOOL Request(struct Requester requester, struct Window window);		BOOL Request(struct Requester requester, struct Window window);
			</syntaxhighlight>
	</pre>

	This function returns TRUE if the requester opens successfully or FALSE if the requester cannot be opened. If the requester opens successfully, menu and gadget input in the parent window is blocked as long as the requester is displayed. The application should process input events from the requester, which are sent to the parent window's Window.UserPort, until the requester is satisfied.		This function returns TRUE if the requester opens successfully or FALSE if the requester cannot be opened. If the requester opens successfully, menu and gadget input in the parent window is blocked as long as the requester is displayed. The application should process input events from the requester, which are sent to the parent window's Window.UserPort, until the requester is satisfied.
Line 50:		Line 50:
	To remove a requester from its parent window and update the display, use EndRequest().		To remove a requester from its parent window and update the display, use EndRequest().

			<syntaxhighlight>
	<pre>
	VOID EndRequest( struct Requester requester, struct Window window );		VOID EndRequest( struct Requester requester, struct Window window );
			</syntaxhighlight>
	</pre>

	This removes only the one requester specified. It is possible to set up a requester with a special gadget that, if selected, will automatically close the requester. In that case, EndRequest() need not be called. If the program needs to cancel the request early, or cancel it only after some specific manipulation of the gadgets, EndRequest() should be used.		This removes only the one requester specified. It is possible to set up a requester with a special gadget that, if selected, will automatically close the requester. In that case, EndRequest() need not be called. If the program needs to cancel the request early, or cancel it only after some specific manipulation of the gadgets, EndRequest() should be used.

Steven Solie: /* Example Using EasyRequest() */

2014-04-25T15:28:48Z

Example Using EasyRequest()

← Older revision		Revision as of 15:28, 25 April 2014
Line 583:		Line 583:
	==== Example Using EasyRequest() ====		==== Example Using EasyRequest() ====

			<syntaxhighlight>
	<pre>
			/*
	;/* easyrequest.c - Execute me to compile me with SAS C 5.10
	LC -b1 -cfistq -v -y -j73 easyrequest.c
	Blink FROM LIB:c.o,easyrequest.o TO easyrequest LIBRARY LIB:LC.lib,LIB:Amiga.lib
	quit

	** easyrequest.c - show the use of an easy requester.		** easyrequest.c - show the use of an easy requester.
	*/		*/
		⚫	#include <exec/types.h>
	#define INTUI_V36_NAMES_ONLY
		⚫	#include <intuition/intuition.h>

⚫	#include ~~<~~exec/types.h~~>~~
⚫	#include ~~<~~intuition/intuition.h~~>~~

	#include <clib/exec_protos.h>
	#include <clib/intuition_protos.h>

	#include ~~<stdio~~.h~~>~~		#include <proto/exec.h>
			#include <proto/dos.h>
			#include <proto/intuition.h>

	#ifdef LATTICE
	int CXBRK(void) { return(0); } /* Disable Lattice CTRL/C handling */
	int chkabort(void) { return(0); } /* really */
	#endif

	/* declare the easy request structure.		/* declare the easy request structure.
Line 617:		Line 606:
	sizeof(struct EasyStruct),		sizeof(struct EasyStruct),
	0,		0,
	~~"~~Request Window Name~~"~~,		"Request Window Name",
	~~"~~Text for the request\nSecond line of %s text\nThird line of text for the request~~"~~,		"Text for the request\nSecond line of %s text\nThird line of text for the request",
	~~"~~Yes\|%ld\|No~~"~~,		"Yes\|%ld\|No",
	};		};

	struct ~~Library~~ *~~IntuitionBase~~;		struct IntuitionIFace *IIntuition;

	/*		/*
	** Main routine to show the use of EasyRequest()		** Main routine to show the use of EasyRequest()
	*/		*/
	~~VOID~~ main (~~int argc, char **argv~~)		int main ()
	{		{
		⚫	struct Library *IntuitionBase = IExec->OpenLibrary("intuition.library", 50);
	LONG answer;
			IIntuition = (struct IntuitionIFace*) IExec->GetInterface(IntuitionBase, "main", 1, NULL);
	LONG number;

			if (IIntuitionBase != NULL)
⚫	number = 3125794; /* for use in the middle button */
		⚫	{
		⚫	int32 number = 3125794; /* for use in the middle button */

⚫	if (IntuitionBase = OpenLibrary(~~"~~intuition.library~~"~~,~~37)~~)
⚫	{
	/* note in the variable substitution:		/* note in the variable substitution:
	** the string goes in the first open variable (in body text).		** the string goes in the first open variable (in body text).
	** the number goes in the second open (gadget text).		** the number goes in the second open (gadget text).
	*/		*/
	answer = EasyRequest(NULL, &~~amp;~~myES, NULL, ~~"~~(Variable)~~"~~, number);		int32 answer = IIntuition->EasyRequest(NULL, &myES, NULL, "(Variable)", number);

	/* Process the answer. Note that the buttons are numbered in		/* Process the answer. Note that the buttons are numbered in
Line 653:		Line 642:
	{		{
	case 1:		case 1:
	~~printf~~(~~"~~selected 'Yes'\n~~"~~);		IDOS->Printf("selected 'Yes'\n");
	break;		break;
	case 2:		case 2:
	~~printf~~(~~"~~selected '%ld'\n~~"~~, number);		IDOS->Printf("selected '%ld'\n", number);
	break;		break;
	case 0:		case 0:
	~~printf~~(~~"~~selected 'No'\n~~"~~);		IDOS->Printf("selected 'No'\n");
	break;		break;
	}		}
		⚫	}

			IExec->DropInterface((struct Interface*)IIntuition);
		⚫	IExec->CloseLibrary(IntuitionBase);

			return 0;
⚫	CloseLibrary(IntuitionBase);
⚫	}
	}		}
			</syntaxhighlight>
	</pre>

	=== Low Level Access to Easy Requesters ===		=== Low Level Access to Easy Requesters ===

Steven Solie: /* Function Reference */

2014-04-08T20:58:28Z

Function Reference

← Older revision		Revision as of 20:58, 8 April 2014
Line 716:		Line 716:
	=== Function Reference ===		=== Function Reference ===

	The following are brief descriptions of the Intuition functions that relate to the use of Intuition requesters ~~and alerts~~. See the SDK for details on each function call.		The following are brief descriptions of the Intuition functions that relate to the use of Intuition requesters. See the SDK for details on each function call.

	{\| class="wikitable"		{\| class="wikitable"