L_AnnSetSelected

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetSelected(hObject, fSelected, uFlags)

HANNOBJECT hObject;

/* handle to the annotation object */

L_BOOL fSelected;

/* flag that indicates whether to select or deselect an object */

L_UINT uFlags;

/* flags that determine which objects to process */

Selects or deselects the specified annotation object.

This function is available in the Document and Medical Imaging toolkits.

Parameter

Description

hObject

Handle to the annotation object.

fSelected

Flag that indicates whether to select or deselect an object. Possible values are:

 

Value

Meaning

 

TRUE

Select the specified object and all objects that it contains.

 

FALSE

Deselect the object and all objects that it contains.

 

uFlags

Flags that determine which objects to process. Most of the flags apply only to container objects. You can combine values when appropriate by using a bitwise OR ( | ). The following are valid values:

 

Value

Meaning

 

0

Process only the specified object.

 

ANNFLAG_SELECTED

[0x0001] Process only objects that have the selected property set to TRUE. For getting and setting the selected property, use the L_AnnGetSelected and L_AnnSetSelected functions functions.

 

ANNFLAG_NOTTHIS

[0x0004] Process only one level of objects within the specified container, not the container itself. If there are containers within the container, they are modified, but the objects within them are not.

 

ANNFLAG_RECURSE

[0x0008] Process objects within a container, and within any subcontainers, down to any level.

 

ANNFLAG_NOTCONTAINER

[0x0002] (Used with ANNFLAG_RECURSE) Process objects within containers, not the containers themselves.

 

ANNFLAG_NOINVALIDATE

[0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Most L_AnnSet... functions let you change properties of selected objects in a container. Therefore, if you set individual objects' selected properties to TRUE, you can then use the other L_AnnSet... functions on the container to change the properties of only those objects in the container that have been selected.

This function applies to multiple and selected objects based on values of the uFlags parameter. The possible flags are the same as for other L_AnnSet... functions.

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.

Platforms

Windows 2000 / XP/Vista.

See Also

Functions:

L_AnnSelectRect, L_AnnGetSelectRect, L_AnnGetSelectCount, L_AnnSelectPoint, L_AnnGetType, L_AnnGetSelected, L_AnnGetSelectItems, L_AnnGetROP2, L_AnnSetROP2, L_AnnSetTransparent, L_AnnGetTransparent, L_AnnShowLockedIcon, L_AnnGetFillMode, L_AnnSetFillMode, L_AnnGetOptions, L_AnnSetOptions

Topics:

Annotation Functions: Using Window Coordinates to Select Objects

 

Annotation Functions: Object Information

 

Annotation Objects - Default Values

 

Annotation Objects - Automated Features

 

Implementing an Automated Annotation Program

 

Implementing a Non-automated Annotation Program

Example

This example selects the specified object, if the object is not already selected. 

 L_INT AnnSetSelectedExample(HANNOBJECT hAnnObject)
{
   L_INT nRet;
   L_BOOL IsSelected; /* TRUE if the object is selected */

   /* See if the object is selected */
   nRet = L_AnnGetSelected(hAnnObject, &IsSelected);
   if(nRet != SUCCESS)
      return nRet;
   /* If it is not already selected, select it */
   if (IsSelected)
      MessageBox (NULL, TEXT("Already selected"), TEXT("Notice"), MB_OK);
   else
   {
      nRet = L_AnnSetSelected (hAnnObject, TRUE, 0);
      if(nRet != SUCCESS)
         return nRet;
   }
   return SUCCESS;
}