LAnnAutomation::GetTool

#include "ltwrappr.h"

virtual L_UINT LAnnAutomation::GetTool()

Gets the default tool, which is maintained by the automation object.

Returns

The value of the constant for the selected tool.  Possible values are:

Value

Meaning

ANNTOOL_SELECT

[0] Selection pointer

ANNTOOL_LINE

[1] Line

ANNTOOL_RECT

[2] Rectangle

ANNTOOL_ELLIPSE

[3] Ellipse

ANNTOOL_POLYLINE

[4] Polyline

ANNTOOL_POLYGON

[5] Polygon

ANNTOOL_POINTER

[6] Pointer

ANNTOOL_FREEHAND

[7] Freehand line

ANNTOOL_HILITE

[8] Highlight

ANNTOOL_REDACT

[9] Redaction

ANNTOOL_TEXT

[10] Text

ANNTOOL_NOTE

[11] Note

ANNTOOL_STAMP

[12] Stamp

ANNTOOL_BUTTON

[13] Button

ANNTOOL_HOTSPOT

[14] Hot spot

ANNTOOL_AUDIO

[15] Audio clip

ANNTOOL_RULER

[16] Ruler clip

ANNTOOL_CROSSPRODUCT

[17] Cross product

ANNTOOL_POINT

[18] Point

ANNTOOL_PROTRACTOR

[19] Protractor

ANNTOOL_VIDEO

[20] Video

ANNTOOL_PUSHPIN

[21] Pushpin

ANNTOOL_FREEHANDHOTSPOT

[22] Freehand Hot Spot

ANNTOOL_STAMP_FIRST

[23] First rubber stamp

ANNTOOL_STAMP_APPROVED

[23] Approved rubber stamp

ANNTOOL_STAMP_ASSIGNED

[24] Assigned rubber stamp

ANNTOOL_STAMP_CHECKED

[25] Checked rubber stamp

ANNTOOL_STAMP_CLATPRV

[26] Client Attorney Privilege rubber stamp

ANNTOOL_STAMP_COPY

[27] Copy rubber stamp

ANNTOOL_STAMP_DRAFT

[28] Draft rubber stamp

ANNTOOL_STAMP_EXTENDED

[29] Extended rubber stamp

ANNTOOL_STAMP_FAX

[30] Fax rubber stamp

ANNTOOL_STAMP_FAXED

[31] Faxed rubber stamp

ANNTOOL_STAMP_IMPORTANT

[32] Important rubber stamp

ANNTOOL_STAMP_INVOICE

[33] Invoice rubber stamp

ANNTOOL_STAMP_NOTICE

[34] Notice rubber stamp

ANNTOOL_STAMP_OFFICIAL

[35] Official rubber stamp

ANNTOOL_STAMP_ONFILE

[36] Onfile rubber stamp

ANNTOOL_STAMP_PAID

[37] Paid rubber stamp

ANNTOOL_STAMP_PASSED

[38] Passed rubber stamp

ANNTOOL_STAMP_PENDING

[39] Pending rubber stamp

ANNTOOL_STAMP_PROCESSED

[40] Processed rubber stamp

ANNTOOL_STAMP_RECEIVED

[41] Received rubber stamp

ANNTOOL_STAMP_REJECTED

[42] Rejected rubber stamp

ANNTOOL_STAMP_RELEASE

[43] Release rubber stamp

ANNTOOL_STAMP_SENT

[44] Sent rubber stamp

ANNTOOL_STAMP_SHIPPED

[45] Shipped rubber stamp

ANNTOOL_STAMP_TOPSECRET

[46] Top Secret rubber stamp

ANNTOOL_STAMP_URGENT

[47] Urgent rubber stamp

ANNTOOL_STAMP_VOID

[48] Void rubber stamp

ANNTOOL_STAMP_LAST

[48] the last rubber stamp

ANNTOOL_LAST

[48] the last tool button

ANNTOOL_USER

[0x0100] the first user defined tool

ANNTOOL_USERLAST

[0x0200] the last allowed user defined tool

Required DLLs and Libraries

LTANN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

LAnnAutomation::GetAutoContainer, LAnnAutomation::SetTool, LAnnotation::GetUserMode, Class Members

Topics:

Annotation Functions: Working with the Toolbar

 

Implementing Annotations

 

Automated User Interface for Annotations

 

Key Annotation Features

 

Calibrating Annotation Ruler Objects

Example

L_INT LAnnAutomation_GetToolExample(LAnnAutomation  * pAnnAutomation)
{ 
   switch (pAnnAutomation->GetTool())
   {
      case ANNTOOL_SELECT:
      break;
      case ANNTOOL_LINE:
      break;
      case ANNTOOL_RECT:
      break;
      case ANNTOOL_ELLIPSE:
      break;
      case ANNTOOL_POLYLINE:
      break;
      case ANNTOOL_POLYGON:
      break;
      case ANNTOOL_POINTER:
      break;
      case ANNTOOL_FREEHAND:
      break;
      case ANNTOOL_HILITE:
      break;
      case ANNTOOL_REDACT:
      break;
      case ANNTOOL_TEXT:
      break;
      case ANNTOOL_NOTE:
      break;
      case ANNTOOL_STAMP:
      break;
      case ANNTOOL_BUTTON:
      break;
      case ANNTOOL_HOTSPOT:
      break;
      case ANNTOOL_AUDIO:
      break;
      case ANNTOOL_RULER:
      break;
   }
   return SUCCESS;
}