クラス SGCaret

キャレットクラス [詳細]

#include <sggraphics.h>

SGCaretに対する継承グラフ
Inheritance graph
[凡例]

すべてのメンバ一覧

Public メソッド

 SGCaret (SGGraphics *graphics)
 キャレットクラスのコンストラクタ
virtual ~SGCaret ()
 キャレットクラスのデストラクタ
virtual void Release ()
SGWindowGetWindow ()
 キャレットが持つベースウィンドウ取得
void DrawCaret (int w=0, int h=0, int type=-1)
 キャレットを描く
void MoveCaret (int x, int y)
 キャレットを移動する。
void BlinkCaret ()
 キャレットを点滅させる。
int HideCaret ()
 キャレットを非表示にする
int ShowCaret ()
 キャレットを表示する
void SetCaretVisible ()
int IsCaretVisible ()
 キャレットの表示・非表示状態を取得する
void SetCaretType (int type)
 キャレットの種類を設定する。

説明

キャレットクラス


コンストラクタとデストラクタ

SGCaret ( SGGraphics graphics  ) 

キャレットクラスのコンストラクタ

~SGCaret (  )  [virtual]

キャレットクラスのデストラクタ


関数

void Release (  )  [virtual]

確保したリソースを解放する 確保したリソースを解放します。

SGSurfaceを再定義しています。

SGWindow * GetWindow (  ) 

キャレットが持つベースウィンドウ取得

void DrawCaret ( int  w = 0,
int  h = 0,
int  type = -1 
)

キャレットを描く

この関数はキャレット表示の必要がある時にコールされます。
指定された幅と高さのパラメータと、予め登録されているキャレット形状の値に従いキャレットを描画します。
形状を描画する場合、この関数は SGApplication クラスの
int SGApplication::DrawCaret(SGSurface* surface,int type,int width,int height)
をコールします。
ユーザが任意の色、形でキャレットを描画する場合は SGApplication::DrawCaret をオーバーライドし、 その関数内で描画してください。 SGApplication::DrawCaret がTRUE(0以外)を返す時、この関数は描画を行わないで終了します。
SGApplication::DrawCaret をオーバーライドしない場合、関数は FALSE を返す為、この関数内で描画を行います。
キャレットの形状は SGCaret::SetCaretType(int type) で変更できます。

引数:
w キャレットの幅 省略時(0)となり、変更しないで現状のまま再表示
h キャレットの高さ 省略時(0)となり、変更しないで現状のまま再表示 type キャレットの形状 省略時(-1)となり、変更しないで現状のまま再表示
参照:
SGGraphics::DrawCaret(int w,int h)
SGApplication::DrawCaret(SGSurface* surface,int type,int width,int height)
void MoveCaret ( int  x,
int  y 
)

キャレットを移動する。

指定した座標へキャレットを移動します。

引数:
x X座標
y Y座標
void BlinkCaret (  ) 

キャレットを点滅させる。

キャレットを点滅させるた為にベースタイマーから定期的にコールされます。
ライブラリが使用する関数です。

int HideCaret (  ) 

キャレットを非表示にする

キャレットを非表示にします。

戻り値:
TRUE 成功
FALSE 失敗
int ShowCaret (  ) 

キャレットを表示する

キャレットを表示します。

戻り値:
TRUE 成功
FALSE 失敗
int IsCaretVisible (  ) 

キャレットの表示・非表示状態を取得する

キャレットの表示・非表示状態を取得します。

戻り値:
TRUE 表示状態
FALSE 非表示状態
void SetCaretType ( int  type  ) 

キャレットの種類を設定する。

キャレットの種類(形状)を設定します。

引数:
type 種類

SG_CARET_UNDERLINE(0) アンダーライン(文字の下に横線)
SG_CARET_IBEAM(1)     アイビーム(文字の左側に縦線)
SG_CARET_BOX(2)       ボックス(文字を囲む線)

このクラスの説明は次のファイルから生成されました:

PlusG リファレンスマニュアル Ver 2.0.0