InfoWindow Class - Revision history

Trixie: /* Autodoc */

2021-05-08T19:17:28Z

Autodoc

Admin: /* Autodoc */

2018-07-03T12:37:59Z

Autodoc

Admin: /* Autodoc */

2018-07-02T16:42:00Z

Autodoc

Show changes

Trixie at 11:32, 6 December 2017

2017-12-06T11:32:29Z

Admin at 20:46, 5 June 2016

2016-06-05T20:46:06Z

Admin: /* Features */

2016-06-05T20:45:39Z

Features

Admin: /* Introduction */

2016-06-05T20:43:27Z

Introduction

Admin: /* Version */

2016-06-05T19:48:41Z

Version

Admin: /* Screenshots */

2016-06-05T19:45:33Z

Screenshots

Admin: /* Screenshots */

2016-06-05T18:41:01Z

Screenshots

@@ Line 55: / Line 55: @@
 === Autodoc ===
 <pre>
-infowindow.class/--datasheet--
+infowindow.class/--datasheet--                   infowindow.class/--datasheet--
    NAME
@@ Line 307: / Line 307: @@
        This tag will be ignored if there is no body text.
-Defaults to PLACEIMAGE_LEFT
+      Defaults to PLACEIMAGE_LEFT
        Applicability is (OM_NEW, OM_SET)
@@ Line 332: / Line 332: @@
        TABDATA_FILE   -- Data contains a name of a text file
        TABDATA_LOCK   -- Data contains a DOS lock on a text file
        This means that information to be displayed in the panel can be placed
@@ Line 390: / Line 391: @@
        Applicability is (OM_NEW, OM_SET)
 </pre>

← Older revision		Revision as of 12:37, 3 July 2018
Line 306:		Line 306:

	This tag will be ignored if there is no body text.		This tag will be ignored if there is no body text.
		+
		+	Defaults to PLACEIMAGE_LEFT
		+
		+	Applicability is (OM_NEW, OM_SET)
		+
		+	INFOWINDOW_ImageBackFill (struct Hook *)
		+	Sometimes it may be desirable to place the image on a filled background.
		+	This tag allows providing a backfill hook for this purpose.
		+
		+	Defaults to NULL
		+
		+	Applicability is (OM_NEW, OM_SET)
		+
		+	INFOWINDOW_TabPanel (struct InfoWindowTab *)
		+	Use this tag to configure a special panel for displaying additional
		+	information in the window. This will normally be a tabbed panel with
		+	scrollable text fields but other configurations are also possible.
		+
		+	The tabbed panel is created by passing an array of struct InfoWindowTab
		+	(see <classes/infowindow.h> for definition). The Label member of each
		+	structure in the array must contain the tab label string. The actual
		+	contents of the Data member may vary depending on the Type member value:
		+
		+	TABDATA_STRING -- Data contains a text string
		+	TABDATA_FILE -- Data contains a name of a text file
		+	TABDATA_LOCK -- Data contains a DOS lock on a text file
		+
		+	This means that information to be displayed in the panel can be placed
		+	externally. For example, you can have a dedicated tab for displaying
		+	the program licence, the text of which is in a file on disk (only plain
		+	text files are supported at the moment):
		+
		+	struct InfoWindowTab tabs[] =
		+	{
		+	{ "Credits", (APTR) "This program was made by me!", TABDATA_STRING },
		+	{ "Licence", (APTR) "PROGDIR:Docs/Licence.txt", TABDATA_FILE },
		+	{ NULL, NULL, TABDATA_END }
		+	};
		+
		+	Note that the array must be properly terminated as shown.
		+
		+	If instead of an array you pass a single struct InfoWindowTab with
		+	a NULL Label member, a scrollable text field will be created in the
		+	place of the tabbed panel:
		+
		+	struct InfoWindowTab textField =
		+	{
		+	NULL,
		+	(APTR) "PROGDIR:Docs/Licence.txt",
		+	TABDATA_FILE
		+	};
		+
		+	The configuration can be further customized by using the TABDATA_GADGET
		+	value for Type. In such a case the Data member shall point to a BOOPSI
		+	gadget (for example, a listbrowser):
		+
		+	struct InfoWindowTab customPanel =
		+	{
		+	NULL,
		+	(APTR) myListBrowser,
		+	TABDATA_GADGET
		+	};
		+
		+	The configuration above will display your own listbrowser gadget
		+	instead of the panel, and this
		+
		+	struct InfoWindowTab tabs[] =
		+	{
		+	{ "Credits", (APTR) myListBrowser, TABDATA_GADGET },
		+	{ "Licence", (APTR) "PROGDIR:Docs/Licence.txt", TABDATA_FILE },
		+	{ NULL, NULL, TABDATA_END }
		+	};
		+
		+	will show your listbrowser under the "Credits" tab instead of the
		+	standard text field.
		+
		+	The tab panel's text fields are currently rendered using a read-only
		+	TextEditor Gadget. This may change in the future so don't assume
		+	anything about the formatting of the text.
		+
		+	Defaults to NULL (no panel)
		+
		+	Applicability is (OM_NEW, OM_SET)
		+

	</pre>		</pre>

@@ Line 1: / Line 1: @@
-==Introduction==
+== Introduction ==
-This guide describes the ReAction compatible '''InformationWindow.class''' for users and developers.
+This guide describes the ReAction-compatible '''information window class''' for users and developers.
-The '''InformationWindow.class''' is a BOOPSI compliant class that is used to display Information windows such as ''About'' windows commonly found in many applications.
+The '''InfoWindow Class''' (installed as ''infowindow.class'' in the SYS:Classes/ directory) is a BOOPSI-compliant class that is used to display information windows such as About-windows commonly found in many applications.
-From a developer's perspective, it provides an easy and adaptable way of creating and presenting the information window within their application.
+From developers' perspective, it provides an easy and adaptable way of creating and presenting information windows within their application. The class is highly configurable to suit many different needs and scenarios.
-==Version==
+The latest version is 53.8 available in the [[Enhancer Software]] for both AmigaOS3 and AmigaOS4.
-The latest version is 53.6 available in the [[Enhancer Software]] for both AmigaOS3 and AmigaOS4.
+== Features ==
 The features include:
@@ Line 26: / Line 24: @@
-==Screenshots==
+== Screenshots ==
 <center>
@@ Line 53: / Line 51: @@
-==For Developers==
+== For Developers ==
 <pre>
 TABLE OF CONTENTS

@@ Line 6: / Line 6: @@
 From a developer's perspective, it provides an easy and adaptable way of creating and presenting the information window within their application.
 ==Version==
 The latest version is 53.6 available in the [[Enhancer Software]] for both AmigaOS3 and AmigaOS4.
 ==Features==
@@ Line 22: / Line 24: @@
 * Configurable button row supporting any number of buttons, and a timeout feature.
 ==Screenshots==
@@ Line 48: / Line 51: @@
 |}
 </center>
 ==For Developers==

← Older revision		Revision as of 20:45, 5 June 2016
Line 13:		Line 13:
	==Features==		==Features==

		+	The features include:

		+	* Formatted text
		+
		+	* Aligned images
		+
		+	* Configurable panel featuring tabs, a configurable text field or a custom BOOPSI gadget
		+
		+	* Configurable button row supporting any number of buttons, and a timeout feature.

	==Screenshots==		==Screenshots==

← Older revision		Revision as of 20:43, 5 June 2016
Line 3:		Line 3:
	This guide describes the ReAction compatible '''InformationWindow.class''' for users and developers.		This guide describes the ReAction compatible '''InformationWindow.class''' for users and developers.

		+	The '''InformationWindow.class''' is a BOOPSI compliant class that is used to display Information windows such as ''About'' windows commonly found in many applications.
		+
		+	From a developer's perspective, it provides an easy and adaptable way of creating and presenting the information window within their application.

	==Version==		==Version==

@@ Line 24: / Line 24: @@
 |[[File:infowindow_class_os3_example3.png|center|250px]]
 ''OS3 version''
 |}
 </center>

@@ Line 17: / Line 17: @@
 <center>
 {|
-|- style="vertical-align:bottom;"
+|- style="vertical-align:bottom;text-align:center;"
 |[[File:infowindow_class_os3_example1.png|center|250px]]
 |[[File:infowindow_class_os3_example2.png|center|250px]]
 |[[File:infowindow_class_os3_example3.png|center|250px]]
 |}
 </center>