Mxt Graphic Tool Functions

Function Prototypes. More...

Functions

int MxtAddCallback (MXTHANDLE vmxt, McbCallbackFunc func, void *udata, UINT32 reason)
void MxtCallActivateCallback (MXTHANDLE mxt)
int MxtCallbackAddExt (MXTHANDLE vmxt, McbCallbackFunc func, void *udata, UINT32 reason, INT8 priority)
void MxtCallChangeCallback (MXTHANDLE mxt, UINT32 reason)
void MxtClearPosition (MXTHANDLE mxt)
MXTHANDLE MxtCreate (Widget pwidget, MXTHANDLE(*CreateFunc)(UINT32, void *), UINT32 flags)
MXTHANDLE MxtCreateCrossHair (Widget dawidget, UINT32 flags=0)
MXTHANDLE MxtCreateEArc (Widget dawidget, UINT32 flags=0)
MXTHANDLE MxtCreateEBox (Widget dawidget, UINT32 flags=0)
MXTHANDLE MxtCreateECircle (Widget dawidget, UINT32 flags=0)
MXTHANDLE MxtCreateEEllipse (Widget dawidget, UINT32 flags=0)
MXTHANDLE MxtCreateELine (Widget dawidget, UINT32 flags=0)
MXTHANDLE MxtCreateEMultiPoint (Widget dawidget, UINT32 flags=0)
MXTHANDLE MxtCreateEMultiPolyLine (Widget dawidget, UINT32 flags=0)
MXTHANDLE MxtCreateEPoint (Widget dawidget, UINT32 flags=0)
MXTHANDLE MxtCreateEPolyLine (Widget dawidget, UINT32 flags=0)
MXTHANDLE MxtCreateERegion (Widget dawidget, UINT32 flags=0)
MXTHANDLE MxtCreateERegPoly (Widget dawidget, UINT32 flags=0)
MXTHANDLE MxtCreateETextLabel (Widget dawidget, UINT32 flags=0)
MXTHANDLE MxtCreateSelectPoint (Widget dawidget, UINT32 flags=0)
MXTHANDLE mxtCrossHair (UINT32 flags, void *pwidget)
void MxtDestroy (MXTHANDLE mxt)
void MxtDrawGraphic (MXTHANDLE vmxt, const LRECT2D *rect)
MXTHANDLE mxtEArc (UINT32 flags, void *pwidget)
MXTHANDLE mxtEBox (UINT32 flags, void *pwidget)
MXTHANDLE mxtECircle (UINT32 flags, void *pwidget)
int MxtEditGlobalOptions (Widget pwidget)
MXTHANDLE mxtEEllipse (UINT32 flags, void *pwidget)
MXTHANDLE mxtELine (UINT32 flags, void *pwidget)
MXTHANDLE mxtEMultiPoint (UINT32 flags, void *pwidget)
MXTHANDLE mxtEMultiPolyLine (UINT32 flags, void *pwidget)
void MxtEnableGps (Widget pwidget, int enabled)
MXTHANDLE mxtEPoint (UINT32 flags, void *pwidget)
MXTHANDLE mxtEPolyLine (UINT32 flags, void *pwidget)
MXTHANDLE mxtERegion (UINT32 flags, void *pwidget)
MXTHANDLE mxtERegPoly (UINT32 flags, void *pwidget)
MXTHANDLE mxtETextLabel (UINT32 flags, void *pwidget)
void MxtFreeValues (MXTHANDLE mxt, void *toolvalues)
Widget MxtGenerateManualForm (MXTHANDLE vmxt, Widget parent)
int MxtGenerateRegion (MXTHANDLE vmxt, REGION2D &region, UINT32 flags)
Widget MxtGenerateSpatialForm (MXTHANDLE vmxt, Widget parent)
Widget MxtGenerateToolForm (MXTHANDLE vmxt, Widget parent)
void MxtGetArrowKeyDeltas (MXTHANDLE mxt, double *delta_x, double *delta_y)
int MxtGetBounds (MXTHANDLE mxt, DRECT2D *rect)
MXTHANDLE MxtGetCurrentTool (MXTHANDLE mxt)
UINT32 MxtGetFlags (MXTHANDLE mxt)
void MxtGetGlobalColor (int *UseTool, COLOR *color, COLOR *seccolor, int *LineWidth)
int MxtGetManualMode (MXTHANDLE mxt)
void MxtGetManualParms (MXTHANDLE mxt, MANUALTOOLPARMS *mtparms)
UINT32 MxtGetReasonClass (UINT32 reason)
void MxtGetSnapGrid (MXTHANDLE mxt, SNAPGRIDPARMS *snapgrid)
int MxtGetSnapGridMode (MXTHANDLE mxt)
GC MxtGetToolGC (MXTHANDLE mxt)
int MxtGetToolSize (MXTHANDLE mxt)
void MxtGetTrans2D (MXTHANDLE mxt, TRANS2D_AFFINE &TtoW)
void * MxtGetUserData (MXTHANDLE mxt)
int MxtGetValues (MXTHANDLE mxt, void *toolvalues)
int MxtGetXYDigitizerMode (MXTHANDLE mxt)
int MxtHasPosition (MXTHANDLE mxt)
int MxtInBgUpdateCall (MXTHANDLE mxt)
int MxtIsManaged (MXTHANDLE mxt)
int MxtIsSuspended (MXTHANDLE mxt)
int MxtIsTrackingGps (MXTHANDLE mxt)
void MxtManage (MXTHANDLE mxt)
int MxtManualViewCoordRefSysSet (MXTHANDLE vmxt, const SPATREF::COORDREFSYS &ViewCoordRefSys, bool ForceProj)
void MxtMove (MXTHANDLE mxt, double dx, double dy, XAnyEvent *event, UINT32 flags)
void MxtRaiseWindow (MXTHANDLE vmxt)
void MxtRemoveCallback (MXTHANDLE vmxt, McbCallbackFunc func, void *udata, UINT32 reason)
void MxtResize (MXTHANDLE mxt, double dx, double dy, XAnyEvent *event, UINT32 flags)
void MxtResume (MXTHANDLE mxt)
void MxtRotate (MXTHANDLE mxt, double drot, XAnyEvent *event, UINT32 flags)
void MxtSaveGlobalColor (char *group)
MXTHANDLE mxtSelectPoint (UINT32 flags, void *pwidget)
void MxtSetActivateCallback (MXTHANDLE mxt, void(*CBFunc)(MxtAnyCallbackStruct *, void *), void *udata)
void MxtSetArrowKeyDeltas (MXTHANDLE mxt, double delta_x, double delta_y)
void MxtSetBgUpdateFunc (Widget pwidget, void(*UpdBg)(Widget, DRECT2D *, void *), void *udata)
void MxtSetBounds (MXTHANDLE mxt, DRECT2D *rect, UINT32 flags)
void MxtSetChangeCallback (MXTHANDLE mxt, void(*CBFunc)(MxtAnyCallbackStruct *, void *), void *udata)
int MxtSetDialogPosition (MXTHANDLE vmxt, int NewPosn)
void MxtSetFlags (MXTHANDLE mxt, UINT32 flags)
void MxtSetGlobalColor (Widget parent, int UseTool, const COLOR &color, const COLOR &seccolor, int LineWidth)
void MxtSetGpsSource (MXTHANDLE vmxt, void *vNewSource)
void MxtSetHelpString (MXTHANDLE mxt, char *helpstr)
void MxtSetManualMode (MXTHANDLE mxt, int setflag)
int MxtSetManualParms (MXTHANDLE mxt, MANUALTOOLPARMS *mtparms)
int MxtSetOutputTrans (MXTHANDLE vmxt, const TRANS2D_MAPGEN &trans)
int MxtSetSnapGrid (MXTHANDLE mxt, SNAPGRIDPARMS *snapgrid)
void MxtSetSnapGridMode (MXTHANDLE mxt, int setflag)
void MxtSetToolColor (MXTHANDLE vmxt, COLOR *color, COLOR *seccolor, int LineWidth)
void MxtSetTrans2D (MXTHANDLE mxt, const MAT3X3 OtoD, const MAT3X3 DtoO)
void MxtSetTrans2D (MXTHANDLE mxt, const TRANS2D_AFFINE &TtoW)
void MxtSetUserData (MXTHANDLE mxt, void *udata)
int MxtSetValues (MXTHANDLE mxt, void *toolvalues, int notify)
void MxtSetWindowButtonRow (MXTHANDLE mxt, BUTTONITEM *buttonrow, void *udata)
void MxtSetWindowFormCallback (MXTHANDLE mxt, int(*AddToForm)(Widget, void *), void *udata)
void MxtSetWindowSaveButton (MXTHANDLE mxt, const char *savebutton)
void MxtSetWindowTitle (MXTHANDLE mxt, TEXTID textid)
void MxtSetXORPixel (MXTHANDLE mxt, Pixel pixel)
void MxtSetXYDigitizerMode (MXTHANDLE mxt, int setflag)
void MxtSetXYDtoObjectTrans (MXTHANDLE mxt, TRANSFUNC tfunc, void *udata)
void MxtShear (MXTHANDLE mxt, double dshear, XAnyEvent *event, UINT32 flags)
void MxtSuspend (MXTHANDLE mxt)
void MxtTrackGps (MXTHANDLE vmxt, int track)
void MxtUnmanage (MXTHANDLE mxt)

Detailed Description

Function Prototypes.

:Associate with "Mxt Graphic Tool Functions"

Function Documentation

int MxtAddCallback ( MXTHANDLE  vmxt,
McbCallbackFunc  func,
void *  udata,
UINT32  reason 
)

Add callback to tool.

Valid reasons: The reasons are in reason classes

  • MxtCR_IsBegin
  • MxtCR_IsContinue
  • MxtCR_IsEnd
  • MxtCR_IsOther
  • MxtCR_IsActivate
  • MxtCR_IsDestroy
  • MxtCR_IsOther reasons:
    • MxtCR_NoReason
    • MxtCR_SetValues
    • MxtCR_NewLimits
    • MxtCR_SelectPosition SelectPoint tool sends this on a left button click
    • MxtCR_Manage
    • MxtCR_Unmanage
    • MxtCR_ClearPosition
    • MxtCR_Cancel User pressed 'Cancel' button
  • MxtCR_IsActivate reasons:
    • MxtCR_Activate
  • MxtCR_IsDestroy reasons:
    • MxtCR_Destroy
  • MxtCR_IsBegin reasons:
    • MxtCR_CreateBegin
    • MxtCR_MoveBegin
    • MxtCR_ResizeBegin
    • MxtCR_RotateBegin
    • MxtCR_ShearBegin
    • MxtCR_EditBegin
  • MxtCR_IsContinue reasons:
    • MxtCR_MoveContinue
    • MxtCR_ResizeContinue
    • MxtCR_RotateContinue
    • MxtCR_ShearContinue
    • MxtCR_EditContinue
    • MxtCR_CreateContinue
  • MxtCR_IsEnd reasons:
    • MxtCR_MoveEnd
    • MxtCR_ResizeEnd
    • MxtCR_RotateEnd
    • MxtCR_ShearEnd
    • MxtCR_EditEnd
    • MxtCR_CreateEnd
Parameters:
vmxt Add callback to tool
func Callback function
udata User data passed to func
reason Reason set flags to get callbacks on
void MxtCallActivateCallback ( MXTHANDLE  mxt  ) 

Call "activate" callback for specified tool.

Parameters:
mxt Tool handle
int MxtCallbackAddExt ( MXTHANDLE  vmxt,
McbCallbackFunc  func,
void *  udata,
UINT32  reason,
INT8  priority 
)

Add callback to tool with position determined by priority.

Parameters:
vmxt Add callback to tool
func Callback function
udata User data passed to func
reason Reason set flags to get callbacks on
void MxtCallChangeCallback ( MXTHANDLE  mxt,
UINT32  reason 
)

Call "change" callback for specified tool.

Parameters:
mxt Tool handle
reason Callback reason
void MxtClearPosition ( MXTHANDLE  mxt  ) 

Clear tool position (erasing tool).

This function undraws the tool then clears the tool information. Useful in activate callbacks to simulate adding elements.

Parameters:
mxt Handle returned by MxtCreate()
MXTHANDLE MxtCreate ( Widget  pwidget,
MXTHANDLE(*)(UINT32, void *)  CreateFunc,
UINT32  flags 
)

Create new tool instance.

This function creates a tool handle by calling the appropriate tool create function. It also sets up the default tool position which will be a clear tool (no info). Neither the tool create function nor this function will create the dialog. Any setup of the tool dialog must be done before MxtManage() is called because MxtManage() sets up the dialog. NOTE: Call MxtSetValues() to setup default tool information. List of flags to pass in this function (see MxtSetFlags()).

  • MxtFLAG_EnableManual
  • MxtFLAG_EnableDialog
  • MxtFLAG_EnableXYDig
  • MxtFLAG_EnableSnapGrid Any tool specific flags dealing with dialog management. Eg:
  • MxEPOLYLINE_NoEditZValue
  • MxEPOLYLINE_NoClosePolyB
Parameters:
pwidget Drawing Area widget
flags Function to create specific tool MxtFLAG... flags
MXTHANDLE MxtCreateCrossHair ( Widget  dawidget,
UINT32  flags = 0 
) [inline]

Create crosshair tool.

Returns:
Tool handle (mxthandle) used in other Mxt... functions.

Flags for structure initialization

  • MxCROSSHAIR_BarLength Bar lengths (hlen, vlen) set (not used yet)
  • MxCROSSHAIR_NoBar0 Do not draw 0 degree bar
  • MxCROSSHAIR_NoBar90 Do not draw 90 degree bar
  • MxCROSSHAIR_NoBar180 Do not draw 180 degree bar
  • MxCROSSHAIR_NoBar270 Do not draw 270 degree bar Flags to control behavior
  • MxtFLAG_NoRotate Don't allow rotation
  • MxtFLAG_CanMoveOff Allow tool (center) to move off allowed area
Parameters:
dawidget DrawingArea widget to contain tool
flags MxtFLAG_...
MXTHANDLE MxtCreateEArc ( Widget  dawidget,
UINT32  flags = 0 
) [inline]

Create elastic arc tool.

Returns:
Tool handle (mxthandle) used in other Mxt... functions.

Flags for structure initialization:

  • MxEARC_Rmin Minimum radius set
  • MxEARC_Rmax Maximum radius set

Flags to control behavior:

  • MxtFLAG_NoResize Don't allow arc to be resized
  • MxtFLAG_NoCreate Don't allow new arc to be created
  • MxtFLAG_CanMoveOff Can move arc outside specified position ranges
Parameters:
dawidget DrawingArea widget to contain tool
flags MxtFLAG_...
MXTHANDLE MxtCreateEBox ( Widget  dawidget,
UINT32  flags = 0 
) [inline]

Create elastic box tool.

Returns:
Tool handle (mxthandle) used in other Mxt... functions.

Flags for structure initialization:

  • MxEBOX_Range Range fields (xinit, yinit, xlast, ylast) set
  • MxEBOX_AllCorners All corner locations set
  • MxEBOX_Corner0 Corner 0, size and angle set
  • MxEBOX_Corner1 Corner 1, size and angle set
  • MxEBOX_Corner2 Corner 2, size and angle set
  • MxEBOX_Corner3 Corner 3, size and angle set
  • MxEBOX_Wmin Minimum width set
  • MxEBOX_Hmin Minimum height set
  • MxEBOX_Wmax Maximum width set
  • MxEBOX_Hmax Maximum height set

Flags to control behavior:

  • MxtFLAG_NoResize Don't allow box to be resized
  • MxtFLAG_NoCreate Don't allow new box to be created
  • MxtFLAG_CanMoveOff Can move box outside specified position ranges
  • MxtFLAG_CanRotate Don't allow box to be rotated
  • MxEBOX_Proport Make box proportional
Parameters:
dawidget DrawingArea widget to contain tool
flags MxtFLAG_...
MXTHANDLE MxtCreateECircle ( Widget  dawidget,
UINT32  flags = 0 
) [inline]

Create elastic circle tool instance.

Returns:
Tool handle (mxthandle) used in other Mxt... functions.

Flags for structure initialization:

  • MxECIRCLE_Rmin Minimum radius set
  • MxECIRCLE_Rmax Maximum radius set

Flags to control behavior:

  • MxtFLAG_NoResize Don't allow circle to be resized
  • MxtFLAG_NoCreate Don't allow new circle to be created
  • MxtFLAG_CanMoveOff Can move circle outside specified position ranges
Parameters:
dawidget DrawingArea widget to contain tool
flags MxtFLAG_...
MXTHANDLE MxtCreateEEllipse ( Widget  dawidget,
UINT32  flags = 0 
) [inline]

Create elastic ellipse tool.

Returns:
Tool handle (mxthandle) used in other Mxt... functions.

Flags for structure initialization:

  • MxEELLIPSE_Rmin Minimum radius set
  • MxEELLIPSE_Rmax Maximum radius set

Flags to control behavior

  • MxtFLAG_NoResize Don't allow ellipse to be resized
  • MxtFLAG_NoCreate Don't allow new ellipse to be created
  • MxtFLAG_CanMoveOff Can move ellipse outside specified position ranges
Parameters:
dawidget DrawingArea widget to contain tool
flags MxtFLAG_...
MXTHANDLE MxtCreateELine ( Widget  dawidget,
UINT32  flags = 0 
) [inline]

Create elastic line tool instance.

Returns:
Tool handle (mxthandle) used in other Mxt... functions.

Flags to control behavior

  • MxtFLAG_NoResize Don't allow line to be resized (length changed)
  • MxtFLAG_NoCreate Don't allow new line to be created
  • MxtFLAG_CanMoveOff Can move line outside specified position ranges
Parameters:
dawidget DrawingArea widget to contain tool
flags MxtFLAG_...
MXTHANDLE MxtCreateEMultiPoint ( Widget  dawidget,
UINT32  flags = 0 
) [inline]

Create elastic multi-point tool.

Returns:
Tool handle (mxthandle) used in other Mxt... functions.

Flags to control behavior

  • MxEMULITPOINT_NoEditZValue Don't let user edit z value
  • MxEMULTIPOINT_SinglePointOnly Don't allow multi-point editing
Parameters:
dawidget DrawingArea widget to contain tool
flags MxtFLAG_...
MXTHANDLE MxtCreateEMultiPolyLine ( Widget  dawidget,
UINT32  flags = 0 
) [inline]

Create elastic multi-line/polygon tool.

Returns:
Tool handle (mxthandle) used in other Mxt... functions.

Flags to control behavior:

  • MxEMULTILINE_EditPoly Edit polygon
  • MxEMULTILINE_EnableResetB Enable tool reset button
  • MxEMULTILINE_NoClearB Don't show clear button
  • MxEMULTILINE_NoClosePolyB Don't show close poly button
  • MxEMULTILINE_UseCurveFit Edit a curve fit
  • MxEMULTILINE_CanChgLinePolyMode User can toggle between polygon and line modes
  • MxEMULTILINE_NoEditZValue Don't let user edit z value
  • MxEMULTILINE_SingleLineOnly Don't allow multi-line editing
Parameters:
dawidget DrawingArea widget to contain tool
flags MxtFLAG_...
MXTHANDLE MxtCreateEPoint ( Widget  dawidget,
UINT32  flags = 0 
) [inline]

Create "point" tool.

Returns:
Tool handle (mxthandle) used in other Mxt... functions.
Parameters:
dawidget DrawingArea widget to contain tool
flags MxtFLAG_...
MXTHANDLE MxtCreateEPolyLine ( Widget  dawidget,
UINT32  flags = 0 
) [inline]

Create elastic "polyline/polygon" tool.

Returns:
Tool handle (mxthandle) used in other Mxt... functions.

Flags to control behavior

  • MxtFLAG_NoResize Don't allow line to be resized (length changed)
  • MxtFLAG_NoCreate Don't allow new line to be created
  • MxtFLAG_CanMoveOff Can move line outside specified position ranges
  • MxEPOLYLINE_EditPoly Edit polygon
  • MxEPOLYLINE_UseSnapCoord Use the snap coord callback reason to allow snapping vertices
  • MxEPOLYLINE_EnableResetB Enable tool reset button
  • MxEPOLYLINE_NoClosePolyB Don't show close poly button
  • MxEPOLYLINE_UseCurveFit Edit a curve fit
  • MxEPOLYLINE_CanChgLinePolyMode User can toggle between polygon and line modes
  • MxEPOLYLINE_NoEditZValue Don't let user edit z value
Parameters:
dawidget DrawingArea widget to contain tool
flags MxtFLAG_...
MXTHANDLE MxtCreateERegion ( Widget  dawidget,
UINT32  flags = 0 
) [inline]

Create "region" display tool.

Tool handle (mxthandle) used in other Mxt... functions.

Flags to control behavior:

  • MxEREGION_NoMove
Parameters:
dawidget DrawingArea widget to contain tool
flags MxtFLAG_...
MXTHANDLE MxtCreateERegPoly ( Widget  dawidget,
UINT32  flags = 0 
) [inline]

Create elastic "regular polygon" tool.

Returns:
Tool handle (mxthandle) used in other Mxt... functions.

Flags to control behavior:

  • MxEREGPOLY_Rmin
  • MxEREGPOLY_Rmax
Parameters:
dawidget DrawingArea widget to contain tool
flags MxtFLAG_...
MXTHANDLE MxtCreateETextLabel ( Widget  dawidget,
UINT32  flags = 0 
) [inline]

Create elastic "text label" tool.

Returns:
Tool handle (mxthandle) used in other Mxt... functions.

Flags to control behavior

  • MxtFLAG_NoResize Don't allow line to be resized (length changed)
  • MxtFLAG_NoCreate Don't allow new line to be created
  • MxtFLAG_CanMoveOff Can move line outside specified position ranges
  • MxETEXTLABEL_NoLeaderLines Do not allow editing of leader lines
  • MxETEXTLABEL_NoAdvanced Do not allow advanced style button
  • MxETEXTLABEL_NoBaselineEdit Do not allow baseline to be edited
  • MxETEXTLABEL_NoStylePanel Do not allow the style panel to be created
Parameters:
dawidget DrawingArea widget to contain tool
flags MxtFLAG_...
MXTHANDLE MxtCreateSelectPoint ( Widget  dawidget,
UINT32  flags = 0 
) [inline]

Create point selection tool instance.

Returns:
Tool handle (mxthandle) used in other Mxt... functions.
Parameters:
dawidget DrawingArea widget to contain tool
flags MxtFLAG_...
MXTHANDLE mxtCrossHair ( UINT32  flags,
void *  pwidget 
)

Create an instance of a rotatable crosshair tool.

void MxtDestroy ( MXTHANDLE  mxt  ) 

Destroy previously created tool instance.

This function does basic cleanup of the tool. It will unmanage the tool if not done so already. It will also remove the tool tag string to keep the tool pointer from being used as a tool. It will free the pointer.

Parameters:
mxt Tool handle
void MxtDrawGraphic ( MXTHANDLE  vmxt,
const LRECT2D *  rect 
)

Draw tool graphic.

Parameters:
vmxt Handle returned by MxtCreate()
rect Area to draw into, NULL for the whole area
MXTHANDLE mxtEArc ( UINT32  flags,
void *  pwidget 
)

Create an instance of an elastic arc tool.

3/4 Done, Need bound checking fixed.

MXTHANDLE mxtEBox ( UINT32  flags,
void *  pwidget 
)

Create an instance of an elastic box tool.

MXTHANDLE mxtECircle ( UINT32  flags,
void *  pwidget 
)

Create an instance of an elastic circle tool.

3/4 Done, Need bound checking fixed.

int MxtEditGlobalOptions ( Widget  pwidget  ) 

Display dialog allowing user to edit global tool colors and width.

Returns:
0 if user changed values, EUserCancel if cancelled.

This will automatically update the process global tool settings and save to the Ini file. The application should refresh all active tools if possible using MxtSetToolColor() for each DrawingArea's current tool.

Parameters:
pwidget Parent for dialog
MXTHANDLE mxtEEllipse ( UINT32  flags,
void *  pwidget 
)

Create an instance of an elastic ellipse tool.

MXTHANDLE mxtELine ( UINT32  flags,
void *  pwidget 
)

Create an instance of an elastic box tool.

MXTHANDLE mxtEMultiPoint ( UINT32  flags,
void *  pwidget 
)

Create an instance of an elastic point tool.

MXTHANDLE mxtEMultiPolyLine ( UINT32  flags,
void *  pwidget 
)

Create multi elastic polyline tool.

void MxtEnableGps ( Widget  pwidget,
int  enabled 
)

GPS input is enabled for this view.

Parameters:
pwidget Drawing Area widget
enabled TRUE if GPS is set for this drawing area
MXTHANDLE mxtEPoint ( UINT32  flags,
void *  pwidget 
)

Create an instance of an elastic point tool.

MXTHANDLE mxtEPolyLine ( UINT32  flags,
void *  pwidget 
)

Create elastic polyline tool.

MXTHANDLE mxtERegion ( UINT32  flags,
void *  pwidget 
)

Create elastic region tool.

MXTHANDLE mxtERegPoly ( UINT32  flags,
void *  pwidget 
)

Create an instance of an elastic regpoly tool.

MXTHANDLE mxtETextLabel ( UINT32  flags,
void *  pwidget 
)

Create an instance of an elastic text label tool.

void MxtFreeValues ( MXTHANDLE  mxt,
void *  toolvalues 
)

Free tool structure internal data storage (Eg.

EPOLYLINEINFO).

This function frees any allocated data associated with the tool structure. Eg. the point buffer for line data. It will not free the data associated with a change callback.

Parameters:
mxt Handle returned by MxtCreate()
toolvalues Pointer to tool structure
Widget MxtGenerateManualForm ( MXTHANDLE  vmxt,
Widget  parent 
)

Generate manual form for tool if it exists.

Returns:
Form widget or NULL if non-existant.

NOTE: Must specify MxtFLAG_NoDialog to use this function.

Parameters:
vmxt Handle returned by MxtCreate()
parent Parent for main tool form, assumed to be a RowColumn
int MxtGenerateRegion ( MXTHANDLE  vmxt,
REGION2D &  region,
UINT32  flags 
)

Generate a region form the tool if supported.

Returns:
1 if a region is generated, 0 if not, < 0 Error.

This function will call MregionInit(). If an error occurs, MregionFree() is called.

Parameters:
vmxt Handle returned by MxtCreate()
region The region to fill in
flags May be used at some point
Widget MxtGenerateSpatialForm ( MXTHANDLE  vmxt,
Widget  parent 
)

Generate spatial form for tool if it exists.

Returns:
Form widget or NULL if non-existant.

NOTE: Must specify MxtFLAG_NoDialog to use this function.

Parameters:
vmxt Handle returned by MxtCreate()
parent Parent for main tool form, assumed to be a RowColumn
Widget MxtGenerateToolForm ( MXTHANDLE  vmxt,
Widget  parent 
)

Generate main tool form for tool if it exists.

Returns:
Form widget or NULL if non-existant.

NOTE: Must specify MxtFLAG_NoDialog to use this function.

Parameters:
vmxt Handle returned by MxtCreate()
parent Parent for main tool form, assumed to be a RowColumn
void MxtGetArrowKeyDeltas ( MXTHANDLE  mxt,
double *  delta_x,
double *  delta_y 
)

Return current arrow key delta values.

This function gets the amount of movement for hitting arrow keys in object coordinates (i.e. deltas).

Parameters:
mxt Handle returned by MxtCreate()
delta_x Length to move in X direction (RETURNED)
delta_y Length to move in Y direction (RETURNED)
int MxtGetBounds ( MXTHANDLE  mxt,
DRECT2D *  rect 
)

Return current tool boundary rectangle.

Returns:
1 - Tool has boundaries, 0 - Tool can move off drawable.

This function returns the boundaries for the tool.

Parameters:
mxt Handle returned by MxtCreate()
rect Rect containing coordinates to bound, tool coords
MXTHANDLE MxtGetCurrentTool ( MXTHANDLE  mxt  ) 

Return currently active tool handle.

Returns:
Handle to the currently active tool or NULL if no tool is active.
Parameters:
mxt Can either be a MXTHANDLE or the parent widget of the tool
UINT32 MxtGetFlags ( MXTHANDLE  mxt  ) 

Return current tool flags.

This function returns the current flags set in the tool. You should call this function to get the current flags, set or unset certain flags, then call MxtSetFlags() to set the flags.

void MxtGetGlobalColor ( int *  UseTool,
COLOR *  color,
COLOR *  seccolor,
int *  LineWidth 
)

Return global colors set for tools in the application.

Parameters:
UseTool Not used, can pass NULL
color Primary tool color RETURNED
seccolor Secondary tool color RETURNED
LineWidth Tool line width RETURNED
int MxtGetManualMode ( MXTHANDLE  mxt  ) 

Return status of manual edit dialog (on/off).

Returns:
TRUE if the manual editor is in use, FALSE if not.

This function returns the status of the manual editor mode.

Parameters:
mxt Handle returned by MxtCreate()
void MxtGetManualParms ( MXTHANDLE  mxt,
MANUALTOOLPARMS *  mtparms 
)

Return current tool manual parameter settings.

This function retrieves the manual tool editing information within the tool.

Parameters:
mxt Handle returned by MxtCreate()
mtparms Pointer to manual tool editing parameters
UINT32 MxtGetReasonClass ( UINT32  reason  )  [inline]

Return "reason class" for specified callback "reason".

Returns:
Reason class or 0 if reason is invalid.

Class Description

  • MxtCR_IsOther Reason not in one of following classes
  • MxtCR_IsActivate Reason is an activate reason
  • MxtCR_IsDestroy Reason is an destroy reason
  • MxtCR_IsBegin "Begin change"
  • MxtCR_IsContinue "Continue change"
  • MxtCR_IsEnd "End change"
Parameters:
reason Callback reason (usually from cbdata->reason)
void MxtGetSnapGrid ( MXTHANDLE  mxt,
SNAPGRIDPARMS *  snapgrid 
)

Return current tool snap grid settings.

This function retrieves the snap grid information from the tool.

Parameters:
mxt Handle returned by MxtCreate()
snapgrid Pointer to snap grid parameters
int MxtGetSnapGridMode ( MXTHANDLE  mxt  ) 

Return current status of tool snap grid (on/off).

Returns:
TRUE if the snap grid is in use, FALSE if not.

This function returns the status of the snap grid mode.

Parameters:
mxt Handle returned by MxtCreate()
GC MxtGetToolGC ( MXTHANDLE  mxt  ) 

Return the GC (X drawing parameter handle) of the tool.

int MxtGetToolSize ( MXTHANDLE  mxt  ) 

Get size of tool structure (Eg.

sizeof(EBOXINFO)).

Returns the structure size of the tool.

Parameters:
mxt Handle returned by MxtCreate()
void MxtGetTrans2D ( MXTHANDLE  mxt,
TRANS2D_AFFINE &  TtoW 
)

Get tool/window transformation.

Parameters:
mxt Tool handle
TtoW Tool-to-Window transformation returned
void* MxtGetUserData ( MXTHANDLE  mxt  ) 

Get "userdata" resource for a tool.

Returns the pointer to the data associated with the tool. Set by MxtSetUserData().

Parameters:
mxt Handle returned by MxtCreate()
int MxtGetValues ( MXTHANDLE  mxt,
void *  toolvalues 
)

Get current tool-specific "values" structure.

The tool makes a copy of the information and places it in the toolvalues structure. No direct access of the tool data is allowed. You must free any allocated fields in the tool structure using MxtFreeValues(). Definitions of tool structures is with the respective "Create" function for that tool. Eg: MxtCreateEBox has a definition of an EBOXINFO structure.

Parameters:
mxt Handle returned by MxtCreate()
toolvalues Pointer to tool structure to copy into
int MxtGetXYDigitizerMode ( MXTHANDLE  mxt  ) 

Return current status of X-Y Digitizer (on/off).

Returns:
TRUE if the digitizer is in use, FALSE if not.
Parameters:
mxt Handle returned by MxtCreate()
int MxtHasPosition ( MXTHANDLE  mxt  ) 

Return "position" status of tool.

Returns:
TRUE if tool has graphic position set.
Parameters:
mxt Handle returned by MxtCreate()
int MxtInBgUpdateCall ( MXTHANDLE  mxt  ) 

Inform caller if we are in an update background call.

int MxtIsManaged ( MXTHANDLE  mxt  ) 

Return "managed" status of tool.

Returns:
TRUE if tool has been managed. Set by MxtManage().
Parameters:
mxt Handle returned by MxtCreate()
int MxtIsSuspended ( MXTHANDLE  mxt  ) 

Return "suspended" status of tool.

Returns:
TRUE if tool has been suspended. Set by MxtSuspend().
Parameters:
mxt Handle returned by MxtCreate()
int MxtIsTrackingGps ( MXTHANDLE  mxt  ) 

Check to see if GPS tracking is on.

void MxtManage ( MXTHANDLE  mxt  ) 

Make tool instance active, allowing user to modify it.

This function creates the GC and tool dialog. It also sets up specific event handlers to check for certain events, displays the tool if the tool has info, and sets up XYDigitizer stuff. This should be called only if changing from another tool to this one, not to hide the tool if drawing on the drawable. Use MxtSuspend/MxtResume() to accomplish tool graphic hiding.

Parameters:
mxt Handle returned by MxtCreate()
int MxtManualViewCoordRefSysSet ( MXTHANDLE  vmxt,
const SPATREF::COORDREFSYS &  ViewCoordRefSys,
bool  ForceProj 
)

Set view projection of manual tool section.

Parameters:
vmxt Handle returned by MxtCreate()
ViewCoordRefSys Projection information
ForceProj Force the projection even if the user has already changed it
void MxtMove ( MXTHANDLE  mxt,
double  dx,
double  dy,
XAnyEvent *  event,
UINT32  flags 
)

Move tool under program control.

This function shifts the tool values. This function is optionally supported by the tool.

Adjustment flags:

  • MxtADJUST_Relative Make adjustments relative to current position (default)
  • MxtADJUST_Absolute Move to new absolute coordinates specified
  • MxtADJUST_ToolCoords Make adjustments in "tool" coordinates (default)
  • MxtADJUST_ScreenCoords Make adjustments in screen coordinates
  • MxtADJUST_Notify Call ChangeCallback after adjustments made
Parameters:
mxt Handle returned by MxtCreate()
dx Delta x
dy Delta y
event Event that caused the move, can be NULL
flags MxtADJUST... flags
void MxtRaiseWindow ( MXTHANDLE  vmxt  ) 

Raise tool dialog window to the foreground.

Parameters:
vmxt Handle returned by MxtCreate()
void MxtRemoveCallback ( MXTHANDLE  vmxt,
McbCallbackFunc  func,
void *  udata,
UINT32  reason 
)

Remove callback from tool.

void MxtResize ( MXTHANDLE  mxt,
double  dx,
double  dy,
XAnyEvent *  event,
UINT32  flags 
)

Resize tool under program control.

This function scales the tool values. This function is optionally supported by the tool.

Adjustment flags:

  • MxtADJUST_Relative Make adjustments relative to current size (default)
  • MxtADJUST_Absolute Change to new size specified
  • MxtADJUST_ToolCoords Make adjustments in "tool" coordinates (default)
  • MxtADJUST_ScreenCoords Make adjustments in screen coordinates
  • MxtADJUST_Notify Call ChangeCallback after adjustments made
Parameters:
mxt Handle returned by MxtCreate()
dx Scale x
dy Scale y
event Event that caused the move, can be NULL
flags MxtADJUST... flags
void MxtResume ( MXTHANDLE  mxt  ) 

Resume (redraw graphic if possible) the tool.

This function resumes the tool from a MxtSuspend().

Parameters:
mxt Handle returned by MxtCreate()
void MxtRotate ( MXTHANDLE  mxt,
double  drot,
XAnyEvent *  event,
UINT32  flags 
)

Rotate tool under program control.

This function rotates the tool values. This function is optionally supported by the tool. Rotation angle is in RADIANS.

Adjustment flags:

  • MxtADJUST_Relative Make adjustments relative to current rotation angle (default)
  • MxtADJUST_Absolute Change to new rotation angle specified
  • MxtADJUST_ToolCoords Make adjustments in "tool" coordinates (default)
  • MxtADJUST_ScreenCoords Make adjustments in screen coordinates
  • MxtADJUST_Notify Call ChangeCallback after adjustments made
void MxtSaveGlobalColor ( char *  group  ) 

Save global color setting to tntproc.ini file.

MXTHANDLE mxtSelectPoint ( UINT32  flags,
void *  pwidget 
)

Create an instance of point selection tool.

void MxtSetActivateCallback ( MXTHANDLE  mxt,
void(*)(MxtAnyCallbackStruct *, void *)  CBFunc,
void *  udata 
)

Set function to be called when an "activate" event occurs.

This function sets the activate callback for when the user presses return, right mouse button, or if a dialog exists, "Save" button is pressed. Most other Mxt...() functions are callable from this callback, except: MxtDestroy(), MxtManage(), and MxtUnmanage().

Callback "reasons" MxtCR_Activate An activate event occured

An "activate" event occurs when the user presses Button3 (usually right button) or <ENTER> while the parent widget has keyboard focus.

void MxtSetArrowKeyDeltas ( MXTHANDLE  mxt,
double  delta_x,
double  delta_y 
)

Set deltas for arrow key handling.

This function sets the amount of movement for hitting arrow keys in object coordinates (i.e. deltas).

Parameters:
mxt Handle returned by MxtCreate()
delta_x Length to move in X direction
delta_y Length to move in Y direction
void MxtSetBgUpdateFunc ( Widget  pwidget,
void(*)(Widget, DRECT2D *, void *)  UpdBg,
void *  udata 
)

Set the update background function.

void MxtSetBounds ( MXTHANDLE  mxt,
DRECT2D *  rect,
UINT32  flags 
)

Set bounding rectangle for the tool.

This function sets boundaries for the tool. This function will recognize a MxtFLAG_CanMoveOff flag.

List of flags to pass in this function.

  • MxtBOUND_Xmin
  • MxtBOUND_Ymin
  • MxtBOUND_Xmax
  • MxtBOUND_Ymax
  • MxtBOUND_FullRect = (MxtBOUND_Xmin|MxtBOUND_Ymin|MxtBOUND_Xmax|MxtBOUND_Ymax) MxtFLAG_CanMoveOff
Parameters:
mxt Handle returned by MxtCreate()
rect Rect containing coordinates to bound, object coords
flags Which values are set to bound
void MxtSetChangeCallback ( MXTHANDLE  mxt,
void(*)(MxtAnyCallbackStruct *, void *)  CBFunc,
void *  udata 
)

Set function to be called when any tool position values are changed.

This function sets the change callback for the program to get any changes done to the tool. You are allowed to set multiple callbacks for the tool and can be removed via a call to MxtRemoveChangeCallback().

Callback "reasons":

  • MxtCR_NoReason For the hell of it
  • MxtCR_Activate An activate event occured
  • MxtCR_SetValues MxtSetValues() function was invoked
  • MxtCR_NewLimits New limits have been set which affected tool position
  • MxtCR_SelectPosition The selection tool has selected a position
  • MxtCR_Manage Tool has been managed
  • MxtCR_Unmanage Tool has been unmanaged
  • MxtCR_ClearPosition Tool internal data is cleared
  • MxtCR_MoveBegin Move operation beginning
  • MxtCR_MoveContinue Move operation continuing
  • MxtCR_MoveEnd Move operation has ended
  • MxtCR_ResizeBegin Resize operation beginning
  • MxtCR_ResizeContinue Resize operation continuing
  • MxtCR_ResizeEnd Resize operation has ended
  • MxtCR_RotateBegin Rotate operation beginning
  • MxtCR_RotateContinue Rotate operation continuing
  • MxtCR_RotateEnd Rotate operation has ended
  • MxtCR_ShearBegin Shear operation beginning
  • MxtCR_ShearContinue Shear operation continuing
  • MxtCR_ShearEnd Shear operation has ended
  • MxtCR_EditBegin General editing operation beginning
  • MxtCR_EditContinue General editing operation continuing
  • MxtCR_EditEnd General editing operation has ended
  • MxtCR_CreateBegin User is "creating" new "tool"
  • MxtCR_CreateContinue User is in the process of "creating" new "tool"
  • MxtCR_CreateEnd User is done "creating" new "tool"
Parameters:
mxt Handle returned by MxtCreate()
udata Change callback function
int MxtSetDialogPosition ( MXTHANDLE  vmxt,
int  NewPosn 
)

Set the position of the dialog.

void MxtSetFlags ( MXTHANDLE  mxt,
UINT32  flags 
)

Set flags for the tool.

This function REPLACES the current flags set in the tool. You should call MxtGetFlags() to get the current flags, set or unset certain flags, then call this function to set the flags.

NOTE: Certain dialog management flags will work only if set before a call to MxtManage(). The best place to pass them is in MxtCreate(). The flags in question are listed with MxtCreate().

Parameters:
mxt Handle returned by MxtCreate()
flags Tool flags
void MxtSetGlobalColor ( Widget  parent,
int  UseTool,
const COLOR &  color,
const COLOR &  seccolor,
int  LineWidth 
)

Set color and width for all tools in the application.

Parameters:
parent Parent widget that tools are attached to
UseTool Turn on solid tools if 1, else 0
color Color to use
LineWidth Line width to use
void MxtSetGpsSource ( MXTHANDLE  vmxt,
void *  vNewSource 
)

Set tool GPS source.

Parameters:
vmxt Handle returned by MxtCreate()
vNewSource GPS Source handle, NULL to turn off
void MxtSetHelpString ( MXTHANDLE  mxt,
char *  helpstr 
)

Set help string for tool dialog, overrides default help.

This function replaces the default help string with the one passed in. For correctness, the help that is to replace this help needs to have a SEE ALSO to the default help for the tool.

This function must be called before MxtManage().

Parameters:
mxt Handle returned by MxtCreate()
helpstr Help string to replace default string
void MxtSetManualMode ( MXTHANDLE  mxt,
int  setflag 
)

Set status of manual editing dialog (on/off).

This function turns on/off the manual editor mode of the tool. If the tool has a dialog and the correct flag is set, the tool dialog will have a manual editor button on the dialog. If not, this function must be used to envoke manual editor mode. NOTE: The manual editor doubles as a tool coordinate reporter. The update of the manual editor is handled by the tool itself. The tool management layer only handles opening, closing and managing of the manual dialog.

Parameters:
mxt Handle returned by MxtCreate()
setflag On/Off
int MxtSetManualParms ( MXTHANDLE  mxt,
MANUALTOOLPARMS *  mtparms 
)

Set manual editing parameters for the tool.

Returns:
0 or EBadFuncParm for the manual editing parameters being invalid.

This function sets the manual tool editing information within the tool.

Parameters:
mxt Handle returned by MxtCreate()
mtparms Pointer to manual tool editing parameters
int MxtSetOutputTrans ( MXTHANDLE  vmxt,
const TRANS2D_MAPGEN &  trans 
)

Set output transparm for manual entry and GPS.

This function sets the internal transparms for both the GPS and manual entry which describes the Map projection to tool transformation.

Parameters:
vmxt Handle returned by MxtCreate()
int MxtSetSnapGrid ( MXTHANDLE  mxt,
SNAPGRIDPARMS *  snapgrid 
)

Set snap grid parameters for the tool.

Returns:
0 or EBadFuncParm for the snap grid info being invalid.

This function sets the snap grid information within the tool.

Parameters:
mxt Handle returned by MxtCreate()
snapgrid Pointer to snap grid parameters
void MxtSetSnapGridMode ( MXTHANDLE  mxt,
int  setflag 
)

Set status of snap grid (on/off).

This function turns on/off the snap grid mode of the tool. If the tool has a dialog and the correct flag is set, the tool dialog will have a snap grid toggle button on the dialog. If not, this function must be used to toggle snap grid mode.

Parameters:
mxt Handle returned by MxtCreate()
setflag On/Off
void MxtSetToolColor ( MXTHANDLE  vmxt,
COLOR *  color,
COLOR *  seccolor,
int  LineWidth 
)

Set color and width for the tool only.

Parameters:
vmxt Handle returned by MxtCreate()
color Primary color to use, NULL to set to global primary color
seccolor Secondary color to use, NULL to set to global secondary color
LineWidth Line width to use, -1 to set to global line width
void MxtSetTrans2D ( MXTHANDLE  mxt,
const MAT3X3  OtoD,
const MAT3X3  DtoO 
)

Set tool/window transformation.

NOTE: If this function is not called, the tool will assume a one-one mapping of the coordinates.

Parameters:
mxt Handle returned by MxtCreate()
OtoD Tool to Drawable transform
DtoO Drawable to Tool transform
void MxtSetTrans2D ( MXTHANDLE  mxt,
const TRANS2D_AFFINE &  TtoW 
)

Set tool/window transformation.

NOTE: If this function is not called, the tool will assume a one-one mapping of the coordinates.

Parameters:
mxt Handle returned by MxtCreate()
TtoW Tool-to-Window transformation
void MxtSetUserData ( MXTHANDLE  mxt,
void *  udata 
)

Set "userdata" resource for a tool.

Parameters:
mxt Handle returned by MxtCreate()
udata User data to set
int MxtSetValues ( MXTHANDLE  mxt,
void *  toolvalues,
int  notify 
)

Set tool-specific "values" structure.

The tool makes a copy of toolvalues and correctly sets up its internal information. A error is returned if the tool data is invalid.

NOTE: If specific tool and/or generic flags need to be set before setting the tool, use MxtSetFlags() before calling this function.

Definitions of tool structures is with the respective "Create" function for that tool. Eg: MxtCreateEBox has a definition of an EBOXINFO structure.

Parameters:
mxt Handle returned by MxtCreate()
toolvalues Pointer to tool structure to copy from
notify Call change callback if one is assigned
void MxtSetWindowButtonRow ( MXTHANDLE  mxt,
BUTTONITEM *  buttonrow,
void *  udata 
)

Set edit dialog button row instead of default.

This function must be called before MxtManage(). The MXTHANDLE is passed as the callback data. The passed in udata is set up as userdata on the widget.

Parameters:
mxt Handle returned by MxtCreate()
buttonrow List of buttons to replace default buttonrow
udata User data passed to MxCreateButtonRow as userdata
void MxtSetWindowFormCallback ( MXTHANDLE  mxt,
int(*)(Widget, void *)  AddToForm,
void *  udata 
)

Set function to allow programmer addition to edit dialog.

This function must be called before MxtManage().

Parameters:
mxt Handle returned by MxtCreate()
udata Function to create user specified form User data passed to AddToForm()
void MxtSetWindowSaveButton ( MXTHANDLE  mxt,
const char *  savebutton 
)

Set edit dialog "save" button to somethine else.

This function sets the "save" button to another string. This function must be called before MxtManage().

Parameters:
mxt Handle returned by MxtCreate()
savebutton String that replaces "save" in dialog
void MxtSetWindowTitle ( MXTHANDLE  mxt,
TEXTID  textid 
)

Set title for tool control window (if any).

This function looks up the window title using the TEXTID If not found, it will use the default. This function must be called before MxtManage().

Parameters:
mxt Handle returned by MxtCreate()
void MxtSetXORPixel ( MXTHANDLE  mxt,
Pixel  pixel 
)

Set pixel to XOR with the drawable.

This function sets the XOR pixel to use in the GC to draw with. Usually passed the background pixel of the drawable to handle different hued backgrounds. This function must be called before MxtManage().

Parameters:
mxt Handle returned by MxtCreate()
pixel Pixel to use to XOR with
void MxtSetXYDigitizerMode ( MXTHANDLE  mxt,
int  setflag 
)

Set status of X-Y Digitizer (on/off).

This function turns on/off the digitizer mode of the tool. If the tool has a dialog and the correct flag is set, the tool dialog will have a X-Y Digitizer toggle button on the dialog. If not, this function must be used to toggle digitizer mode.

Parameters:
mxt Handle returned by MxtCreate()
setflag On/Off
void MxtSetXYDtoObjectTrans ( MXTHANDLE  mxt,
TRANSFUNC  tfunc,
void *  udata 
)

Set translation function from X-Y Digitizer to tool coordinates.

This function sets the digitizer to object translation function. If not set, the tool assumes a 1-1 mapping of the X-Y Digitizer coordinates to object coordinates (i.e. trans2dinit()).

Parameters:
mxt Handle returned by MxtCreate()
tfunc X-Y Digitizer to Object coordinates
udata User data passed to tfunc()
void MxtShear ( MXTHANDLE  mxt,
double  dshear,
XAnyEvent *  event,
UINT32  flags 
)

Change tool shear angle under program control.

This function shears the tool values. This function is optionally supported by the tool.

Adjustment flags:

  • MxtADJUST_Relative Make adjustments relative to current shear angle (default)
  • MxtADJUST_Absolute Change to new shear angle specified
  • MxtADJUST_ToolCoords Make adjustments in "tool" coordinates (default)
  • MxtADJUST_ScreenCoords Make adjustments in screen coordinates
  • MxtADJUST_Notify Call ChangeCallback after adjustments made
Parameters:
mxt Handle returned by MxtCreate()
dshear Shear angle
event Event that caused the move, can be NULL
flags MxtADJUST... flags
void MxtSuspend ( MXTHANDLE  mxt  ) 

Suspend (undraw graphic if possible) the tool.

This function suspends the tool (undraws the tool graphic) while manipulation of the drawing area is accomplished. It will not affect any tool dialogs that are shown.

Parameters:
mxt Handle returned by MxtCreate()
void MxtTrackGps ( MXTHANDLE  vmxt,
int  track 
)

Turn on GPS tracking.

void MxtUnmanage ( MXTHANDLE  mxt  ) 

Make tool instance inactive, erasing tool if necessary.

This function removes the dialog and GC and event handlers, cleans up digitizer setup and undraws the tool if drawn. This should be called only if changing from another tool to this one, not to hide the tool if drawing on the drawable. Use MxtSuspend/MxtResume() to accomplish tool graphic hiding.

Parameters:
mxt Handle returned by MxtCreate()
Generated on Sun Oct 7 21:33:03 2012 for TNTsdk 2012 by  doxygen 1.6.1