Class: TPresenterStateSelection

Declaration: CompoundDocument.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TTextPresenterStateSelection

Purpose:

Specifies the presenter state that is to be the target of a document component or presenter state command.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

The presenter state selection class is meant to be derived by the developer of the associated presenter state derived class.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TPresenterStateSelection::TPresenterStateSelection

  1. TPresenterStateSelection (const TPresenterStateReference &)
  2. TPresenterStateSelection (const TPresenterStateSelection &)
  3. TPresenterStateSelection ()

Interface Category:

API.

Purpose:

  1. Creates a new presenter state selection on the specified presenter state.
  2. Copy constructor.
  3. Default constructor.

Calling Context:

  1. Call this function directly.
  2. Called to copy an object. You can also call this function directly.
  3. 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: TPresenterStateSelection::~TPresenterStateSelection

virtual ~ TPresenterStateSelection ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object. You can also 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: TPresenterStateSelection::IsDefined

virtual bool IsDefined () const

Interface Category:

API.

Purpose:

Indicates whether this selection specifies a valid range of data.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns true if the selection is defined.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPresenterStateSelection::DeselectAll

virtual void DeselectAll ()

Interface Category:

API.

Purpose:

Resets the selection so that it no longer specifies any presenter state data.

Calling Context:

Call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Preconditions: Assertion (IsDefined() ==true ). Postconditions: Assertion (IsEmpty() ==true). Invariants: Assertion (IsDefined() ==true ).

Member Function: TPresenterStateSelection::SelectWholePresenterState

virtual void SelectWholePresenterState ()

Interface Category:

API.

Purpose:

Selects all the information contained in the presenter state.

Calling Context:

Call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Postconditions: Assertion (IsDefined() ==true ).

Member Function: TPresenterStateSelection::SetUndefined

virtual void SetUndefined ()

Interface Category:

API.

Purpose:

Marks this selection as being undefined. It does not specify any presenter state data.

Calling Context:

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

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data. You can also call this function directly.

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

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

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data. You can also call this function directly.

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

virtual long Hash () const

Interface Category:

API.

Purpose:

Generates a hash key.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns the hash value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPresenterStateSelection::SetState

virtual void SetState (EState)

Interface Category:

API.

Purpose:

Sets the state of the selection. It can be kUndefined, kEmpty, or kNotEmpty.

Calling Context:

Called by derived classes.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TPresenterStateSelection::GetState

EState GetState () const

Interface Category:

API.

Purpose:

Gets the state of the selection. It can be kUndefined, kEmpty, or kNotEmpty.

Calling Context:

Called by derived classes.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TPresenterStateSelection::operator=

TPresenterStateSelection & operator =(const TPresenterStateSelection &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

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: TPresenterStateSelection::GetPresenterStateReference

TPresenterStateReference GetPresenterStateReference () const

Interface Category:

API.

Purpose:

Returns the presenter state reference for which this object provides selection behavior.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns the presenter state reference for which this object provides selection behavior.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPresenterStateSelection::SelectDefault

virtual void SelectDefault ()

Interface Category:

API.

Purpose:

Makes a default selection on this object's presenter state's data.

Calling Context:

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: TPresenterStateSelection::IsEqual

virtual bool IsEqual (const MCollectible *) const

Interface Category:

API.

Purpose:

Compares two presenter state selections for equality.

Calling Context:

You can call this function directly.

Parameters:

Return Value:

Returns true if the selections are for the same presenter state.

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.