Preferences - Revision history

Costel Mincea: Text replacement - "" to ""

2025-01-26T19:36:36Z

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

← Older revision		Revision as of 19:36, 26 January 2025
Line 75:		Line 75:
	Here's a short example showing how to set up notification on the "serial.prefs" file in "ENV:sys". The program displays a message in a window whenever this file is changed (e.g., when the user selects the "Use" or "Save" gadget in the Serial Preferences editor).		Here's a short example showing how to set up notification on the "serial.prefs" file in "ENV:sys". The program displays a message in a window whenever this file is changed (e.g., when the user selects the "Use" or "Save" gadget in the Serial Preferences editor).

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	/*		/*
	** prefnotify.c - notified if serial prefs change		** prefnotify.c - notified if serial prefs change
Line 153:		Line 153:
	The PRHD header chunk, contains a PrefHeader structure:		The PRHD header chunk, contains a PrefHeader structure:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct PrefHeader		struct PrefHeader
	{		{
Line 202:		Line 202:
	=== FONT ===		=== FONT ===

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct FontPrefs		struct FontPrefs
	{		{
Line 216:		Line 216:
	=== ICTL ===		=== ICTL ===

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct IControlPrefs		struct IControlPrefs
	{		{
Line 248:		Line 248:
	=== INPT ===		=== INPT ===

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct InputPrefs		struct InputPrefs
	{		{
Line 262:		Line 262:
	=== OSCN ===		=== OSCN ===

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct OverscanPrefs		struct OverscanPrefs
	{		{
Line 275:		Line 275:
	=== PGFX ===		=== PGFX ===

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct PrinterGfxPrefs		struct PrinterGfxPrefs
	{		{
Line 299:		Line 299:
	=== PTXT ===		=== PTXT ===

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct PrinterTxtPrefs		struct PrinterTxtPrefs
	{		{
Line 320:		Line 320:
	=== SCRM ===		=== SCRM ===

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct ScreenModePrefs		struct ScreenModePrefs
	{		{
Line 334:		Line 334:
	=== SERL ===		=== SERL ===

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct SerialPrefs		struct SerialPrefs
	{		{
Line 360:		Line 360:
	The following example shows a way to read a Preferences file.		The following example shows a way to read a Preferences file.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	/*		/*
	** showprefs.c - parse and show some info from an IFF Preferences file		** showprefs.c - parse and show some info from an IFF Preferences file
Line 561:		Line 561:
	In 1.3, the Preferences program allows the user to see and change many system wide parameters, like the Workbench colors, pointer image, printer settings etc. When a Preferences item is changed, the new setting can be used temporarily (until a reset occurs) or stored permanently in the "DEVS:system-configuration" file. Under 1.3, all Preferences items are stored in this file which the system reads at boot time to find out how to set various system-wide options.		In 1.3, the Preferences program allows the user to see and change many system wide parameters, like the Workbench colors, pointer image, printer settings etc. When a Preferences item is changed, the new setting can be used temporarily (until a reset occurs) or stored permanently in the "DEVS:system-configuration" file. Under 1.3, all Preferences items are stored in this file which the system reads at boot time to find out how to set various system-wide options.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct Preferences GetPrefs(struct Preferences preferences, LONG size);		struct Preferences GetPrefs(struct Preferences preferences, LONG size);
	struct Preferences GetDefPrefs(struct Preferences preferences, LONG size);		struct Preferences GetDefPrefs(struct Preferences preferences, LONG size);

Steven Solie: /* Preferences */

2015-11-09T19:25:26Z

Preferences

← Older revision		Revision as of 19:25, 9 November 2015
Line 2:		Line 2:
	== Preferences ==		== Preferences ==

	To make the Amiga operating system easily configurable by the user, the OS comes with a family of editors and associated data files known collectively as Preferences. Preferences allows the user to set system-wide configuration options such as the printer driver to use, serial port baud rate and other items. To make an application appealing to the user, the system-wide Preferences settings should be respected as much as possible by applications. This ~~chapter~~ describes how to use the Preferences system in your programs.		To make the Amiga operating system easily configurable by the user, the OS comes with a family of editors and associated data files known collectively as Preferences. Preferences allows the user to set system-wide configuration options such as the printer driver to use, serial port baud rate and other items. To make an application appealing to the user, the system-wide Preferences settings should be respected as much as possible by applications. This article describes how to use the Preferences system in your programs.

	== Preferences Editors and Storage ==		== Preferences Editors and Storage ==

Steven Solie: /* FONT */

2013-05-23T19:39:29Z

FONT

← Older revision		Revision as of 19:39, 23 May 2013
Line 202:		Line 202:
	=== FONT ===		=== FONT ===

			<syntaxhighlight>

		⚫	struct FontPrefs

⚫	~~<pre>~~struct FontPrefs
	{		{
	LONG fp_Reserved[4];		LONG fp_Reserved[4];
Line 212:		Line 211:
	struct TextAttr fp_TextAttr;		struct TextAttr fp_TextAttr;
	BYTE fp_Name[FONTNAMESIZE]; /* Font name */		BYTE fp_Name[FONTNAMESIZE]; /* Font name */
	};~~</pre>~~		};
			</syntaxhighlight>

	=== ICTL ===		=== ICTL ===

Steven Solie: /* The ENV: Directory and Notification */

2013-05-23T19:38:41Z

The ENV: Directory and Notification

Show changes

Steven Solie: /* Reading a Preferences File */

2013-05-22T21:52:55Z

Reading a Preferences File

Show changes

Steven Solie: /* Preferences in 1.3 and Older Versions of the OS */

2013-05-22T21:30:55Z

Preferences in 1.3 and Older Versions of the OS

← Older revision		Revision as of 21:30, 22 May 2013
Line 596:		Line 596:
	== Preferences in 1.3 and Older Versions of the OS ==		== Preferences in 1.3 and Older Versions of the OS ==

	In 1.3, the Preferences program allows the user to see and change many system wide parameters, like the Workbench colors, pointer image, printer settings etc. When a Preferences item is changed, the new setting can be used temporarily (until a reset occurs) or stored permanently in the "~~devs~~:system-configuration" file. Under 1.3, all Preferences items are stored in this file which the system reads at boot time to find out how to set various system-wide options.		In 1.3, the Preferences program allows the user to see and change many system wide parameters, like the Workbench colors, pointer image, printer settings etc. When a Preferences item is changed, the new setting can be used temporarily (until a reset occurs) or stored permanently in the "DEVS:system-configuration" file. Under 1.3, all Preferences items are stored in this file which the system reads at boot time to find out how to set various system-wide options.

			<syntaxhighlight>
	<pre>
	struct Preferences GetPrefs(struct Preferences preferences, LONG size);		struct Preferences GetPrefs(struct Preferences preferences, LONG size);
	struct Preferences GetDefPrefs(struct Preferences preferences, LONG size);		struct Preferences GetDefPrefs(struct Preferences preferences, LONG size);
	struct Preferences SetPrefs( struct Preferences preferences, LONG size, BOOL inform );		struct Preferences SetPrefs( struct Preferences preferences, LONG size, BOOL inform );
			</syntaxhighlight>
	</pre>

	None of these functions should be used in any new programs. They are only present for backwards compatibility.		None of these functions should be used in any new programs. They are only present for backwards compatibility.

Steven Solie: /* Function Reference */

2013-05-22T21:30:01Z

Function Reference

← Older revision		Revision as of 21:30, 22 May 2013
Line 610:		Line 610:
	The following are brief descriptions of the system functions that relate to the use of Preferences. See the SDK for details on each function call.		The following are brief descriptions of the system functions that relate to the use of Preferences. See the SDK for details on each function call.

			{\| class="wikitable"
	<table>
			! Function
	<tr class="header">
			! Description
	<th align="left">'''Function'''</th>
			\|-
	<th align="left">'''Description'''</th>
			\| GetPrefs()
	</tr>
			\| Old 1.3 (V34) function for making a copy of the Preferences structure
	<tr class="odd">
			\|-
	<td align="left">GetPrefs()</td>
			\| SetPrefs()
	<td align="left">Old 1.3 (V34) function for making a copy of the Preferences structure</td>
			\| Old 1.3 (V34) function for overwriting Preferences with new data
	</tr>
			\|-
	<tr class="even">
			\| GetDefPrefs()
	<td align="left">SetPrefs()</td>
	~~<td~~ ~~align="left">~~Old 1.3 (V34) function for ~~overwriting~~ ~~Preferences~~ ~~with~~ ~~new~~ ~~data</td>~~		\| Old 1.3 (V34) function for copying default Preferences from ROM
			\|-
	</tr>
			\| StartNotify()
	<tr class="odd">
			\| DOS library function for monitoring a .prefs file for changes
	<td align="left">GetDefPrefs()</td>
			\|-
	<td align="left">Old 1.3 (V34) function for copying default Preferences from ROM</td>
			\| EndNotify()
	</tr>
			\| Ends notification started with StartNotify()
	<tr class="even">
			\|-
	<td align="left">StartNotify()</td>
			\| AllocIFF()
	<td align="left">Release 2 DOS library function for monitoring a .prefs file for changes</td>
			\| IFFParse library function that creates an IFFHandle for parsing
	</tr>
			\|-
	<tr class="odd">
			\| InitIFFasDOS()
	<td align="left">EndNotify()</td>
			\| Initialize the IFFHandle as a DOS stream
	<td align="left">Ends notification started with StartNotify()</td>
			\|-
	</tr>
			\| OpenIFF()
	<tr class="even">
			\| Initialize an IFFHandle for reading or writing a new stream
	<td align="left">AllocIFF()</td>
			\|-
	<td align="left">IFFParse library function that creates an IFFHandle for parsing</td>
			\| PropChunk()
	</tr>
			\| Specify a property chunk to store
	<tr class="odd">
			\|-
	<td align="left">InitIFFasDOS()</td>
			\| ParseIFF()
	<td align="left">Initialize the IFFHandle as a DOS stream</td>
			\| Parse an IFF file from the IFFHandle stream
	</tr>
			\|-
	<tr class="even">
			\| CurrentChunk()
	<td align="left">OpenIFF()</td>
			\| Returns the top level context of an IFF stream
	<td align="left">Initialize an IFFHandle for reading or writing a new stream</td>
			\|-
	</tr>
			\| FindProp()
	<tr class="odd">
			\| Search for a property chunk previously declared with PropChunk()
	<td align="left">PropChunk()</td>
			\|-
	<td align="left">Specify a property chunk to store</td>
			\| CloseIFF()
	</tr>
			\| Closes an IFF context opened with OpenIFF()
	<tr class="even">
			\|-
	<td align="left">ParseIFF()</td>
			\| FreeIFF()
	<td align="left">Parse an IFF file from the IFFHandle stream</td>
			\| Frees the IFFHandle created with AllocIFF()
	</tr>
			\|}
	<tr class="odd">
	<td align="left">CurrentChunk()</td>
	<td align="left">Returns the top level context of an IFF stream</td>
	</tr>
	<tr class="even">
	<td align="left">FindProp()</td>
	<td align="left">Search for a property chunk previously declared with PropChunk()</td>
	</tr>
	<tr class="odd">
	<td align="left">CloseIFF()</td>
	<td align="left">Closes an IFF context opened with OpenIFF()</td>
	</tr>
	<tr class="even">
	<td align="left">FreeIFF()</td>
	<td align="left">Frees the IFFHandle created with AllocIFF()</td>
	</tr>
	</table>

Steven Solie: /* SERL */

2013-05-22T21:26:35Z

SERL

← Older revision		Revision as of 21:26, 22 May 2013
Line 350:		Line 350:
	=== SERL ===		=== SERL ===

			<syntaxhighlight>

		⚫	struct SerialPrefs

⚫	~~<pre>~~struct SerialPrefs
	{		{
	LONG sp_Reserved[4]; /* System reserved */		LONG sp_Reserved[4]; /* System reserved */
Line 366:		Line 365:
	UBYTE sp_BitsPerChar; /* I/O bits per character */		UBYTE sp_BitsPerChar; /* I/O bits per character */
	UBYTE sp_StopBits; /* Stop bits */		UBYTE sp_StopBits; /* Stop bits */
	};~~</pre>~~		};
			</syntaxhighlight>

	=== Other Preferences File Formats ===		=== Other Preferences File Formats ===

Steven Solie: /* SCRM */

2013-05-22T21:26:11Z

SCRM

← Older revision		Revision as of 21:26, 22 May 2013
Line 336:		Line 336:
	=== SCRM ===		=== SCRM ===

			<syntaxhighlight>

		⚫	struct ScreenModePrefs

⚫	~~<pre>~~struct ScreenModePrefs
	{		{
	ULONG sm_Reserved[4];		ULONG sm_Reserved[4];
Line 346:		Line 345:
	UWORD sm_Depth; /* Screen depth */		UWORD sm_Depth; /* Screen depth */
	UWORD sm_Control; /* BIT 0, Autoscroll yes/no */		UWORD sm_Control; /* BIT 0, Autoscroll yes/no */
	};~~</pre>~~		};
			</syntaxhighlight>

	=== SERL ===		=== SERL ===

Steven Solie: /* PTXT */

2013-05-22T21:25:53Z

PTXT

← Older revision		Revision as of 21:25, 22 May 2013
Line 315:		Line 315:
	=== PTXT ===		=== PTXT ===

			<syntaxhighlight>

		⚫	struct PrinterTxtPrefs

⚫	~~<pre>~~struct PrinterTxtPrefs
	{		{
	LONG pt_Reserved[4]; /* System reserved */		LONG pt_Reserved[4]; /* System reserved */
Line 332:		Line 331:
	UWORD pt_RightMargin; /* Right margin */		UWORD pt_RightMargin; /* Right margin */
	UWORD pt_Quality; /* Draft or Letter */		UWORD pt_Quality; /* Draft or Letter */
	};~~</pre>~~		};
			</syntaxhighlight>

	=== SCRM ===		=== SCRM ===