Palm OS Programmer's API Reference/13

←　12 章に戻る　↑トップへ　14 章に進む　→

13 挿入ポイント

• 挿入ポイント関数
  • InsPtEnable
  • InsPtEnabled
  • InsPtGetHeight
  • InsPtGetLocation
  • InsPtSetHeight
  • InsPtSetLocation

この章では、ヘッダ ファイル InsPoint.h で定義されている、挿入ポイント API のための参照資源を提供します。

挿入ポイント関数 ^TOP^

InsPtEnable 関数 ^TOP^

目的

挿入ポイントを使用可能または使用不可にします。挿入ポイントが使用不可であるとき、挿入ポイントは不可視です。使用可能であるとき、挿入ポイントは点滅します。

宣言されている場所

InsPoint.h

Prototype

void InsPtEnable (
	Boolean enableIt
)

パラメータ

• enalbeIt
  • 使用可能にする場合、true。使用不可にする場合、false。

返り値

返り値はありません。

コメント

この関数は、テキスト フィールドがフォーカスを失ったまたは取得したとき、フォーム関数によって呼び出されます。ディスプレイの領域がコピーされた（WinCopyRectangle()|Palm OS Programmer's API Reference/59）とき、ウィンドウ関数によって呼び出されます。

互換性

Palm OS Cobalt Feature Set が存在する場合、この関数は実装されません。

参照

InsPtEnabled()

InsPtEnabled 関数 ^TOP^

目的

挿入ポイントが使用可能な場合、true を返します。挿入ポイントが使用不可の場合、false を返します。

宣言されている場所

InsPoint.h

Prototype

Boolean InsPtEnabled (
	void
)

パラメータ

ありません。

返り値

挿入ポイントが使用可能な（点滅している）場合、true を返します。挿入ポイントが使用不可（不可視）の場合、false を返します。

互換性

Palm OS Cobalt Feature Set が存在する場合、この関数は実装されません。

参照

InsPtEnable()

InsPtGetHeight 関数 ^TOP^

目的

挿入ポイントの高さを返します。

宣言されている場所

InsPoint.h

Prototype

Int16 InsPtGetHeight (
	void
)

パラメータ

ありません。

返り値

挿入ポイントの高さをピクセル数で返します。

互換性

Palm OS Cobalt Feature Set が存在する場合、この関数は実装されません。

InsPtGetLocation 関数 ^TOP^

目的

挿入ポイントのスクリーンとの相対的な位置を返します。

宣言されている場所

InsPoint.h

Prototype

void InsPtGetLocation (
	Int16 *x,
	Int16 *y
)

パラメータ

• x, y
  • 挿入ポイントの左上端の x, y 座標へのポインタ

返り値

返り値はありません。位置は x と y に収められて返されます。

コメント

この関数はフィールド関数によって呼び出されます。アプリケーションは、通常、この関数を呼び出すことはありません。

互換性

Palm OS Cobalt Feature Set が存在する場合、この関数は実装されません。

InsPtSetHeight 関数 ^TOP^

目的

挿入ポイントの高さをセットします。

宣言されている場所

InsPoint.h

Prototype

Int16 InsPtSetHeight (
	const Int16 height
)

パラメータ

• height
  • 挿入ポイントの高さをピクセル数で指定します。

返り値

返り値はありません。

コメント

挿入ポイントの高さを、挿入ポイントがあるフィールドで使用されているフォントの高さに一致させるために、セットします。現在のフォントが変更されるとき、挿入ポイントの高さを新しいフォントの高さにセットすべきです。

挿入ポイントの高さが変更されるときに挿入ポイントが可視の場合、挿入ポイントは消され、それから新しい高さで再描画されます。

互換性

Palm OS Cobalt Feature Set が存在する場合、この関数は実装されません。

参照

InsPtGetHeight()

InsPtSetLocation 関数 ^TOP^

目的

挿入ポイントのスクリーンとの相対的な位置をセットします。

宣言されている場所

InsPoint.h

Prototype

void InsPtGetLocation (
	const Int16 x,
	const Int16 y
)

パラメータ

• x, y
  • ディスプレイの左上端からのピクセル数

返り値

返り値はありません。

コメント

この関数に渡される位置は、挿入ポイントの左上端の位置です。

この関数はフィールド関数によってのみ呼び出されるべきです。

互換性

Palm OS Cobalt Feature Set が存在する場合、この関数は実装されません。

参照

InsPtGetLocation()

←　12 章に戻る　↑トップへ　14 章に進む　→