Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
TGUIPresenter
Inherited By:
None.
Purpose:
TTextPresenter inherits from TGUIPresenter. It is responsible for creating the presentation elements of an EditableText document component. Currently, these elements are the main content view, the scrolling view in which it resides, and the default text menus.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
Derived classes can override HandleCreateContentTextView and HandleCreateContentClippingView to create and return customized views, and HandleCreateExtendedMenus to customize the text menus.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
Other Considerations:
None.
TTextPresenter (const TGUIBundle &)
Interface Category:
API.
Purpose:
Constructor that creates a text presenter associated with the specified bundle.
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.
virtual ~ TTextPresenter ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Typically not called directly by clients.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTextPresenter::HandleCreateMainView
virtual TView * HandleCreateMainView (TGUIBundle *) const
Interface Category:
API.
Purpose:
Creates and returns the main view for the presenter. This protected function calls both HandleCreateContentTextView and HandleCreateContentClippingView. If the latter returns NIL, then the text view is the content view. Otherwise, the text view is placed inside the clipping view.
Calling Context:
Called by the Text Framework classes. Typically not called directly by clients.
Parameters:
- TGUIBundle * -The bundle of information needed by the presentation hierarchy; it is passed on to HandleCreateContentTextView.
Return Value:
A pointer to the TView clipping view, if HandleCreateContentClippingView did not return NIL. Otherwise, a pointer to the TDocumentTextView text view.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
This protected function overrides the inherited TGUIPresenter function.
Member Function: TTextPresenter::HandleCreateContentTextView
virtual TDocumentTextView * HandleCreateContentTextView (TGUIBundle *) const
Interface Category:
API.
Purpose:
Creates the text content view.
Calling Context:
Called by the Text Framework classes. Typically not called directly by clients.
Parameters:
- TGUIBundle * -The bundle of information needed by the presentation hierarchy.
Return Value:
A pointer to the TDocumentTextView text content view.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
This function is protected.
Member Function: TTextPresenter::HandleCreateContentClippingView
virtual TView * HandleCreateContentClippingView (TDocumentTextView * viewToAdopt) const
Interface Category:
API.
Purpose:
Creates the clipping view for the specified document text view.
Calling Context:
Called by the Text Framework classes. Typically not called directly by clients.
Parameters:
- TDocumentTextView * viewToAdopt -The document text view to be placed inside the clipping view.
Return Value:
A pointer to the TView clipping view.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
This function is protected.
Member Function: TTextPresenter::CreatePageIterator
virtual TPageIterator * CreatePageIterator () const
Interface Category:
API.
Purpose:
Creates a TPageIterator that allows you to iterate through pages in the presenter. This provides the necessary support to prevent printing lines split across multiple pages. Instead, lines that would normally overlap the page boundary are moved to the start of the next page.
Calling Context:
Called by the Text Framework classes. Typically not called directly by clients.
Parameters:
Return Value:
A pointer to a TPageIterator object.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
This function is protected.
Member Function: TTextPresenter::HandleMenuDeactivate
virtual void HandleMenuDeactivate (TMenu & theMainMenu)
Interface Category:
API.
Purpose:
TGUIPresenter override to handle menu deactivation. Text-related menus are removed from the main menu.
Calling Context:
Called by Document Frameworks. Not called directly by clients.
Parameters:
- TMenu & theMainMenu -reference to main menu.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
If you want to override this member function, note that the parent (TGUIPresenter::HandleMenuActivate) is called after processing.
Member Function: TTextPresenter::HandleMenuActivate
virtual void HandleMenuActivate (TMenu & theMainMenu)
Interface Category:
API.
Purpose:
TGUIPresenter override to handle menu activation. Text-related menus are added to the main menu.
Calling Context:
Called by Document Frameworks. Not called directly by clients.
Parameters:
- TMenu & theMainMenu -Reference to main menu.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
If you want to override this member function, note that the parent (TGUIPresenter::HandleMenuActivate) is called after processing.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.