Intuition Windows - Revision history

Steven Solie: /* The Active Window */

2015-11-03T20:41:48Z

The Active Window

← Older revision		Revision as of 20:41, 3 November 2015
Line 33:		Line 33:
	There is only one window in the system active at any time. The active window receives all user input, including keyboard and mouse events. This is also known as the ''input focus'', as all input is focused at this single point.		There is only one window in the system active at any time. The active window receives all user input, including keyboard and mouse events. This is also known as the ''input focus'', as all input is focused at this single point.

	Some areas of the active window are displayed more boldly than those on inactive windows. The active window's borders are filled in with a color which is designed to stand out from the background while inactive windows have their borders filled with the background color. The specific coloring of active and inactive windows is dependent on the screen on which the window is opened. See the section "DrawInfo and the 3D Look~~" in the "Intuition Screens" chapter~~ for more information.		Some areas of the active window are displayed more boldly than those on inactive windows. The active window's borders are filled in with a color which is designed to stand out from the background while inactive windows have their borders filled with the background color. The specific coloring of active and inactive windows is dependent on the screen on which the window is opened. See the section [[Intuition_Screens#DrawInfo_and_the_3D_Look\|DrawInfo and the 3D Look]] for more information.

	Windows have two optional titles: one for the window and one for the screen. The window title appears in the top border of the window, regardless of whether the window is active or inactive. The window's screen title appears in the screen's title bar only when the window is active. This gives the user a secondary clue as to what application is active in the screen.		Windows have two optional titles: one for the window and one for the screen. The window title appears in the top border of the window, regardless of whether the window is active or inactive. The window's screen title appears in the screen's title bar only when the window is active. This gives the user a secondary clue as to what application is active in the screen.

Steven Solie: /* Intuition Windows */

2015-11-03T20:40:18Z

Intuition Windows

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

	This ~~chapter~~ provides a general description of windows: how to open windows and define their characteristics; how to get the system gadgets for shaping, moving, closing, and depth arranging windows; how to handle window I/O; and how to preserve the display when windows get overlapped.		This article provides a general description of windows: how to open windows and define their characteristics; how to get the system gadgets for shaping, moving, closing, and depth arranging windows; how to handle window I/O; and how to preserve the display when windows get overlapped.

	== About Windows ==		== About Windows ==

Steven Solie at 22:14, 30 October 2015

2015-10-30T22:14:04Z

← Older revision		Revision as of 22:14, 30 October 2015
Line 1:		Line 1:
	{{WIP}}
	== Intuition Windows ==		== Intuition Windows ==

Steven Solie: /* Window Types */

2014-04-11T19:28:29Z

Window Types

← Older revision		Revision as of 19:28, 11 April 2014
Line 42:		Line 42:
	Each window may also have its own mouse-pointer image. Changing the active window will change the pointer to the one currently set for the new active window.		Each window may also have its own mouse-pointer image. Changing the active window will change the pointer to the one currently set for the new active window.

	=== ~~Window~~ ~~Types~~ ===		=== More Details ===

			The following sections describe Windows in more detail:
	There are several types of windows which are described in [[Window Types]].

			* [[Window Types]] - Describes all the types of Windows available.
			* [[Window Structures and Functions\|Structures and Functions]] - Detailed description of structures and functions.
			* [[Window Communication\|Communicating with Intuition]] - How to communicate with a Window.
			* [[Window Display Preservation\|Display Preservation]] - How to preserve the display of a Window.

	== Function Reference ==		== Function Reference ==

Steven Solie: /* Other Window Functions */

2014-04-11T19:24:21Z

Other Window Functions

← Older revision		Revision as of 19:24, 11 April 2014
Line 45:		Line 45:

	There are several types of windows which are described in [[Window Types]].		There are several types of windows which are described in [[Window Types]].

	== Other Window Functions ==

	This section contains a brief overview of other Intuition functions that affect windows. For a complete description of all Intuition functions, see the SDK.

	== Function Reference ==		== Function Reference ==

Steven Solie: /* Menus and the Active Window */

2014-04-11T19:23:50Z

Menus and the Active Window

← Older revision		Revision as of 19:23, 11 April 2014
Line 49:		Line 49:

	This section contains a brief overview of other Intuition functions that affect windows. For a complete description of all Intuition functions, see the SDK.		This section contains a brief overview of other Intuition functions that affect windows. For a complete description of all Intuition functions, see the SDK.

	=== Menus and the Active Window ===

	Menus for the active window will be displayed when the user presses the menu button on the mouse. Menus may be disabled for the window by not providing a menu strip, or by clearing the menus with ClearMenuStrip(). Similarly, if the active window has WFLG_RMBTRAP set, the menu button will not bring up the menus.

	Two other functions, SetMenuStrip() and ResetMenuStrip(), are used to attach or update the menu strip for a window.

	<pre>
	VOID ClearMenuStrip( struct Window *window );
	BOOL SetMenuStrip( struct Window window, struct Menu menu );
	BOOL ResetMenuStrip( struct Window window, struct Menu menu );
	</pre>

	If SetMenuStrip() has been called for a window, ClearMenuStrip() must be called before closing the window. After ClearMenuStrip() has been called, the user can no longer access menus for this window. See [[Intuition_Menus\|Intuition Menus]], for complete information about setting up menus.

	== Function Reference ==		== Function Reference ==

Steven Solie: /* Requesters in the Window */

2014-04-11T19:19:27Z

Requesters in the Window

← Older revision		Revision as of 19:19, 11 April 2014
Line 63:		Line 63:

	If SetMenuStrip() has been called for a window, ClearMenuStrip() must be called before closing the window. After ClearMenuStrip() has been called, the user can no longer access menus for this window. See [[Intuition_Menus\|Intuition Menus]], for complete information about setting up menus.		If SetMenuStrip() has been called for a window, ClearMenuStrip() must be called before closing the window. After ClearMenuStrip() has been called, the user can no longer access menus for this window. See [[Intuition_Menus\|Intuition Menus]], for complete information about setting up menus.

	=== Requesters in the Window ===

	Requesters are temporary sub-windows, usually containing several gadgets, used to confirm actions, access files, or adjust the options of a command the user has just given. Request() creates and activates a requester in the window. EndRequest() removes the requester from the window.

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

	For simple requesters in a format that matches system requesters, two new functions have been added to Release 2:

	<syntaxhighlight>
	LONG EasyRequestArgs( struct Window window, struct EasyStruct easyStruct,
	ULONG *idcmpPtr, APTR args );
	LONG EasyRequest( struct Window window, struct EasyStruct easyStruct,
	ULONG *idcmpPtr, APTR arg1, ... );
	</syntaxhighlight>

	The EasyRequest() functions support requesters with one or more gadgets automatically providing a layout that is sensitive to the current font and screen resolution. See [[Intuition_Requesters\|Intuition Requesters]] for more information on using requester functions.

	== Function Reference ==		== Function Reference ==

Steven Solie: /* Program Control of Window Arrangement */

2014-04-11T19:17:14Z

Program Control of Window Arrangement

← Older revision		Revision as of 19:17, 11 April 2014
Line 83:		Line 83:

	The EasyRequest() functions support requesters with one or more gadgets automatically providing a layout that is sensitive to the current font and screen resolution. See [[Intuition_Requesters\|Intuition Requesters]] for more information on using requester functions.		The EasyRequest() functions support requesters with one or more gadgets automatically providing a layout that is sensitive to the current font and screen resolution. See [[Intuition_Requesters\|Intuition Requesters]] for more information on using requester functions.

	=== Program Control of Window Arrangement ===

	MoveWindow(), SizeWindow(), WindowToFront() and WindowToBack() allow the program to modify the size and placement of its windows. These calls are available in all versions of the operating system.

	MoveWindowInFrontOf(), ChangeWindowBox() and ZipWindow() provide more flexible control over the size and placement of windows.

	All of these functions are asynchronous. The window will not be affected by them immediately, rather, Intuition will act on the request the next time it receives an input event. Currently this happens at a minimum rate of ten times per second, and a maximum of sixty times per second. There is no guarantee that the operation has taken place when the function returns. In some cases, there are IDCMP messages which will inform the application when the change has completed (for example, an IDCMP_NEWSIZE event indicates that a resize operation has completed).

	Use the MoveWindow() function to move a window to a new position in the screen. Use SizeWindow() to change the size of the window:

	<syntaxhighlight>
	VOID MoveWindow( struct Window *window, LONG dx, LONG dy );
	VOID SizeWindow( struct Window *window, LONG dx, LONG dy );
	</syntaxhighlight>

	Note that both MoveWindow() and SizeWIndow() take the amount of change in each axis (delta values instead of absolute coordinates). To specify the coordinates as absolute numbers, use ChangeWindowBox(). The SizeWindow() function will respect the window's maximum and minimum dimensions only if the window has a sizing gadget.

	ChangeWindowBox() allows an application to change the window size and position in a single call:

	<syntaxhighlight>
	VOID ChangeWindowBox( struct Window *window, LONG left, LONG top, LONG width, LONG height );
	</syntaxhighlight>

	Note that the position and size values are absolutes and not deltas. The window's maximum and minimum dimensions are always respected.

	To depth arrange windows under program control, use WindowToFront() and WindowToBack():

	<syntaxhighlight>
	VOID WindowToFront( struct Window *window );
	VOID WindowToBack( struct Window *window );
	</syntaxhighlight>

	WindowToFront() depth arranges a given window in front of all other windows on its screen. WindowToBack() depth arranges a given window behind all other windows on its screen.

	To move a window in front of a specific, given window (as opposed to all windows), use MoveWindowInFrontOf():

	<syntaxhighlight>
	VOID MoveWindowInFrontOf( struct Window window, struct Window behindWindow );
	</syntaxhighlight>

	To toggle the window size between its two zoom settings use ZipWindow(). This performs the same action that occurs when the user selects the zoom gadget:

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

	The two zoom settings are the initial size and position of the window when it was first opened and the alternate position specified with the WA_Zoom tag. If no WA_Zoom tag is provided, the alternate position is taken from the window's minimum dimensions, unless the window was opened at its minimum dimension. In that case, the alternate position is taken from the window's maximum dimension.

	== Function Reference ==		== Function Reference ==

Steven Solie: /* Custom Pointers */

2014-04-11T19:15:55Z

Custom Pointers

← Older revision		Revision as of 19:15, 11 April 2014
Line 131:		Line 131:

	The two zoom settings are the initial size and position of the window when it was first opened and the alternate position specified with the WA_Zoom tag. If no WA_Zoom tag is provided, the alternate position is taken from the window's minimum dimensions, unless the window was opened at its minimum dimension. In that case, the alternate position is taken from the window's maximum dimension.		The two zoom settings are the initial size and position of the window when it was first opened and the alternate position specified with the WA_Zoom tag. If no WA_Zoom tag is provided, the alternate position is taken from the window's minimum dimensions, unless the window was opened at its minimum dimension. In that case, the alternate position is taken from the window's maximum dimension.

	=== Custom Pointers ===

	The active window also has control over the pointer. If the active window changes the image for the pointer using the functions SetPointer() or ClearPointer(), the pointer image will change:

	<syntaxhighlight>
	VOID SetPointer( struct Window window, UWORD pointer, LONG height,
	LONG width, LONG xOffset, LONG yOffset );

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

	SetPointer() sets up the window with a sprite definition for a custom pointer. If the window is active, the change takes place immediately. The pointer will not change if an inactive window calls SetPointer(). In this way, each window may have its own custom pointer that is displayed only when the window is active.

	ClearPointer() clears the custom pointer from the window and restores it to the default Intuition pointer, which is set by the user. Setting a pointer for a window is discussed further in [[Intuition_Pointer\|Intuition Pointer]].

	== Function Reference ==		== Function Reference ==

Steven Solie: /* Changing Pointer Position Reports */

2014-04-11T19:14:55Z

Changing Pointer Position Reports

← Older revision		Revision as of 19:14, 11 April 2014
Line 131:		Line 131:

	The two zoom settings are the initial size and position of the window when it was first opened and the alternate position specified with the WA_Zoom tag. If no WA_Zoom tag is provided, the alternate position is taken from the window's minimum dimensions, unless the window was opened at its minimum dimension. In that case, the alternate position is taken from the window's maximum dimension.		The two zoom settings are the initial size and position of the window when it was first opened and the alternate position specified with the WA_Zoom tag. If no WA_Zoom tag is provided, the alternate position is taken from the window's minimum dimensions, unless the window was opened at its minimum dimension. In that case, the alternate position is taken from the window's maximum dimension.

	=== Changing Pointer Position Reports ===

	Pointer position messages to a window may be turned on and off by simply setting or clearing the WFLG_REPORTMOUSE flag bit in Window->Flags, in an atomic way, as explained for the WA_RMBTrap tag in the "Window Attributes" section above. Using this direct method of setting the flag avoids the historic confusion on the ordering of the arguments of the ReportMouse() function call.

	Mouse reporting may be turned on even if mouse movements were not activated when the window was opened. The proper IDCMP flags must be set for the window to receive the messages. See [[Intuition_Mouse\|Intuition Mouse]] for more details on enabling mouse reporting in an application.

	=== Custom Pointers ===		=== Custom Pointers ===