rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvDisplayTestApi Class Reference

Test API class. More...

#include <ilviews/test/display.h>

Inheritance diagram for IlvDisplayTestApi:
IlvTestApi

List of all members.

Public Member Functions

virtual void destroyNotify (IlvView *view)
 Lets you be notified that a view has been destroyed.
virtual void inputNotify (IlvView *view, IlvEvent &event)
 Lets you be notified of an event.
virtual void moveNotify (IlvAbstractView *view, IlvPos newX, IlvPos newY)
 Informs the user of any request to move the view.
virtual void moveResizeNotify (IlvAbstractView *view, IlvPos newX, IlvPos newY, IlvDim newW, IlvDim newH)
 Informs the user of any request to move or resize the view.
virtual void resizeCallNotify (IlvAbstractView *view, IlvDim newW, IlvDim newH)
 Informs the user of any request to resize the view.
virtual void resizeNotify (IlvView *view, IlvRect &rect)
 Lets you be notified of a resize event.

Static Public Member Functions

static IlBoolean SetFactory (IlvDisplayTestApiFactory factory)
 This static function registers the factory used to create an instance of an IlvDisplayTestApi or one of its subclass.

Detailed Description

Test API class.

Library: display

In order to be able to integrate GUI Test tools, Rogue Wave Views provides some special classes. These are IlvDisplayTestApi and IlvTestApi. They allow general information on the runtime to be provided, through the static member functions. Input event member functions, such as inputNotify, should be overloaded in order to implement specific operations on the various input events.

See also:
IlvTestApi.

Member Function Documentation

virtual void IlvDisplayTestApi::destroyNotify ( IlvView view  )  [virtual]

Lets you be notified that a view has been destroyed.

Lets you be notified that view has been destroyed (or closed using the title bar close button). The default implementation of this method does nothing.

Parameters:
view The view being destroyed.
virtual void IlvDisplayTestApi::inputNotify ( IlvView view,
IlvEvent event 
) [virtual]

Lets you be notified of an event.

Lets you be notified that the IlvEvent event has occurred in view. The default implementation of this member function does nothing.

Parameters:
view The view in which the event occurs.
event The event to be notified of.
virtual void IlvDisplayTestApi::moveNotify ( IlvAbstractView view,
IlvPos  newX,
IlvPos  newY 
) [virtual]

Informs the user of any request to move the view.

Keeps the user informed of any explicit request to move view. The default implementation of this function does nothing. This member function is used to distinguish between a geometry change requested by the program (due to an explicit call of the IlvView member functions in charge of calling the corresponding X window function) and a geometry change performed by the window manager or the mouse (due to an X Event that triggers a call to the resize callback function). It is called from the method IlvAbstractView::move.

Parameters:
view The view.
newX The new X origin of the view.
newY The new Y origin of the view.
virtual void IlvDisplayTestApi::moveResizeNotify ( IlvAbstractView view,
IlvPos  newX,
IlvPos  newY,
IlvDim  newW,
IlvDim  newH 
) [virtual]

Informs the user of any request to move or resize the view.

Keeps the user informed of any explicit request to move or resize view. The default implementation of this function does nothing. This member function is used to distinguish between a geometry change requested by the program (due to an explicit call of the IlvView member functions in charge of calling the corresponding X window function) and a geometry change performed by the window manager or the mouse (due to an X Event that triggers a call to the resize callback function). It is called from the method IlvAbstractView::moveResize

Parameters:
view The view.
newX The new X position of the view.
newY The new Y position of the view.
newW The new width of the view.
newH The new height of the view.
virtual void IlvDisplayTestApi::resizeCallNotify ( IlvAbstractView view,
IlvDim  newW,
IlvDim  newH 
) [virtual]

Informs the user of any request to resize the view.

Keeps the user informed of any explicit request to resize view. The default implementation of this function does nothing. This member function is used to distinguish between a geometry change requested by the program (due to an explicit call of the IlvView member functions in charge of calling the corresponding X window function) and a geometry change performed by the window manager or the mouse (due to an X Event that triggers a call to the resize callback function). It is called from the method IlvAbstractView::resize.

Parameters:
view The view.
newW The new width of the view.
newH The new height of the view.
virtual void IlvDisplayTestApi::resizeNotify ( IlvView view,
IlvRect rect 
) [virtual]

Lets you be notified of a resize event.

Lets you be notified that view has been resized and/or moved.

Parameters:
view The view being resized.
rect The new position and size of the view.
static IlBoolean IlvDisplayTestApi::SetFactory ( IlvDisplayTestApiFactory  factory  )  [static]

This static function registers the factory used to create an instance of an IlvDisplayTestApi or one of its subclass.

Parameters:
The factory to be registered.
Returns:
IlTrue when the factory is not null and IlFalse otherwise.

© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.