LAnnRTF::PushFixedState

#include "ltwrappr.h"

virtual L_INT LAnnRTF::PushFixedState(uFlags)

Temporarily disables the fixed state of an annotation.

Parameters

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 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.
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 temporarily disables the fixed state of one or more annotations.

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 LAnnRTF::PushFixedState on the fixed annotation before the magnifying glass paint. After the paint, call LAnnRTF::PopFixedState to restore the annotation objects fixed state.

Typically, you would call LAnnRTF::PushFixedState / LAnnRTF::PopFixedState on the root annotation container, passing ANNFLAG_RECURSE to temporarily disable the fixed state of ALL annotation objects.

Calls to LAnnRTF::PushFixedState and LAnnRTF::PopFixedState are maintained internally as a stack. This means that nested calls will behave properly. For example,

Function Behavior
LAnnRTF::PushFixedState (); Fixed state is temporarily disabled
LAnnRTF::PushFixedState (); Fixed state is temporarily disabled
LAnnRTF::PopFixedState (); Fixed state is still disabled
LAnnRTF::PopFixedState (); Fixed state is enabled

Note that LAnnRTF::PushFixedState and LAnnRTF::PopFixedState should always be called in pairs.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

This example temporarily disables the "fixed" property of all objects in the container.
This is useful when fixed objects need to be temporarily painted larger or smaller than
the fixed size. For an example using the magnifying glass, see the source code
for the main Class Library annotation demo.

L_INT LAnnRTF_PushFixedStateExample(LAnnRTF *pLRTF)  
{ 
	L_INT nRet; 
 
   nRet = pLRTF->PushFixedState(ANNFLAG_RECURSE | ANNFLAG_NOINVALIDATE);  
 
	return nRet; 
 
} 

Help Version 22.0.2021.9.12
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C++ Class Library Help