Class: TScrapInteractionModifier

Declaration: ScrapInteractionModifier.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

TScrapInteractionModifier is used during Workspace drag and drop operations to package up modifiers to the drag operation. Modifiers change the operation performed by the drag--for example, if the user holds down the control key while dragging a document from one folder to another, the document is copied rather than moved to the destination folder. Currently only keyboard modifiers are supported, but the key modifier class itself is not used because: 1) this support should not be drag and drop interaction dependent, and 2) to allow for future extensions to this modifier object. The modifier is given to the drag source when the drag source is asked to provide all of the scrap items for the document being dragged.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None provided.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TScrapInteractionModifier::TScrapInteractionModifier

TScrapInteractionModifier ()
TScrapInteractionModifier (const TModifierKeys & modifierKeys)
TScrapInteractionModifier (const TScrapInteractionModifier & source)

Interface Category:

API.

Purpose:

Default constructor.
Creates a new scrap interaction modifier object for the specified modifier keys.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called to construct an object with a modifier keys value.
Called to copy an object.

Parameters:

Takes no parameters.
const TModifierKeys & modifierKeys -The modifier keys to be contained by the new object.
const TScrapInteractionModifier & source -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrapInteractionModifier::~TScrapInteractionModifier

virtual ~ TScrapInteractionModifier ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrapInteractionModifier::operator=

TScrapInteractionModifier & operator =(const TScrapInteractionModifier & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function by using the operator in an assignment statement.

Parameters:

const TScrapInteractionModifier & source -The object to be copied.

Return Value:

Returns a const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrapInteractionModifier::operator>>=

TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The stream to which the object streams itself out.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrapInteractionModifier::operator<<=

TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -The stream from which the object streams itself in.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws a TInvalidVersionError if the version of the object on the stream is unknown to the version of the shared library installed.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrapInteractionModifier::GetModifierKeys

TModifierKeys GetModifierKeys () const

Interface Category:

API.

Purpose:

Returns the modifier keys contained by this modifier object. The modifier keys are provided to this object during its construction.

Calling Context:

Called to provide the modifier keys contained by this object.

Parameters:

Takes no parameters.

Return Value:

Returns the modifier keys contained by this modifier object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.