In This Topic ▼

L_AnnPopFixedState

Summary

Re-enables the fixed state of an annotation.

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnPopFixedState(hObject, uFlags)

Parameters

HANNOBJECT hObject

Handle to the annotation object.

L_UINT 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.
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.
ANNFLAG_CHECKMENU	[0x0020] Process objects only if the ANNAUTOTEXT_MENU_TEXT menu item has been selected.

Returns

Value	Meaning
SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

This function re-enables the fixed state of one or more annotations. It is to be called after the fixed state as been temporarily disabled by a call to L_AnnPushFixedState.

Fixed annotations are independent of the annotation container scalarX, scalarY, offsetX and offsetY properties. The result is that they do not scroll or move with the underlying image. For more information, refer to:

In some instances, however, it is necessary to display a fixed annotation at a larger or smaller size than its fixed size. For Example, when using the magnifying glass on a fixed annotation, the annotation needs to be painted larger than normal.

To accommodate, call L_AnnPushFixedState on the fixed annotation before the magnifying glass paint. After the paint, call L_AnnPopFixedState to restore the annotation objects fixed state.

Typically, you would call L_AnnPushFixedState/L_AnnPopFixedState on the root annotation container, passing ANNFLAG_RECURSE to temporarily disable the fixed state of ALL annotation objects.

Calls to L_AnnPushFixedState and L_AnnPopFixedState are maintained internally as a stack. This means that nested calls will behave properly. For Example:

Function	Behavior
L_AnnPushFixedState();	Fixed state is temporarily disabled
L_AnnPushFixedState();	Fixed state is temporarily disabled
L_AnnPopFixedState();	Fixed state is still disabled
L_AnnPopFixedState();	Fixed state is enabled

Note that L_AnnPushFixedState and L_AnnPopFixedState should always be called in pairs.

The following annotations cannot be fixed:

ANNOBJECT_CONTAINER
ANNOBJECT_REDACT
ANNOBJECT_ENCRYPT

For more information, refer to Fixed 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.

Example

This example enables the "fixed" property of all objects in the container that
have been temporarily disabled with a call to L_AnnPushFixedState.
For an example using the magnifying glass, refer to the \Examples\Annotation\C\Annotate demo.

L_INT AnnPopFixedStateExample(HANNOBJECT hContainer) 
{ 
   return L_AnnPopFixedState(hContainer, ANNFLAG_RECURSE | ANNFLAG_NOINVALIDATE); 
}

Download our FREE evaluation

Help Version 23.0.2024.2.29

LEADTOOLS Raster Imaging C API Help

Introduction

Version History

Getting Started

Files To Be Included With Your Application

Document Writers – Files To Be Included With Your Application

LEADTOOLS Raster Imaging Features