Class: TClipboardCopyControlState

Declaration: GUICompoundDocumentClipboard.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MMomentaryControlState, MGUIBundle

Inherited By:

None.

Purpose:

TClipboardCopyControlState derives from MMomentaryControlState and MGUIBundle and is a control state used to copy data to the clipboard. TClipboardCopyControlState is one of three base classes provided by the Clipboard subsystem for manipulating the clipboard.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Generally, you should not derive from this class. If derived you should call the Select member function of this class, if interested in saving the selection info.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TClipboardCopyControlState::TClipboardCopyControlState

TClipboardCopyControlState (TGUIBundleConnection * bundleConnectionToAlias)
TClipboardCopyControlState (const TClipboardCopyControlState & state)
TClipboardCopyControlState ()

Interface Category:

API.

Purpose:

Creates a new copy control state with the specified bundle connection.
Copy constructor.
Default constructor.

Calling Context:

Called to create a new copy control state with a specific bundle connection.
Called to copy an object.
Called by the stream-in operators.

Parameters:

TGUIBundleConnection * bundleConnectionToAlias -The bundle connection for the new copy control state.
const TClipboardCopyControlState & state -The object to copy.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TClipboardCopyControlState::~TClipboardCopyControlState

virtual ~ TClipboardCopyControlState ()

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: TClipboardCopyControlState::Select

void Select ()

Interface Category:

API.

Purpose:

Selects this control state. This function copies the current selection to the clipboard.

Calling Context:

Called by the Input System framework.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TClipboardCopyControlState::IsEnabled

virtual bool IsEnabled () const

Interface Category:

API.

Purpose:

Computes and returns whether or not this control state is enabled. The copy control state is enabled if there is a current selection and it is not empty.

Calling Context:

Called by the Input System framework.

Parameters:

Takes no parameters.

Return Value:

Returns true if the control state is enabled.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TClipboardCopyControlState::AddInterests

virtual void AddInterests (TSetOf < TInterest > & set)

Interface Category:

API.

Purpose:

Adds a notification interest to the specified set. The interest added is an interest that occurs when the user changes the current selection.

Calling Context:

Called by the Input System framework.

Parameters:

TSetOf < TInterest > & set -The set of interests into which to add the change of selection interest.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TClipboardCopyControlState::operator=

TClipboardCopyControlState & operator =(const TClipboardCopyControlState & copy)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TClipboardCopyControlState & copy -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: TClipboardCopyControlState::operator>>=

virtual 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: TClipboardCopyControlState::operator<<=

virtual 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.

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