LAnnRuler::PopFixedState

#include "ltwrappr.h"

virtual L_INT LAnnRuler::PopFixedState(uFlags)

L_UINT uFlags;

/* flags that determine which objects to process */

Re-enables the fixed state of an annotation.

Parameter

Description

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

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 LAnnRuler::PushFixedState.

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 LAnnotation::SetScalarX, LAnnotation::SetScalarY, LAnnotation::SetOffsetX, and LAnnotation::SetOffsetY.

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

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

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

 

LAnnRuler::PushFixedState ();

Fixed state is temporarily disabled

 

LAnnRuler::PushFixedState ();

Fixed state is temporarily disabled

 

LAnnRuler::PopFixedState ();

Fixed state is still disabled

 

LAnnRuler::PopFixedState ();

Fixed state is enabled

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

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:

Class Members

Topics:

Annotation Functions: Creating and Deleting Annotations

 

Implementing Annotations

 

Annotation Functions: Implementing Custom Annotations

Example

// This example enables the"fixed" property fo all objects in the container that

// have been temporarily disabled with a call to LAnnRuler::PushFixedState.

// For an example using the magnifying glass, see the source code

// for the main Class Library annotation demo. 

L_INT LAnnRuler_PopFixedStateExample(LAnnRuler *pLRuler) 
{
	L_INT nRet;
   nRet = pLRuler->PopFixedState(ANNFLAG_RECURSE | ANNFLAG_NOINVALIDATE); 
	return nRet;
}