L_AnnSetOffsetX

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetOffsetX(hObject, dOffsetX, uFlags)

HANNOBJECT hObject;	/* handle to the annotation object */
L_DOUBLE dOffsetX;	/* new value of the X offset */
L_UINT uFlags;	/* flags that determine which objects to process */

Sets the X offset of the annotation object. Typically, this value is used to match the root container's offset to the offset of the associated bitmap's display rectangle.

Parameter

Description

hObject	Handle to the annotation object.
dOffsetX	The new value of the X offset.
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 ( \| ).
	Note: Normally, you set this property only on the root container. The flags are included only to give you the same level of control as with other properties.
	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.
	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

The offset values are applied after the scalar properties, which are set by the L_AnnSetScalarX and L_AnnSetScalarY functions. For more information, refer to Low-Level Coordinate System for Annotations.

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

Win32, x64.

See Also

Functions:	L_AnnSetScalarX, L_AnnSetScalarY, L_AnnGetScalarX, L_AnnGetScalarY, L_AnnSetOffsetY, L_AnnGetOffsetX, L_AnnGetOffsetY, L_AnnGetFixed, L_AnnSetFixed, L_AnnPushFixedState, L_AnnPopFixedState, L_AnnIsFixedInRect
Topics:	Annotation Functions: Getting and Setting Geometric Properties
	Low-Level Coordinate System for Annotations
	Implementing an Automated Annotation Program
	Implementing a Non-automated Annotation Program
	Fixed Annotations
	Minimizing Flicker with Double Buffering
	Altering Annotation Object Settings

Example

For another example, refer to Implementing a Non-automated Annotation Program. For complete sample code, refer to the ANNOTATE example. This example moves all objects down and to the right by changing the container offsets.

 L_INT AnnSetOffsetXExample(HANNOBJECT hContainer)/* Container annotation object */
{
   L_INT nRet;
   L_DOUBLE OffsetX, OffsetY; /* Variables for updating offsets */
   ANNRECT  ContainerRect;
   ANNRECT  ContainerRectName;

   nRet = L_AnnGetOffsetX(hContainer, &OffsetX);
   if(nRet != SUCCESS)
      return nRet;
   nRet = L_AnnGetOffsetY(hContainer, &OffsetY);
   if(nRet != SUCCESS)
      return nRet;
   /* Get the container rectangle to use for positioning the line */
   nRet = L_AnnGetRect(hContainer, &ContainerRect, &ContainerRectName);
   if(nRet != SUCCESS)
      return nRet;
   nRet = L_AnnSetOffsetX (hContainer, 
      OffsetX + ((ContainerRect.right - ContainerRect.left) / 20),
      0);
   if(nRet != SUCCESS)
      return nRet;
   nRet = L_AnnSetOffsetY(hContainer, 
                           OffsetX + ((ContainerRect.bottom - ContainerRect.top) / 20),
                           0);
   if(nRet != SUCCESS)
      return nRet;
   return SUCCESS;
}