LAnnAutomation::GetTextPointerFixed

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::GetTextPointerFixed(pbPointerFixed)

L_BOOL *pbPointerFixed;

/* pointer to a variable to be updated */

Gets a value that indicates whether text pointer objects created using this automation object have a fixed pointer. This function is available in the Document/Medical Toolkits.

Parameter

Description

pbPointerFixed

Pointer to a variable to be updated with a value that specifies whether the text pointer objects created using this automation object have a fixed pointer. Possible values are:

 

Value

Meaning

 

TRUE

Text pointer objects created using this automation object have a fixed pointer.

 

FALSE

Text pointer objects created using this automation object have a pointer that moves with the object.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

If pbPointerFixed is updated with TRUE, the text pointer objects created using this automation object have a fixed pointer. When the text pointer is fixed, the location that the text pointer points to does not change when moving the object (either programmatically or through automation).

If pbPointerFixed is updated with FALSE, the Text pointer objects created using this automation object have a pointer that is not fixed. This means that when the object is moved, the location the text pointer points to moves along with the object.

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:

Class Members

Topics:

Annotation Functions: Object Properties

 

Implementing Annotations

 

Automated User Interface for Annotations

 

Annotation Functions: Creating and Deleting Annotations

 

Types of Annotations

 

Annotation Functions: Implementing Custom Annotations

 

Annotation Functions: Creating Custom Annotations

 

Fixed Annotations

 

Minimizing Flicker With Double Buffering

 

Annotation Functions: Working with the Toolbar

Example

// Sample for LAnnAutomation::GetTextPointerFixed, LAnnAutomation::SetTextPointerFixed

// This example toggles the text pointer

fixed state of an LAnnAutomation

object.

L_INT LAnnAutomation_GetTextPointerFixedExample(LAnnAutomation *pLAutomation) 
{
   
   L_INT nRet; 
   L_BOOL bTextPointerFixed; 
   L_TCHAR szMsg[100]; 
   L_UINT uType; 
   nRet = pLAutomation->GetTextPointerFixed( &bTextPointerFixed); 
   if(nRet != SUCCESS)
      return nRet;
   bTextPointerFixed = !bTextPointerFixed; 
   nRet= pLAutomation->SetTextPointerFixed(bTextPointerFixed, 0); 
   if (nRet != SUCCESS) 
   {
      uType = pLAutomation->GetType();
      wsprintf(szMsg, TEXT(" LAnnAutomation::SetTextPointerFixed Error: %d on object type[%d]\n"), nRet, uType); 
      MessageBox(NULL, szMsg, TEXT("Error"),  MB_OK); 
      return nRet;
   }
   
   return SUCCESS;
}