LAnnContainer::GetGrouping
#include "ltwrappr.h"
virtual L_INT LAnnContainer::GetGrouping(pbAutoGroup)
L_BOOL *pbAutoGroup; |
/* flags that indicates how objects are grouped */ |
Gets the grouping property of the objects within the specified container. This function is available in the Document/Medical Toolkits..
Parameter |
Description |
|
pbAutoGroup |
Pointer to a variable to be updated with a value that indicates whether or not the objects within the specified container are grouped. Possible values are: |
|
|
Value |
Meaning |
|
TRUE |
All objects within the container are treated as a group. |
|
FALSE |
Each object within the container can be selected and modified independently. |
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::SetGrouping, LAnnotation::Group, LAnnotation::Ungroup, Class Members |
Topics: |
Annotation Functions: Using Window Coordinates to Select Objects |
|
|
|
Example
// this example will toggle grouping for a particular sub-container.
// the parameter for this function should be a sub-container
L_INT LAnnContainer_GetGroupingExample(LAnnContainer * plContainer) { L_INT nRet; L_BOOL bGrouping; nRet = plContainer->GetGrouping(&bGrouping); if(nRet != SUCCESS) return nRet; nRet = plContainer->SetGrouping(!bGrouping, 0); if(nRet != SUCCESS) return nRet; return SUCCESS; }