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

Purpose
Enable or disable the insertion point. When the insertion point is disabled, it's invisible; when it's enabled, it blinks.
Prototype
void InsPtEnable (Boolean enableIt)
Parameters
enableIt | true = enable; false = disable |
Result
Returns nothing.
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).
See Also
InsPtEnabled
InsPtEnabled

Purpose
Return true if the insertion point is enabled or false if the insertion point is disabled.
Prototype
Boolean InsPtEnabled (void)
Parameters
Result
Returns true if the insertion point is enabled (blinking); returns false if the insertion point is disabled (invisible).
See Also
InsPtEnable
InsPtGetHeight

Purpose
Return the height of the insertion point.
Prototype
Int16 InsPtGetHeight (void)
Parameters
Result
Returns the height of the insertion point, in pixels.
InsPtGetLocation

Purpose
Return the screen-relative position of the insertion point.
Prototype
void InsPtGetLocation (Int16 *x, Int16 *y)
Parameters
x, y | Pointer to top-left position of insertion point's x and y coordinate. |
Result
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.
InsPtSetHeight

Purpose
Set the height of the insertion point.
Prototype
void InsPtSetHeight (const Int16 height)
Parameters
height | Height of the insertion point in pixels. |
Result
Returns nothing.
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.
See Also
InsPtGetHeight
InsPtSetLocation

Purpose
Set the screen-relative position of the insertion point.
Prototype
void InsPtSetLocation (const Int16 x, const Int16 y)
Parameters
x, y | Number of pixels from the left side (top) of the display. |
Result
Returns nothing.
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.
See Also
InsPtGetLocation
|