Automation Help
Automation Reference
MediaCy.IQL.Display.Overlays
_DMcGraphOverlayEvents Interface
FEATURE_DISPLAY_LINK_INFO Structure
IMcAutoTrace Interface
IMcAutoTrace2 Interface
IMcEditControl Interface
IMcGraphObj Interface
IMcGraphObj2 Interface
IMcGraphObjArrow Interface
IMcGraphObjBitmap Interface
IMcGraphObjCircle Interface
IMcGraphObjCircle2 Interface
IMcGraphObjEllipse Interface
IMcGraphObjEllipse2 Interface
IMcGraphObjEx Interface
IMcGraphObjGroup Interface
IMcGraphObjLine Interface
IMcGraphObjLine2 Interface
IMcGraphObjPoint Interface
IMcGraphObjPoint2 Interface
IMcGraphObjPoly Interface
IMcGraphObjPoly2 Interface
IMcGraphObjRect Interface
IMcGraphObjRect2 Interface
IMcGraphObjRRect Interface
IMcGraphObjRRect2 Interface
IMcGraphObjServer Interface
IMcGraphObjText Interface
IMcGraphObjText2 Interface
IMcGraphObjTextEx Interface
IMcGraphOverlay Interface
IMcGraphOverlay2 Interface
IMcGraphOverlayEx Interface
IMcGraphToolServer Interface
IMcViews Interface
McAutoTrace Interface
mcAutoTraceCommandFlags Enumeration
mcAutoTraceTraceControl Enumeration
mcAutoTraceTraceState Enumeration
McBCG_Tool Interface
McBlendTool Interface
mcBlendToolCommandFlags Enumeration
mcBrushShapes Enumeration
McBrushTool Interface
McBrushToolClass Class
mcBrushToolCommandFlags Enumeration
mcCommonToolCommandFlags Enumeration
McEditControl Interface
McEditControlClass Class
McEditEdgesTool Interface
mcEditEdgesToolCommandFlags Enumeration
McGraphObj Interface
McGraphObjArrow Interface
McGraphObjArrowClass Class
McGraphObjBitmap Interface
mcGraphObjBitmapOptions Enumeration
mcGraphObjBorderStyle Enumeration
mcGraphObjCategory Enumeration
McGraphObjCircle Interface
mcGraphObjCircleType Enumeration
mcGraphObjColorStyle Enumeration
mcGraphObjCommandFlags Enumeration
McGraphObjEllipse Interface
McGraphObjEx Interface
mcGraphObjExtendedStyle Enumeration
mcGraphObjFillStyle Enumeration
McGraphObjGroup Interface
mcGraphObjGroupType Enumeration
McGraphObjLine Interface
mcGraphObjLineEnding Enumeration
mcGraphObjMaskBitmapOptions Enumeration
McGraphObjPoint Interface
mcGraphObjPointShape Enumeration
mcGraphObjPointShapeElement Enumeration
McGraphObjPoly Interface
McGraphObjRect Interface
McGraphObjRRect Interface
McGraphObjServer Interface
mcGraphObjStyle Enumeration
McGraphObjText Interface
mcGraphObjTextAlignment Enumeration
mcGraphObjTextControlFlags Enumeration
mcGraphObjWhichEnd Enumeration
mcGraphObjWhichPoints Enumeration
McGraphOverlay Interface
mcGraphOverlayActions Enumeration
mcGraphOverlayCommandFlags Enumeration
mcGraphOverlayDrawMode Enumeration
mcGraphOverlayEnumWhat Enumeration
McGraphOverlayEx Interface
mcGraphOverlayNotifyContext Enumeration
mcGraphOverlayOptionFlags Enumeration
mcGraphOverlaySelectedLabelHandling Enumeration
mcGraphOverlayTemplates Enumeration
mcGraphOverlayTemplateSelection Enumeration
McGraphToolServer Interface
mcMcOvrLibPropertyIDs Enumeration
McPanScrollTool Interface
mcPanScrollToolCommandFlags Enumeration
McPickPointsTool Interface
McPickPointsToolCommandFlags Enumeration
McPickSpotsTool Interface
mcPickSpotsToolCommandFlags Enumeration
mcPointerLineAnchorType Enumeration
mcPolyToolCommandFlags Enumeration
McRotateGridTool Interface
mcRotateGridToolCommandFlags Enumeration
McRotatePreviewTool Interface
mcRotatePreviewToolCommandFlags Enumeration
McSeedRegionTool Interface
mcSeedRegionToolCommandFlags Enumeration
mcSelectToolCommandFlags Enumeration
McViews Interface
mcWhichToolCursor Enumeration
McZoomTool Interface
mcZoomToolCommandFlags Enumeration
Click or drag to resize

mcCommonToolCommandFlags Enumeration
Legal common values for the McGraphToolServer.CommandFlags property.

Namespace:  MediaCy.IQL.Display.Overlays
Assembly:  MediaCy.IQL.Display.Overlays (in MediaCy.IQL.Display.Overlays.dll) Version: 10.0.6912.0
Syntax
VB
Copy
Public Enumeration mcCommonToolCommandFlags
Members
  Member nameValueDescription
mcctcfNone0No flags (or can be used for clearing flags).
mcctcfAll-1All flags (can be used for masking all flags).
mcctcfCommonFlags-16777216Mask for the common flags.
mcctcfCommonActionFlags251658240Mask for the common actionflags. These action values call for some action to be performed, so they are never stored as part of the tools CommandFlags.
mcctcfCenterCursorInView16777216Standard Action flag:CommandData must be an IMcBasicView instance; the cursor position will be placed in the center of this window. After the action is performed, CommandData is cleared.
mcctcfSetToolHelpText33554432Standard Action flag:CommandData is new, already localized tool help text. If not set, built-in help text is used. Tool help is not displayed until an assignment to CommandFlags is made with the mcctcfSetToolHelpNow standard action flag.
mcctcfSetToolHelpTitle50331648Standard Action flag:CommandData is a new, already localized tool help title. If not set, a built-in help title is used. Tool help is not displayed until an assignment to CommandFlags is made with the mcctcfSetToolHelpNow standard action flag.
mcctcfSetToolHelpContextID67108864Standard Action flag:CommandData is a new help ContextID. If not set, a built-in help ContextID on the tool used. Tool help is not displayed until an assignment to CommandFlags is made with the mcctcfSetToolHelpNow standard action flag.
mcctcfSetToolHelpFile83886080Standard Action flag:CommandData is a new help file path spec. If not set, the standard help file is assumed. Tool help is not displayed until an assignment to CommandFlags is made with the mcctcfSetToolHelpNow standard action flag.
mcctcfSetToolHelpNow100663296Standard Action flag: Thetool help information is immediately displayed via a call to the application's SetToolHelp method. The displayed Text, Title, ContextID and HelpFile are either the defaults for the tool or those set by previous standard CommandFlags assignments of the standard action flags mcctcfSetToolHelpText, mcctcfSetToolHelpTitle, mcctcfSetToolHelpContextID and/or mcctcfSetToolHelpFile, respectively. Assigning this action flag automatically un-silences help for this tool, if the mcctcfSilenceToolHelp had been previously given.
mcctcfClearToolHelpNow117440512Standard Action flag: Thetool help information is immediately cleared via a call to the application's SetToolHelp method. Assigning this action flag automatically un-silences help for this tool, if the mcctcfSilenceToolHelp had been previously given.
mcctcfSilenceToolHelp117440513Standard Action flag: Thetool help information is immediately cleared via a call to the application's SetToolHelp method, and then further updates to tool help are not performed the this tool until the mcctcfUnSilenceToolHelp command is given.
mcctcfUnSilenceToolHelp117440514Standard Action flag: Any silencingof the tool help information is removed. Tool help is not immediately displayed or cleared unless you subsequently assign the mcctcfSetToolHelpNow or mcctcfClearToolHelpNow action flags.
mcctcfSetAutoScrollMethod134217728Standard Action flag:CommandData holds the McView.mcAutoScrollMethods flags to be assigned as the active view's McView.AutoScrollMethod property as long as the the tool is running. If CommandData is -1, then default behavior is restored for the tool's control of its McView.AutoScrollMethod property. This is equivalent to assigning the mcctcfSetAutoScrollMethodToDefault action flag, and is done automatically whenever a tool is shut down. If CommandData is -2, then the tool will make no changes in the McView.AutoScrollMethod property. This is equivalent to assigning the mcctcfSetAutoScrollMethodFreeze action flag.
mcctcfSetAutoScrollMethodToDefault134217729Standard Action flag:Default behavior is restored for the tool's control of its McView.AutoScrollMethod property. This is done automatically whenever a tool is shut down.
mcctcfSetAutoScrollMethodFreeze134217730Standard Action flag: Setsa state where the tool will make no further changes in the McView.AutoScrollMethod property.
mcctcfSetCustomCursors150994944Standard Action flag:CommandData is a scalar or array of either cursor file name strings or numerical cursor handles. If CommandData is empty, then ahy existing custom cursors are removed. If not set, the normal tool cursors are used. For each tool that is designed to make use of custom cursors (and not all are), each cursor in the array will replace one of the normal cursors used. For the built-in selection tool, the replacements are Arrow, Open Hand and Closed Hand cursors, in that order. Generally the replacement for the Arrow will be at index 0, while replacements for other cursors will be in ascending order, with the initially visible cursor (if it is not an arrow) being at index 1. So for the polygon creation tool, the order is Arrow, Cross, Pencil and Eraser, AutoTrace. The selection handle and rotation quadrant cursors are not replaceable. Cursors, in order, for the other tools that support the mcctcfSetCustomCursors CommandFlag follow: McBCG_Tool: Arrow, Not adjusting (light/dark circle), Adjusting brightness/contrast, Adjusting gamma McBlendTool: 4-way open arrows, 4-way closed arrows McEditEdgesTool: Add an edge, Remove an edge McPanScrollTool: Open hand, Closed hand McPickPointsTool: Pencil McPickSpotsTool: Pin McRotateGridTool: Rotate counter clockwise arc, Rotate clockwise arc, Rotate counter clockwise circle, Rotate clockwise circle McSeedRegionTool: Magic wand, Wand with plus, Wand with minus McZoomTool: Zoom out (minus magnification), Zoom in (plus magnification), Zoom selection (drag magnification) McBrushTool: Plus, Minus
mcctcfCursorColorRequestsHonoredStd150994945StandardAction flag: sets the state to honor any tool request to color a non-custom cursor; custom cursors set with the mcctcfSetCustomCursors will not be changed. This is the default state.
mcctcfCursorColorRequestsHonoredAll150994946Standard Action flag:sets the state to honor any tool request to color any cursor, standard or custom.
mcctcfCursorColorRequestsIgnored150994947Standard Action flag:sets the state to ignore any tool request to color any cursor.
mcctcfCursorColorRequestsGetState9437188Standard Action flag:sets CommandData CursorRequestedHonored state: 1==Std, 2==All, 3=Ignored.
mcctcfSetNeedFocus167772160Standard Action flag:Set the tool so that it will only respond to events, such as mouse-move, when the notifying IMcBasicView has the focus.
mcctcfClearNeedFocus184549376Standard Action flag: Setthe tool so that it will respond to events, such as mouse-move, whenever they are fired by the notifying IMcBasicView, whether it has the focus or not. This is the default state.
mcctcfShutdown251658240CommandFlags supported by all McCommandFlagsDataImpl.h implementations
mcctscfDataGet-556883968When assigned, gets the dataelement identified by the lowest 12 bits of the command into CommandData. CommandData is cleared once it is next accessed.
mcctscfDataSet-556879872When assigned, sets the dataelement identified by the lowest 12 bits of the command from the current CommandData. CommandData is cleared after its value is stored.
mcctscfDataClear-556875776When assigned, clears the dataelement identified by the lowest 12 bits of the command.
mcctscfDataClearAll-556871680When assigned, clears all storeddata elements.
mcctscfDataList-556867584When assigned, sets CommandDatato an array of integers identifying the storage elements than have been assigned to and not yet cleared.
mcctscfDataElementMask4095A mask for the data element portionof the mcctscfDataXxxx action commands.
mcctscfSaveAsBytes-556859392When assigned, sets CommandDatato an array of bytes holding a full representation of CommandFlags, CommandData and all data elements. CommandData and data elements holding Object references or Structures (Records) cannot be saved as bytes. Such elements will not be saved, and a subsequent assignment of the mcctscfSaveAsBytesSucceeded will set CommandData to False.
mcctscfSaveAsBytesSucceeded-556859391When assigned, setsCommandData to True if the last mcctscfSaveAsBytes succeeded in saving CommandData and all data elements. If the last mcctscfSaveAsBytes encountered a non-savable element, CommandData will be set False.
mcctscfLoadFromBytes-556859390When assigned, assumesCommandData is an array of bytes previously created by a mcctscfSaveAsBytes assignment. CommandFlags, CommandData and all data elements are restored from this array.
Remarks
These flag values are useful for all custom tools. Each tool will usually also have its own CommandFlags action and option flags.
See Also