Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
TView
Inherited By:
TWindow
Purpose:
TActivationManagerView is a base class that defines the activation protocol for views which play a role a in the activation of their child views. TActivationManagerView provides member functions for activating child views and for constructing a local focus chain. Activatible views which interact with an activation manager view are those which descend from the activation manager view in the view hierarchy, but don't have intervening activation manager parentage. Activation manager view on the desktop (windows), also interact with descendent activation manager views. These behaviors provide the activation scoping seen in window and frame usage.
Instantiation:
TActivationManagerView is a base class that cannot be allocated.
Deriving Classes:
TActivationManagerView is the base class for views whose behavior is closely tied to the active state of their children, such as frames. A class should derive from TActivationManagerView when it wants to be treated by the activation framework in the same manner as the existing frame classes. Override HandleChildActivate and HandleChildDeactivate to provide the appropriate behavior when a view of the derived class owns the active view, such as drawing activation feedback. GetDefaultActiveChild may be overridden to determine the child to activate when this view is activated. IsActivatible may be overridden to lock out activation of this view and its children when desired. ActivateChild and DeactivateChild are not generally intended to be overridden, override IsActivatible, HandleChildActivate or HandleChildDeactivate instead.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
Other Considerations:
None.
virtual ~ TActivationManagerView ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual bool HasActiveChild () const
Interface Category:
API.
Purpose:
Determines if this object has an active child view. Returns true if this object has an active child view. Returns false if there is no active child view.
Calling Context:
Called to determine if this object has an active child view. Call this function directly.
Parameters:
Return Value:
Returns true if this object has an active child view.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
virtual void GetBounds (TGArea & area) const
Interface Category:
API.
Purpose:
Fills in the passed parameter with the allocated area of this view.
Calling Context:
Called to obtain the boundaries of this view. Call this function directly.
Parameters:
- TGArea & area -The parameter to be filled in with the bounds of this view.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
TActivationManagerView & operator =(const TActivationManagerView &)
Interface Category:
API.
Purpose:
Assignment operator.
Calling Context:
Called when an object is assigned to another compatible object. Do not call this member function, as views do not support value semantics.
Parameters:
Return Value:
A non-const reference to the left-hand side object.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual TStream & operator >>=(TStream & towhere) const
Interface Category:
API.
Purpose:
Stream-out operator.
Calling Context:
Called by Flatten to stream out this object. Only call this function directly from an override; use ::Flatten instead to preserve essential context information when this view is streamed.
Parameters:
- TStream & towhere -The destination stream.
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.
virtual TStream & operator <<= (TStream & fromwhere)
Interface Category:
API.
Purpose:
Stream-in operator.
Calling Context:
Called by Resurrect to recreate an object from a stream. Only call this function directly from an override; use ::Flatten instead to preserve essential context information when this view is streamed.
Parameters:
- TStream & fromwhere -The source stream.
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.
- TActivationManagerView ()
- TActivationManagerView (const TActivationManagerView &)
Interface Category:
API.
Purpose:
- Default constructor.
- Copy constructor.
Calling Context:
- Call this constructor from deriving class constructors.
- Called to copy an object. This constructor should not be used, since copy construction of views is not supported.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual void HandleChildActivate ()
Interface Category:
API.
Purpose:
Handles the activation of this view's child view.
Calling Context:
Called asynchronously after a view within this view's scope has been activated. This function is not normally called directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
Deriving classes may provide their own implementation for this member function which should call the inherited member function.
virtual void HandleChildDeactivate ()
Interface Category:
API.
Purpose:
Handles the activation of this view's child view.
Calling Context:
Called asynchronously after a view within this view's scope has been deactivated. This function is not normally called directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
Deriving classes may provide their own implementation for this member function which should call the inherited member function.
Member Function: TActivationManagerView::HandleBeforeDisconnectionFromViewRoot
virtual void HandleBeforeDisconnectionFromViewRoot ()
Interface Category:
API.
Purpose:
Performs actions required before disconnecting from the view root. Delegates to TView.
Calling Context:
Called before disconnecting from the view root.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
Deriving classes may provide their own implementation for this member function which should call the inherited member function.
Member Function: TActivationManagerView::HandleAfterConnectionToViewRoot
virtual void HandleAfterConnectionToViewRoot ()
Interface Category:
API.
Purpose:
Performs actions required after connecting to the view root. Configures the view for activation in the view hierarchy, and delegates to TView.
Calling Context:
Called after the view is connected to the view root.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
Deriving classes may provide their own implementation for this member function which should call the inherited member function. Calls which may interact with the window group, such as Activate or ActivateChild, should not be made within an override of this member function, as the connection to the window group is not complete at this stage. Such calls can be deferred until the window group connection is complete by posting a request to the request queue.
virtual void CancelEventActivation () const
Interface Category:
API.
Purpose:
Prevents the current mouse event from triggering activation of this view. This member function is only effective when called during the processing of a mouse event, especially a MouseDown.
Calling Context:
Called whenever a mouse event handler wants to handle activation programmatically. Call this function directly from within the scope of a mouse event handling override.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual bool IsActivatible () const
Interface Category:
API.
Purpose:
Returns true if the view is activatible.
Calling Context:
Called to determine if the view is activatible whenever activation is requested programmatically or through event processing. This function may be called directly
Parameters:
Return Value:
Returns true if the view is activatible.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual void SetActivatible (bool activatible =true)
Interface Category:
API.
Purpose:
Enables or disables the ability to activate the view.
Calling Context:
Called to enable or disable the ability to activate the view. Call this function directly.
Parameters:
- bool activatible =true -If set to true, the ability to activate the view is enabled.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual TActivatibleView * GetDefaultActiveChild ()
Interface Category:
API.
Purpose:
Returns the default child view to activate.
Calling Context:
Called to obtain the default child view to activate whenever child activation is requested and the view does not have a current record of a previously active child.
Parameters:
Return Value:
Returns the default active child.
Exceptions:
Throws no exceptions, passes all exceptions through
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual void SetDefaultActiveChild (TActivatibleView * child)
Interface Category:
API.
Purpose:
Sets the default child view to activate
Calling Context:
Called to set the child view to activate. Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual void DeactivateChild ()
Interface Category:
API.
Purpose:
Deactivates the child view.
Calling Context:
Called to programmatically deactivate the child view. Call this function directly to deactivate this view and its active child.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual bool ActivateChild ()
Interface Category:
API.
Purpose:
Activates the child view.
Calling Context:
Called to programmatically activate the child view. Call this function directly to activate this view and the last active or default active child.
Parameters:
Return Value:
Returns true if the child view was successfully activated.
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.