Class: TCommandBindingReference

Declaration: CompoundDocumentCommand.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

TCommandBindingReference provides an address-space independent reference to a command binding object.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive from this class.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TCommandBindingReference::TCommandBindingReference

  1. TCommandBindingReference (const TAbstractDocumentComponentCommandBinding &)
  2. TCommandBindingReference (const TCommandBindingReference &)
  3. TCommandBindingReference (bool isDefined)
  4. TCommandBindingReference ()

Interface Category:

API.

Purpose:

  1. Creates a reference to an existing command binding.
  2. Copy constructor.
  3. Creates a reference, defined or undefined.
  4. Default constructor.

Calling Context:

  1. Call this function directly.
  2. Called to copy an object.
  3. Called to create an undefined binding reference, or a new binding reference for a newly constructed binding.
  4. Called by the stream-in operators.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandBindingReference::~TCommandBindingReference

virtual ~ TCommandBindingReference ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object. Call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandBindingReference::IsDefined

bool IsDefined () const

Interface Category:

API.

Purpose:

Determines whether or not this reference has ever referred to a valid command binding. The binding may not still be valid if it had been subsequently deleted.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns true if the reference is defined.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandBindingReference::IsReferenceFor

bool IsReferenceFor (const TAbstractDocumentComponentCommandBinding &) const

Interface Category:

API.

Purpose:

Determines whether or not this reference refers to the specified binding.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns true if the reference refers to the specified binding.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandBindingReference::operator=

TCommandBindingReference & operator =(const TCommandBindingReference &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object. Call this function directly.

Parameters:

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: TCommandBindingReference::operator==

bool operator ==(const TCommandBindingReference &) const

Interface Category:

API.

Purpose:

Compares a reference object to another for equality. References are equal if they refer to the same command binding. Two undefined references are not equal.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns true if references are for the same binding.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandBindingReference::operator!=

bool operator != (const TCommandBindingReference &) const

Interface Category:

API.

Purpose:

Compare two references for inequality. References are not equal if they do not refer to the same command binding, or if either or both are undefined.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns true if references are not to the same binding.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandBindingReference::operator>>=

virtual TStream & operator >>=(TStream & towhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

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: TCommandBindingReference::operator<<=

virtual TStream & operator <<= (TStream & fromwhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

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: TCommandBindingReference::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Generates a hash key. Used by the Collection classes.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns a hash key.

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.
Copyright©1995 Taligent,Inc. All rights reserved.