LAnnotation::GetAutoMenuItemEnable

#include "ltwrappr.h"

virtual L_INT LAnnotation::GetAutoMenuItemEnable(nObjectType, uItem, puEnable)

L_INT nObjectType;

/* type of annotation object */

L_UINT uItem;

/* constant for the specified item */

L_UINT * puEnable;

/* address of a variable to be updated */

Retrieves a value that indicates whether the specified menu item is enabled or disabled. This function is available in the Document/Medical Toolkits.

Parameter

Description

nObjectType

Constant that specifies an object's type. For descriptions of possible object types, refer to Types of Annotations.

uItem

Constant that specifies the menu or dialog box item to enable or disable. For lists of constants and their default values, refer to the following:

 

Annotation Automation Menu Strings

 

Annotation Automation Line Dialog Strings

 

Annotation Automation Fill Dialog Strings

 

Annotation Automation Text Dialog Strings

 

Annotation Automation Audio Dialog Strings

 

Annotation Automation Stamp Dialog Strings

 

Annotation Automation ROP2 Dialog Strings

 

Annotation Automation Lock/Unlock Dialog Strings

 

Annotation Automation Miscellaneous Dialog Strings

 

Annotation Automation Ruler Dialog Strings

 

Annotation Automation Point Dialog Strings

 

Annotation Automation Video Dialog Strings

 

Annotation Automation Push Pin Dialog Strings

 

Annotation Automation Nodes Dialog Strings

 

Annotation Automation Protractor Dialog Strings

 

Annotation Automation Name Dialog Strings

 

Annotation Automation Play Video Dialog Strings

 

Annotation Automation Stamp Metafile Dialog Strings

 

Annotation Automation ToolTip Dialog Strings

 

Annotation Automation Transparent Color Dialog Strings

 

Annotation Automation Capture Dialog Strings

puEnable

Address of a variable to be updated with a value that indicates whether the specified menu item has been enabled or disabled for the object. Possible values are:

 

Value

Meaning

 

ANNMENU_ENABLED

Enable the menu item.

 

ANNMENU_DISABLED

Disable the menu item.

 

ANNMENU_DEFAULT

Enable or disable the menu item, based on the setting for the object type.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

If for the specified object, the menu items enable state is ANNMENU_DEFAULT, the function determines whether the enable state has been set for objects of the specified type. If the enable state for objects of the specified type is also ANNMENU_DEFAULT, the function determines whether the enable state has been set for ANNOBJECT_ALL. If this is also ANNMENU_DEFAULT, the function determines whether the menu item text is NULL or not NULL. If it is NULL, the function updates puEnable with ANNMENU_DISABLE. If the menu item is not NULL, the function updates puEnable with ANNMENU_ENABLE.

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:

LAnnotation::SetAutoMenuItemEnable, LAnnAutomation::SetAutoText, LAnnAutomation::GetAutoText, LAnnotation::GetAutoMenuState, LAnnotation::SetAutoMenuState, LAnnotation::SetAutoSnapCursor, LAnnotation::GetAutoSnapCursor

Topics:

Annotation Functions: Implementing Automation

 

Implementing Annotations

 

Automated User Interface for Annotations

Example

For an example, refer to LAnnotation::SetAutoMenuItemEnable.