Public Member Functions | Properties | List of all members
InteractorBase Class Referenceabstract

Base class for representing an interactor. More...

Inheritance diagram for InteractorBase:
EventHandlingBase IInteractor IChecksummable Interactor CachedBoundsInteractor DeletedInteractor WpfInteractor

Public Member Functions

abstract Rectangle GetBounds ()
 Gets the bounds of the interactor. More...
 
abstract bool TryGetBehavior (Framework.BehaviorType behaviorType, out IBehavior behavior)
 Tries to resolve a behavior associated with this interactor by the behavior's type. More...
 

Properties

string Id [get]
 Gets the interactor identifier. More...
 
string ParentId [get]
 Gets the interactor's parent identifier. More...
 
string WindowId [get]
 Gets the window identifier that this interactor belong to. More...
 
double Z [get]
 Gets the Z order of the interactor. More...
 
bool IsDeleted [get]
 Gets the IsDeleted flag of the interactor. More...
 
bool IsEnabled [get]
 Gets/sets the IsEnabled flag of the interactor. More...
 
abstract IEnumerable< IBehaviorBehaviors [get]
 Gets the behaviors associated with this interactor. More...
 
IMask Mask [get]
 Gets the IMask used to describe the geometry of the interactor in detail (if needed). Will be null when the interactor has no mask (the normal case). More...
 
RectangleMaskBounds [get]
 Gets a rectangle describing the mask bounds. The mask bounds describe the geometry over which the mask applies. The X and Y coordinates are relative to the X and Y coordinates of the interactor bounds. If no bounds are supplied the same bounds as for the interactor will be assumed. More...
 
- Properties inherited from IInteractor
string Id [get]
 Gets the interactor identifier. More...
 
string ParentId [get]
 Gets the interactor's parent identifier. More...
 
string WindowId [get]
 Gets the window identifier that this interactor belong to. More...
 
double Z [get]
 Gets the Z order of the interactor. More...
 
bool IsDeleted [get]
 Gets the IsDeleted flag of the interactor. More...
 
bool IsEnabled [get]
 Gets the IsEnabled flag of the interactor. More...
 
IEnumerable< IBehaviorBehaviors [get]
 Gets the behaviors associated with this interactor. More...
 
IMask Mask [get]
 Gets the IMask used to describe the geometry of the interactor in detail (if needed). Will be null when the interactor has no mask (the normal case). More...
 
RectangleMaskBounds [get]
 Gets a rectangle describing the mask bounds. The mask bounds describe the geometry over which the mask applies. The X and Y coordinates are relative to the X and Y coordinates of the interactor bounds. If null, the same bounds as for the interactor will be assumed. More...
 

Detailed Description

Base class for representing an interactor.

Member Function Documentation

◆ GetBounds()

abstract Rectangle GetBounds ( )
pure virtual

Gets the bounds of the interactor.

Returns
The bounds of the interactor.

Implements IInteractor.

Implemented in WpfInteractor, CachedBoundsInteractor, and DeletedInteractor.

◆ TryGetBehavior()

abstract bool TryGetBehavior ( Framework.BehaviorType  behaviorType,
out IBehavior  behavior 
)
pure virtual

Tries to resolve a behavior associated with this interactor by the behavior's type.

Parameters
behaviorTypeThe behavior type.
behaviorWhen this method returns, contains the behavior with a behavior type equivalent of the behavior type contained in behaviorType , if the operation succeeded, or null if the operation failed.
Returns
true if the behavior was found; otherwise, false.

Implements IInteractor.

Implemented in Interactor.

Property Documentation

◆ Id

string Id
get

Gets the interactor identifier.

The identifier.

◆ ParentId

string ParentId
get

Gets the interactor's parent identifier.

The interactor's parent identifier.

◆ WindowId

string WindowId
get

Gets the window identifier that this interactor belong to.

The window identifier that this interactor belong to.

◆ Z

double Z
get

Gets the Z order of the interactor.

The Z order of the interactor.

◆ IsDeleted

bool IsDeleted
get

Gets the IsDeleted flag of the interactor.

The IsDeleted flag of the interactor.

◆ IsEnabled

bool IsEnabled
get

Gets/sets the IsEnabled flag of the interactor.

The IsEnabled flag of the interactor.

◆ Behaviors

abstract IEnumerable<IBehavior> Behaviors
get

Gets the behaviors associated with this interactor.

The behaviors associated with this interactor.

◆ Mask

IMask Mask
get

Gets the IMask used to describe the geometry of the interactor in detail (if needed). Will be null when the interactor has no mask (the normal case).

◆ MaskBounds

Rectangle? MaskBounds
get

Gets a rectangle describing the mask bounds. The mask bounds describe the geometry over which the mask applies. The X and Y coordinates are relative to the X and Y coordinates of the interactor bounds. If no bounds are supplied the same bounds as for the interactor will be assumed.


The documentation for this class was generated from the following file: