Programming Reference:ApplicationWindow Class - Revision history

Mellinger: /* Application Window Properties */

2023-12-19T15:44:22Z

Application Window Properties

@@ Line 80: / Line 80: @@
 ====<name>WindowLeft, <name>WindowTop====
 The screen position of the application window's top left corner, in pixels.
 ===Application Window Visualization===

Mellinger: /* Inheritance */

2011-07-07T15:59:31Z

Inheritance

@@ Line 56: / Line 56: @@
 ==Inheritance==
 <tt>ApplicationWindow</tt> inherits a number of methods and properties from [[Programming Reference:DisplayWindow Class|the <tt>DisplayWindow</tt> class]].
 ==Parameters==

Mellinger: /* Display Parameterization and Visualization */

2011-07-07T15:46:17Z

Display Parameterization and Visualization

← Older revision		Revision as of 15:46, 7 July 2011
Line 47:		Line 47:

	<tt>ApplicationWindow</tt> objects will handle display visualization transparently, using the <tt>GraphDisplay</tt>'s <tt>BitmapData</tt> method to obtain a copy of its contents, and to send these to the operator module for display in a visualization window using a message source ID of ''<name>Window''.		<tt>ApplicationWindow</tt> objects will handle display visualization transparently, using the <tt>GraphDisplay</tt>'s <tt>BitmapData</tt> method to obtain a copy of its contents, and to send these to the operator module for display in a visualization window using a message source ID of ''<name>Window''.



	==Properties==		==Properties==

Mellinger: /* Methods */

2011-07-07T15:46:04Z

Methods

← Older revision		Revision as of 15:46, 7 July 2011
Line 48:		Line 48:
	<tt>ApplicationWindow</tt> objects will handle display visualization transparently, using the <tt>GraphDisplay</tt>'s <tt>BitmapData</tt> method to obtain a copy of its contents, and to send these to the operator module for display in a visualization window using a message source ID of ''<name>Window''.		<tt>ApplicationWindow</tt> objects will handle display visualization transparently, using the <tt>GraphDisplay</tt>'s <tt>BitmapData</tt> method to obtain a copy of its contents, and to send these to the operator module for display in a visualization window using a message source ID of ''<name>Window''.

	~~==Methods==~~
	~~===ApplicationWindow( string name = "Application" )===~~
	Constructs an object of type <tt>ApplicationWindow</tt>, and registers it under the specified name. When no name is given, it defaults to "Application". Typically, you declare an <tt>ApplicationWindow</tt> as a member of your application module's main task class, and use a constructor initializer to initialize it from the main task class' constructor:
	~~<pre>~~
	~~#include "ApplicationWindow.h"~~
	~~class MyTask : ApplicationBase~~
	{
	~~public:~~
	~~...~~
	~~private:~~
	~~ApplicationWindow mWindow;~~
	~~...~~
	};

	~~MyTask::MyTask()~~
	~~: mWindow( "MyTask" ),~~
	~~...~~
	{
	~~...~~
	}
	~~</pre>~~
	~~===~ApplicationWindow()===~~
	Destructs the <tt>ApplicationWindow</tt> object, and unregisters it from the list of application windows. You do not call this function directly; typically, it will be called on destruction of an object which has an <tt>ApplicationWindow</tt> as a member.

	==Properties==		==Properties==

Mellinger: /* Usage */

2011-07-07T15:45:30Z

Usage

← Older revision		Revision as of 15:45, 7 July 2011
Line 37:		Line 37:
	}		}
	</pre>		</pre>
	When multiple filters do this, specifying the same name, no duplicate windows are created; rather, a single <tt>ApplicationWindow</tt> instance will be shared among them.		When multiple filters do this, specifying the same name, no duplicate windows are created; rather, a single <tt>ApplicationWindow</tt> instance will be shared among them.
	This implies that other filters in an application module may access existing windows via the <tt>Window( name )</tt> accessor function provided by the <tt>Environment</tt> class. This allows filters to add specific information to existing windows.		This implies that other filters in an application module may access existing windows via the <tt>Window( name )</tt> accessor function provided by the <tt>Environment</tt> class. This allows filters to add specific information to existing windows.
	When no window creation is desired but access to an existing window only, call <tt>Environment::Window( name )</tt> from your filter's Preflight() function rather than its constructor. This makes sure that a window of that name exists, and is later accessible through the <tt>Environment::Window()</tt> function during other phases of filter execution.		When no window creation is desired but access to an existing window only, call <tt>Environment::Window( name )</tt> from your filter's Preflight() function rather than its constructor. This makes sure that a window of that name exists, and is later accessible through the <tt>Environment::Window()</tt> function during other phases of filter execution.

Mellinger: /* Usage */

2011-07-07T15:45:14Z

Usage

@@ Line 16: / Line 16: @@
 ==Usage==
-The main task filter in an application module uses a data member of type <tt>ApplicationWindow</tt> to provide visual output to the user. Other filters in an application module may access existing windows via the <tt>Window( name )</tt> accessor function provided by the <tt>Environment</tt> class. This allows filters to add specific information to existing windows.
+Objects of type <tt>ApplicationWindow</tt> are created by calling <tt>Environment::Window( name )</tt> from a filter's constructor. Typically, this is done in the constructor initializer of an <tt>ApplicationWindow</tt> reference:
 ==Display Parameterization and Visualization==

Mellinger: /* string Name (r) */

2011-07-06T13:57:05Z

string Name (r)

← Older revision		Revision as of 13:57, 6 July 2011
Line 50:		Line 50:
	===string Name (r)===		===string Name (r)===
	A window's name is set when the window is created, and may not be changed afterwards. The name property defaults to "Application".		A window's name is set when the window is created, and may not be changed afterwards. The name property defaults to "Application".
			===string VisualizationID (r)===
			The [[Programming_Reference:GenericVisualization_Class#Properties\|visualization source ID]] used when transmitting the window's content to the Operator module. The visualization ID is derived from the window's name by appending "Window" to the name.

	==Inheritance==		==Inheritance==

Mellinger: /* Display Parameterization and Visualization */

2011-07-05T13:36:46Z

Display Parameterization and Visualization

← Older revision		Revision as of 13:36, 5 July 2011
Line 22:		Line 22:

	<tt>ApplicationWindow</tt> objects will handle display visualization transparently, using the <tt>GraphDisplay</tt>'s <tt>BitmapData</tt> method to obtain a copy of its contents, and to send these to the operator module for display in a visualization window using a message source ID of ''<name>Window''.		<tt>ApplicationWindow</tt> objects will handle display visualization transparently, using the <tt>GraphDisplay</tt>'s <tt>BitmapData</tt> method to obtain a copy of its contents, and to send these to the operator module for display in a visualization window using a message source ID of ''<name>Window''.

			==Methods==
			===ApplicationWindow( string name = "Application" )===
			Constructs an object of type <tt>ApplicationWindow</tt>, and registers it under the specified name. When no name is given, it defaults to "Application". Typically, you declare an <tt>ApplicationWindow</tt> as a member of your application module's main task class, and use a constructor initializer to initialize it from the main task class' constructor:
			<pre>
			#include "ApplicationWindow.h"
			class MyTask : ApplicationBase
			{
			public:
			...
			private:
			ApplicationWindow mWindow;
			...
			};

			MyTask::MyTask()
			: mWindow( "MyTask" ),
			...
			{
			...
			}
			</pre>
			===~ApplicationWindow()===
			Destructs the <tt>ApplicationWindow</tt> object, and unregisters it from the list of application windows. You do not call this function directly; typically, it will be called on destruction of an object which has an <tt>ApplicationWindow</tt> as a member.

			==Properties==
			===string Name (r)===
			A window's name is set when the window is created, and may not be changed afterwards. The name property defaults to "Application".

			==Inheritance==
			<tt>ApplicationWindow</tt> inherits a number of methods and properties from [[Programming Reference:DisplayWindow Class\|the <tt>DisplayWindow</tt> class]].

	==Parameters==		==Parameters==

Mellinger: /* Application Window Visualization */

2011-07-04T17:44:03Z

Application Window Visualization

← Older revision		Revision as of 17:44, 4 July 2011
Line 35:		Line 35:

	===Application Window Visualization===		===Application Window Visualization===
	~~Visualization parameters are available only if the descendant class provides a <tt>GUI::GraphDisplay</tt> pointer at construction time.~~
	====VisualizeApplicationWindow====		====VisualizeApplicationWindow====
	====Visualize<name>Window====		====Visualize<name>Window====

Mellinger: /* Usage */

2011-07-04T17:43:37Z

Usage

← Older revision		Revision as of 17:43, 4 July 2011
Line 17:		Line 17:
	==Usage==		==Usage==
	The main task filter in an application module uses a data member of type <tt>ApplicationWindow</tt> to provide visual output to the user. Other filters in an application module may access existing windows via the <tt>Window( name )</tt> accessor function provided by the <tt>Environment</tt> class. This allows filters to add specific information to existing windows.		The main task filter in an application module uses a data member of type <tt>ApplicationWindow</tt> to provide visual output to the user. Other filters in an application module may access existing windows via the <tt>Window( name )</tt> accessor function provided by the <tt>Environment</tt> class. This allows filters to add specific information to existing windows.


	==Display Parameterization and Visualization==		==Display Parameterization and Visualization==