PropertyRouter Interface Reference

Class that allows plugin to start routing property changes from one project item into another. More...

Public Member Functions
bool	IsActive ()
	Allows to check whether router is active or not.
bool	IsRoutingObject (ProjectItem root, ProjectItem item)
	Called to determine whether item is supposed to be routed in context of the root.
void	RoutingFinished (ProjectItem item)
	Called when item is no longer edited.
RoutingTarget	StartRouting (ProjectItem target, ProjectItem referencingItem, Property referencingProperty)
	Called to determine whether router wants to forward property from target item to another.
void	TargetModified (ProjectItem target)
	Called to notify that the Router executed a modification in it's target.

Events
RouterNotificationHandler	RouterActivated
	Notification of router being activated: reports items that are identified as being routed.
RouterNotificationHandler	RouterDeactivated
	Notification of router being deactivated: reports items that can no longer be routed by the router.
RouterNotificationHandler	RouterStateChanged
	Allows router to invalidate a set of items to be able to re-route them.

Detailed Description

Class that allows plugin to start routing property changes from one project item into another.

Member Function Documentation

IsActive()

bool IsActive

(

)

Allows to check whether router is active or not.

IsRoutingObject()

bool IsRoutingObject	(	ProjectItem	root,
		ProjectItem	item )

Called to determine whether item is supposed to be routed in context of the root.

Parameters

root	Root item, the context.
item	The item, which is supposed to have routing configured or not.

Returns

True if item is to be routed in context of root, otherwise false.

RoutingFinished()

void RoutingFinished

(

ProjectItem

item

)

Called when item is no longer edited.

Allows router to keep track of the proxies (for example with reference counting).

Parameters

item	Item that is no longer edited.

StartRouting()

RoutingTarget StartRouting	(	ProjectItem	target,
		ProjectItem	referencingItem,
		Property	referencingProperty )

Called to determine whether router wants to forward property from target item to another.

Parameters

target	Target project item, that is to be edited.
referencingItem	Item that is referencing the target.
referencingProperty	Property that is referencing the target.

Returns

If null, the call is ignored. Otherwise a proxy is built to forward properties from target to returned item.

TargetModified()

void TargetModified

(

ProjectItem

target

)

Called to notify that the Router executed a modification in it's target.

Parameters

target

Target object that was changed.

Event Documentation

RouterActivated

RouterNotificationHandler RouterActivated

Notification of router being activated: reports items that are identified as being routed.

RouterDeactivated

RouterNotificationHandler RouterDeactivated

Notification of router being deactivated: reports items that can no longer be routed by the router.

RouterStateChanged

RouterNotificationHandler RouterStateChanged

Allows router to invalidate a set of items to be able to re-route them.