This chapter provides reference material for the insertion point API, declared in the header file InsPoint.h
.
For more information on the insertion point, see the section "Insertion Point" in the Palm OS Programmer's Companion, vol. I.
Insertion Point Functions
InsPtEnable Function
Purpose
Enable or disable the insertion point. When the insertion point is disabled, it's invisible; when it's enabled, it blinks.
Declared In
InsPoint.h
Prototype
void InsPtEnable ( Boolean enableIt )
Parameters
Returns
Comments
This function is called by the Form functions when a text field loses or gains the focus, and by the Windows function when a region of the display is copied (WinCopyRectangle()
).
Compatibility
If Palm OS Cobalt Feature Set is present this function is unimplemented.
See Also
InsPtEnabled Function
Purpose
Return true
if the insertion point is enabled or false if the insertion point is disabled.
Declared In
InsPoint.h
Prototype
Boolean InsPtEnabled ( void )
Parameters
Returns
Returns true
if the insertion point is enabled (blinking); returns false if the insertion point is disabled (invisible).
Compatibility
If Palm OS Cobalt Feature Set is present this function is unimplemented.
See Also
InsPtGetHeight Function
Purpose
Return the height of the insertion point.
Declared In
InsPoint.h
Prototype
Int16 InsPtGetHeight ( void )
Parameters
Returns
Returns the height of the insertion point, in pixels.
Compatibility
If Palm OS Cobalt Feature Set is present this function is unimplemented.
InsPtGetLocation Function
Purpose
Return the screen-relative position of the insertion point.
Declared In
InsPoint.h
Prototype
void InsPtGetLocation ( Int16 *x, Int16 *y )
Parameters
Returns
Returns nothing. Stores the location in x
and y
.
Comments
This function is called by the Field functions. An application would not normally call this function.
Compatibility
If Palm OS Cobalt Feature Set is present this function is unimplemented.
InsPtSetHeight Function
Purpose
Set the height of the insertion point.
Declared In
InsPoint.h
Prototype
void InsPtSetHeight ( const Int16 height )
Parameters
Returns
Comments
Set the height of the insertion point to match the character height of the font used in the field that the insertion point is in. When the current font is changed, the insertion point height should be set to the line height of the new font.
If the insertion point is visible when its height is changed, it's erased and redrawn with its new height.
Compatibility
If Palm OS Cobalt Feature Set is present this function is unimplemented.
See Also
InsPtSetLocation Function
Purpose
Set the screen-relative position of the insertion point.
Declared In
InsPoint.h
Prototype
void InsPtSetLocation ( const Int16 x, const Int16 y )
Parameters
Returns
Comments
The position passed to this function is the location of the top-left corner of the insertion point.
This function should be called only by the Field functions.
Compatibility
If Palm OS Cobalt Feature Set is present this function is unimplemented.