Mellinger at 12:23, 23 August 2011

2011-08-23T12:23:07Z

New page

''ApplicationWindowClient'' is a mix-in class that provides its inheritants with access to application windows, which are instances of [[Programming Reference:ApplicationWindow Class|the <tt>ApplicationWindow</tt> class]]. <tt>ApplicationWindow</tt> instances have names, with the default name being "Application". A window's name may be used to obtain a [[Programming Reference:DisplayWindow Class|<tt>DisplayWindow</tt>]] reference to the window, e.g.
<pre>
DisplayWindow& applicationWindow = Window( "Application" );
applicationWindow.SetTop( 15 );
</pre>
Const access to the underlying list of windows is provided via the <tt>ApplicationWindowClient::Windows</tt> pointer. This allows to write
<pre>
if( Windows->Exists( "Application" ) )
{
DisplayWindow& applicationWindow = Window( "Application" );
TextStimulus* pStimulus = new TextStimulus( applicationWindow );
..
}
</pre>
It also allows to iterate over existing windows:
<pre>
for( int i = 0; i < Windows->Size(); ++i )
{
bciout << ( *Windows )[i].Name() << endl;
}
</pre>
<tt>ApplicationWindow</tt> instances are created by using the <tt>ApplicationWindowClient::Window( name )</tt> function during a module's construction phase, typically from a <tt>GenericFilter</tt> descendant's constructor (for an example, see [[Programming Reference:ApplicationWindow Class#Usage|the <tt>ApplicationWindow</tt> class page]]. If an application window with that name already exists, it will be shared amongst filters which access it.

If you don't want to create an application window, but only access an existing one, you need to declare access to that window during the preflight phase. In your <tt>Preflight()</tt> member function, write:
<pre>
Window( "Application" );
</pre>
When no such window exists, a preflight error will be reported. Unless the window has been accessed during the construction phase, not declaring access to the window during the preflight phase will result in an error message when calling <tt>ApplicationWindowClient::Window()</tt> from elsewhere.

==See Also==
[[Programming Reference:ApplicationWindow Class]], [[Programming Reference:Environment Class]]

[[Category:Framework API]][[Category:Development]]

Programming Reference:ApplicationWindowClient Class - Revision history

Mellinger at 12:23, 23 August 2011