LAnnContainer::SetGrouping

#include "ltwrappr.h"

virtual L_INT LAnnContainer::SetGrouping(bAutoGroup, uFlags)

L_BOOL bAutoGroup;	/* flags that indicates whether or not to group objects */
L_UINT uFlags;	/* flags that determine which objects to process */

Sets the grouping of the objects within the specified container. This function is available in the Document/Medical Toolkits.

Parameter	Description
bAutoGroup	Flag that indicates whether or not to group the objects within the specified container. Possible values are:
	Value	Meaning
	TRUE	All objects within the container should be treated as a group.
	FALSE	Each object within the container can be selected and modified independently.
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 LAnnotation::IsSelected and LAnnotation::SetSelected 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

This function is valid only for container objects.

Each container contains a "grouping" property, which indicates whether the objects in the container should be treated as a group.

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:	LAnnContainer::GetGrouping, LAnnotation::Group, LAnnotation::Ungroup, Class Members
Topics:	Annotation Functions: Using Window Coordinates to Select Objects
	Annotation Functions: Object Information
	Displaying and Manipulating Annotation Objects

Example

L_INT LAnnContainer_SetGroupingExample()
{
   L_INT nRet;
   /* 
   this example will temporarily disable the grouping in all objects
   and re-enable the grouping later
   */
   // disable grouping in all groups
   LAnnContainer lContainer; 
   nRet = lContainer.SetGrouping(FALSE, ANNFLAG_RECURSE); 
   if(nRet != SUCCESS)
      return nRet;
   /* you can now select and change individual objects within groups */
   // re-enable grouping in all groups. 
   // note that we do NOT enable grouping in the topmost container! 
   // if you enable the grouping in the top container, then all the 
   //objects will act as a group! 
   nRet = lContainer.SetGrouping(TRUE, ANNFLAG_RECURSE|ANNFLAG_NOTTHIS); 
   if(nRet != SUCCESS)
      return nRet;
   return SUCCESS;
}