Class: TShowLinksState

Declaration: LinkingCommands.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MBooleanControlState

Inherited By:

None.

Purpose:

TShowLinksState derives from MBooleanControlState and maintains the state of a document presenter's links. If the state is true, all the data links will display the appropriate link feedback. Reference links display their feedback by default.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TShowLinksState::TShowLinksState

TShowLinksState ()
TShowLinksState (const TDocumentPresenterReference &)
TShowLinksState (const TShowLinksState &)

Interface Category:

API.

Purpose:

Default constructor.
Creates a new show link state for the specified document presenter reference.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called by any client object.
Called to copy an object.

Parameters:

Takes no parameters.
const TDocumentPresenterReference & -The document presenter reference for which the new object will maintain the link state.
const TShowLinksState & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TShowLinksState::~TShowLinksState

virtual ~ TShowLinksState ()

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

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -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: TShowLinksState::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -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: TShowLinksState::SetBooleanState

virtual void SetBooleanState (EBooleanState newState)

Interface Category:

API.

Purpose:

Sets the link state according to the specified flag.

Calling Context:

Called by any client object.

Parameters:

EBooleanState newState -The new state for this object.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TShowLinksState::IsEnabled

virtual bool IsEnabled () const

Interface Category:

API.

Purpose:

Returns whether or not this show link state is enabled.

Calling Context:

Called by any client object.

Parameters:

Takes no parameters.

Return Value:

Returns true if this show link state is enabled.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TShowLinksState::GetDocumentPresenterReference

virtual TDocumentPresenterReference GetDocumentPresenterReference () const

Interface Category:

API.

Purpose:

Returns the document presenter reference for which this object maintains the show link state.

Calling Context:

Called by any client object.

Parameters:

Takes no parameters.

Return Value:

Returns the document presenter reference for which this object maintains the show link state.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TShowLinksState::HideLinks

void HideLinks ()

Interface Category:

API.

Purpose:

Hides the document presenter's links.

Calling Context:

Called by any client 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: TShowLinksState::ShowLinks

void ShowLinks ()

Interface Category:

API.

Purpose:

Shows the document presenter's links.

Calling Context:

Called by any client 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: TShowLinksState::GetBooleanState

virtual MBooleanControlState :: EBooleanState GetBooleanState () const

Interface Category:

API.

Purpose:

Sets the link state according to the specified flag.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The new state for this 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.