Editor API

Detailed Description

This Class Category contains the API to the Editing component.

It contains the Editor itself, the request handler base class for the client to override, and the operations themselves.

The operations are split into separate sub-categories and must be added to the editor by the application. Utility classes allow batches of common operations to be added easily.

Topics
	APP6A
	Attribute Operations
	Basic Primitive Operations
	Selection Operations
	Transformation Operations
	User Operations
	Windows Operations

Classes
class	TSLAllOperations
class	TSLAttributeData
class	TSLCustomFeedback
class	TSLCustomHighlight
class	TSLCustomHighlightRequest
class	TSLEditor
class	TSLEditorRequest
struct	TSLLocatorEvent

Enumerations
enum	TSLCursorMovementType {   TSLCursorMovementNone = 0 , TSLCursorMovementTMCAbsolute = 1 , TSLCursorMovementTMCRelative = 2 , TSLCursorMovementMUAbsolute = 3 ,   TSLCursorMovementMURelative = 4 , TSLCursorMovementUUAbsolute = 5 , TSLCursorMovementUURelative = 6 , TSLCursorMovementLatLongDecimal = 7 ,   TSLCursorMovementLatLongAngular = 8 , TSLCursorMovementAngleDistance = 9 , TSLCursorMovementAngleTMCDistance = 10 , TSLCursorMovementBearingTMCDistance = 11 ,   TSLCursorMovementAngleMUDistance = 12 , TSLCursorMovementBearingMUDistance = 13 , TSLCursorMovementAngleUUDistance = 14 , TSLCursorMovementBearingUUDistance = 15 }
enum	TSLEditorConstraintType {   TSLEditorConstraintNone = 0 , TSLEditorConstraintEqual = 1 , TSLEditorConstraintVertical = 2 , TSLEditorConstraintHorizontal = 3 ,   TSLEditorConstraintAngle = 4 , TSLEditorConstraintDistance = 5 }

---

Class Documentation

TSLLocatorEvent

struct TSLLocatorEvent

This is the TSLLocatorEvent class.

It is a structure used to describe locator (mouse) events occurring on the drawing surface.

Class Members
TSLButtonType	m_buttonType
TSLLocatorType	m_locatorType
TSLModifierType	m_modifiers
TSLTMC	m_x	Data Members for Class Attributes X coordinate of locator event, in TMC space.
TSLTMC	m_y	Y coordinate of locator event, in TMC space.

Enumeration Type Documentation

TSLCursorMovementType

enum TSLCursorMovementType

This enumeration defines the different types of cursor movement feedback that may be supplied to the application via the TSLEditorRequest::onCursorMovement method.

Enumerator
TSLCursorMovementNone	No feedback is required.
TSLCursorMovementTMCAbsolute	The absolute coordinates of the cursor are required, in TMC units. Format specifiers of the form "%g" or "%f" are required.
TSLCursorMovementTMCRelative	The distance, in TMC units of the cursor relative to the last selected point are required. Format specifiers of the form "%g" or "%f" are required.
TSLCursorMovementMUAbsolute	The absolute coordinates of the cursor are required, in Map units. Format specifiers of the form "%g" or "%f" are required.
TSLCursorMovementMURelative	The distance in Map units of the cursor relative to the last selected point are required. Format specifiers of the form "%g" or "%f" are required.
TSLCursorMovementUUAbsolute	The absolute coordinates of the cursor are required, in User units. Format specifiers of the form "%g" or "%f" are required.
TSLCursorMovementUURelative	The distance in User units of the cursor relative to the last selected point are required. Format specifiers of the form "%g" or "%f" are required.
TSLCursorMovementLatLongDecimal	The latitude/longitude of the cursor is required, in decimal degrees. Format specifiers of the form "%g" or "%f" are required.
TSLCursorMovementLatLongAngular	The latitude/longitude of the cursor is required, in degrees, minutes and decimal seconds. Format specifiers of the form "%s" are required.
TSLCursorMovementAngleDistance
TSLCursorMovementAngleTMCDistance	The angle and distance in TMC units of the cursor from the last selected point are required. The angle will be relative to the +ve X axis, positive anti-clockwise. The format print will display angle first, followed by the distance. Format specifiers of "%g" or "%f" are required.
TSLCursorMovementBearingTMCDistance	The angle and distance in TMC units of the cursor from the last selected point are required. The angle will be relative to the +ve Y axis, positive clockwise. The format print will display angle first, followed by the distance. Format specifiers of "%g" or "%f" are required.
TSLCursorMovementAngleMUDistance	The angle and distance in Map units of the cursor from the last selected point are required. The angle will be relative to the +ve X axis, positive anti-clockwise. The format print will display angle first, followed by the distance. Format specifiers of "%g" or "%f" are required.
TSLCursorMovementBearingMUDistance	The angle and distance in Map units of the cursor from the last selected point are required. The angle will be relative to the +ve Y axis, positive clockwise. The format print will display angle first, followed by the distance. Format specifiers of "%g" or "%f" are required.
TSLCursorMovementAngleUUDistance	The angle and distance in TMC units of the cursor from the last selected point are required. The angle will be relative to the +ve X axis, positive anti-clockwise. The format print will display angle first, followed by the distance. Format specifiers of "%g" or "%f" are required.
TSLCursorMovementBearingUUDistance	The angle and distance in TMC units of the cursor from the last selected point are required. The angle will be relative to the +ve Y axis, positive clockwise. The format print will display angle first, followed by the distance. Format specifiers of "%g" or "%f" are required.

TSLEditorConstraintType

enum TSLEditorConstraintType

This is an enumerator for locator movement constraints.

Enumerator
TSLEditorConstraintNone	No constraint is applied (Unequal scaling) when resizing from the edge. Movement is restricted to the vertical or horizontal direction when resizing from the centre vertical or horizontal axes.
TSLEditorConstraintEqual	Equal scaling is applied.
TSLEditorConstraintVertical	Movement is restricted to the vertical axis.
TSLEditorConstraintHorizontal	Movement is restricted to the horizontal axis.
TSLEditorConstraintAngle	Movement is restricted to the specified angle from the previous point.
TSLEditorConstraintDistance	Movement is restricted to the specified distance from the previous point.