// $Revision: 1.5 $ // Copyright (C) 1995 Taligent, Inc. All rights reserved. #if 0 ---------------------------------------------------------------------- > Class: | MSelectionMapping > Taxonomy Category: | GlobalSelectionTool | Mapping subsystem > Interface Category: | Sample. > Inherits From: | None. > Inherited By: | TDOMDocumentComponentView > Purpose: | The MSelectionMapping class defines a concise, five-function protocol for converting between TModelSelections and the screen real estate the specified data occupies. Because coordinate systems can vary from view to view, a standard coordinate system needs to be agreed upon to put geometries into their proper screen context. Each MSelectionMapping keeps a reference to a view to establish a coordinate system for geometries passed between itself and its clients. > Instantiation: | Allocate on the heap or the stack. > Deriving Classes: | TDOMDocumentComponentView > Concurrency: | Multithread safe. > Resource Use: | No special requirements. > Other Considerations: | MSelectionMapping defines only const functions, making it inherently multithread safe. ---------------------------------------------------------------------- #endif #if 0 ---------------------------------------------------------------------- > Member Function: MSelectionMapping::MSelectionMapping ; | MSelectionMapping (const TViewHandle & view) > Interface Category: | Sample. > Purpose: | Constuctor for derived classes. > Calling Context: | Called by derived classes in their constructors. > Parameters: = const TViewHandle & view -The coordinate view for the mapping. > Return Value: | None. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | Multithread safe. > Other Considerations: | None. ---------------------------------------------------------------------- #endif #if 0 ---------------------------------------------------------------------- > Member Function: MSelectionMapping::~MSelectionMapping ; | virtual ~ MSelectionMapping () > Interface Category: | Sample. > 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: | Multithread safe. > Other Considerations: | None. ---------------------------------------------------------------------- #endif #if 0 ---------------------------------------------------------------------- > Member Function: MSelectionMapping::GetSelectionDisplayArea ; | virtual TGArea GetSelectionDisplayArea (const TModelSelection & selection) const > Interface Category: | Sample. > Purpose: | Returns the area in which the selected data is displayed. The area is expressed in the coordinate system of the view returned by the GetMappingView function. This function is used to support feedback creation. > Calling Context: | Called by the tool target. > Parameters: = const TModelSelection & selection -The selection to map to an area. > Return Value: | The area in which the selected data is displayed. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | Multithread safe. > Other Considerations: | None. ---------------------------------------------------------------------- #endif #if 0 ---------------------------------------------------------------------- > Member Function: MSelectionMapping::CreateInsertionPoint ; | virtual TModelSelection * CreateInsertionPoint (const TGPoint & where) const > Interface Category: | Sample. > Purpose: | Returns an empty selection. The selection should be set up so that data inserted into it appears at the specified location. If data canŐt be inserted at the specified location, the selection returned can be undefined. This function supports _creation_ gestures like dropping dragged data. > Calling Context: | Called by TInsertionTarget to create an insertion point. > Parameters: = const TGPoint & where -The location on screen of the desired insertion point. > Return Value: | An empty selection. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | Multithread safe. > Other Considerations: | None. ---------------------------------------------------------------------- #endif #if 0 ---------------------------------------------------------------------- > Member Function: MSelectionMapping::CreateSelectionFromPoint ; | virtual TModelSelection * CreateSelectionFromPoint (const TGPoint & where) const > Interface Category: | Sample. > Purpose: | Returns a selection specifying the data located under a specified point. This is used to support the _click-select_ gesture. The selection returned can be empty or undefined if no data lies below the specified point. > Calling Context: | Called by TSelectionTarget to the selection data. > Parameters: = const TGPoint & where -Where to select. > Return Value: | A selection specifying the data located under a specified point. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | Multithread safe. > Other Considerations: | None. ---------------------------------------------------------------------- #endif #if 0 ---------------------------------------------------------------------- > Member Function: MSelectionMapping::CreateSelectionFromArea ; | virtual TModelSelection * CreateSelectionFromArea (const TGArea & area) const > Interface Category: | Sample. > Purpose: | Returns a selection for the data located in the specified area. This function is used to implement the _rubberband_ and _lasso_ selection gestures. The selection returned can be empty or undefined if no data lies within the specified area. Derived classes (clients) are free to decide whether items that only intersect the specified area, and are not wholly contained by it, should be included in the selection. > Calling Context: | Called by TSelectionTarget. > Parameters: = const TGArea & area -The area to select. > Return Value: | A selection for the data located in the specified area. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | Multithread safe. > Other Considerations: | None. ---------------------------------------------------------------------- #endif #if 0 ---------------------------------------------------------------------- > Member Function: MSelectionMapping::GetMappingView ; | TViewHandle GetMappingView () const > Interface Category: | Sample. > Purpose: | Returns the coordinate view. > Calling Context: | Called by selection tool targets when converting coordinates. > Parameters: = Takes no parameters. > Return Value: | The coordinate view for the selection mapping. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | Multithread safe. > Other Considerations: | None. ---------------------------------------------------------------------- #endif