Public メソッド | Protected メソッド | プロパティ | イベント

クラス Widget

ウィジェットの基底クラス [詳細]

Widgetに対する継承グラフ
AnimationImageBox BusyIndicator Button CheckBox ContainerWidget DatePicker EditableText ImageBox Label LiveFlipPanel LiveListPanel LiveSphere PagePanel PopupList ProgressBar ScrollBar Slider TimePicker

すべてのメンバ一覧

Public メソッド

 Widget ()
 コンストラクタ
void Dispose ()
 このウィジェット、および子ウィジェットの所有するアンマネージドリソースを解放する
virtual void SetPosition (float x, float y)
 親の座標系での位置を設定する。
virtual void SetSize (float width, float height)
 サイズを設定する。
void SetFocus (bool active)
 自分自身にフォーカスをあてる
virtual bool HitTest (Vector2 screenPoint)
 指定した座標でこのウィジェットがヒットするかどうかを取得する
Vector2 ConvertScreenToLocal (Vector2 screenPoint)
 指定した座標をスクリーン座標系からローカル座標系に変換する。
Vector2 ConvertScreenToLocal (float screenX, float screenY)
 指定した座標をスクリーン座標系からローカル座標系に変換する。
Vector2 ConvertLocalToScreen (Vector2 localPoint)
 指定した座標をローカル座標系からスクリーン座標系に変換する。
Vector2 ConvertLocalToScreen (float localX, float localY)
 指定した座標をローカル座標系からスクリーン座標系に変換する。
Vector2 ConvertLocalToOtherWidget (Vector2 localPoint, Widget targetWidget)
 指定した座標を自身のローカル座標系から他のWidgetのローカル座標系に変換する。
Vector2 ConvertLocalToOtherWidget (float x, float y, Widget targetWidget)
 指定した座標を自身のローカル座標系から他のWidgetのローカル座標系に変換する。
void RenderToTexture (Texture2D texture)
 テクスチャへ描画する。
void RenderToTexture (Texture2D texture, Matrix4 transform)
 テクスチャへ描画する。
void RenderToFrameBuffer (FrameBuffer frameBuffer)
 フレームバッファへ描画する。
void RenderToFrameBuffer (FrameBuffer frameBuffer, Matrix4 transform)
 フレームバッファへ描画する。
bool AddGestureDetector (GestureDetector gestureDetector)
 ジェスチャー検出機構を追加する。
bool RemoveGestureDetector (GestureDetector gestureDetector)
 ジェスチャ検出機能を削除する。
override string ToString ()
 文字列を返す

Protected メソッド

virtual void Dispose (bool disposing)
 このウィジェット、および子ウィジェットの所有するアンマネージドリソースを解放する
virtual void DisposeSelf ()
 このウィジェットの所有するアンマネージドリソースを解放する
void AddChildFirst (Widget child)
 子ウィジェットを先頭に追加する。
void AddChildLast (Widget child)
 子ウィジェットを末尾に追加する。
void InsertChildBefore (Widget child, Widget nextChild)
 指定した子ウィジェットの直前に挿入する。
void InsertChildAfter (Widget child, Widget prevChild)
 指定した子ウィジェットの直後に挿入する。
void RemoveChild (Widget child)
 指定された子ウィジェットを削除する。
virtual internal void OnTouchEvent (TouchEventCollection touchEvents)
 タッチイベントハンドラ
virtual internal void OnKeyEvent (KeyEvent keyEvent)
 キーイベントハンドラ
virtual internal void OnPreviewKeyEvent (KeyEvent keyEvent)
 事前キーイベントのハンドラ
internal Widget SearchNextFocus (FourWayDirection direction)
 次にフォーカスの当たるウィジェットを探す
internal Widget SearchNextFocusFromChild (FourWayDirection direction, Widget currentFocusWidget)
 自分の子ウィジェット（子孫を含む）の中から次にフォーカスの当たるウィジェットを探す
virtual internal void OnMotionEvent (MotionEvent motionEvent)
 モーションイベントハンドラ
virtual internal void OnResetState ()
 状態リセットハンドラ
virtual void OnUpdate (float elapsedTime)
 更新処理
virtual internal void Render ()
 シーングラフを描画する。
internal void ResetState (bool includeSelf)
 自分以下の全ウィジェットの状態をリセットする。
virtual internal void SetupFinalAlpha ()
 最終的なアルファ値を計算する。
internal virtual void OnFocusChanged (FocusChangedEventArgs args)
 このウィジェットがフォーカスを取得または喪失したときに呼び出される
virtual void OnPressStateChanged (PressStateChangedEventArgs e)
 プレス状態が変化したときに呼び出される

プロパティ

String Name [get, set]
 ウィジェットの名前を取得・設定する。
internal RootUIElement RootUIElement [get]
 エレメントツリーのルートを取得する。
virtual float X [get, set]
 親の座標系でのX座標を取得・設定する。
virtual float Y [get, set]
 親の座標系でのY座標を取得・設定する。
virtual float Width [get, set]
 幅を取得・設定する。
virtual float Height [get, set]
 高さを取得・設定する。
virtual Matrix4 Transform3D [get, set]
 親の座標系への変換行列を取得・設定する。
virtual float Alpha [get, set]
 透明度を取得・設定する。（０～１）
virtual PivotType PivotType [get, set]
 ウィジェットの原点を取得・設定する。
virtual bool ZSort [get, set]
 Zソートするかどうかを取得・設定する。
virtual float ZSortOffset [get, set]
 Zソートオフセットを取得・設定する。
virtual Anchors Anchors [get, set]
 親のリサイズ時にどこを固定するかを取得・設定する。
virtual bool Visible [get, set]
 表示するかどうかを取得・設定する。
virtual bool TouchResponse [get, set]
 子ウィジェットも含めてタッチイベントに応答するかを取得・設定する。
internal bool Clip [get, set]
 子要素(Widget、UIElement)をクリップするかどうかを取得・設定する。
internal bool HookChildTouchEvent [get, set]
 子ウィジェットのタッチイベントをフックするかどうかを取得・設定する。
Widget Parent [get]
 親ウィジェットを取得する。
IEnumerable< Widget > Children [get]
 子ウィジェットを取得する。
bool Focused [get]
 現在自分にフォーカスが当たっているかどうかを取得する
Matrix4 LocalToWorld [get]
 ローカル座標系からワールド座標系に変換する行列を取得する。
virtual bool PriorityHit [get, set]
 優先してタッチに反応するかどうかを取得・設定する。
virtual bool Focusable [get, set]
 フォーカスが当たるかどうかを取得・設定する
virtual FocusCustomSettings FocusCustomSettings [get, set]
 フォーカスの設定情報を取得・設定する
FocusStyle FocusStyle [get, set]
 フォーカスの表示スタイルを取得・設定する
bool Pressable [get, set]
 タッチやキーでプレスできるかどうかを取得・設定する
virtual PressState PressState [get, set]
 このウィジェットが押されているかどうかの状態を取得・設定する
PressStateTouchLeaveBehavior TouchLeaveBehavior [get, set]
 タッチが領域の内側から外側に移動した場合のプレス状態の挙動を取得・設定する
virtual bool Enabled [get, set]
 機能を有効にするかどうかを取得・設定する

イベント

EventHandler< TouchEventArgs > TouchEventReceived
 タッチイベントを受け取ったときに呼び出されるハンドラ
EventHandler< KeyEventArgs > KeyEventReceived
 キーイベントを受け取ったときに呼び出されるハンドラ
EventHandler< KeyEventArgs > PreviewKeyEventReceived
 事前キーイベントを受け取ったときに呼び出されるハンドラ
EventHandler< MotionEventArgs > MotionEventReceived
 モーションイベントを受け取ったときに呼び出されるハンドラ
EventHandler
< FocusChangedEventArgs > 		FocusChanged
 このウィジェットがフォーカスを取得または喪失したときに呼び出されるイベント

説明

ウィジェットの基底クラス

メソッド

void AddChildFirst ( Widget  child) [protected]

子ウィジェットを先頭に追加する。

引数:
child追加する子ウィジェット

既に追加されている場合は先頭に移動する。

ContainerWidget, LiveScrollPanel, LiveSpringPanel, と ScrollPanelで再定義されています。

void AddChildLast ( Widget  child) [protected]

子ウィジェットを末尾に追加する。

引数:
child追加する子ウィジェット

既に追加されている場合は末尾に移動する。

ContainerWidget, LiveScrollPanel, LiveSpringPanel, と ScrollPanelで再定義されています。

bool AddGestureDetector ( GestureDetector  gestureDetector)

ジェスチャー検出機構を追加する。

引数:
gestureDetectorジェスチャ検出機構
例外:
ArgumentNullExceptionGestureDetectorがnull
戻り値:
追加できたかどうか
Vector2 ConvertLocalToOtherWidget ( Vector2  localPoint,
Widget  targetWidget 
)

指定した座標を自身のローカル座標系から他のWidgetのローカル座標系に変換する。

戻り値:
targetWidget のローカル座標系に変換された座標
引数:
targetWidget変換先の Widget
localPoint自身のローカル座標系の座標
Vector2 ConvertLocalToOtherWidget ( float  x,
float  y,
Widget  targetWidget 
)

指定した座標を自身のローカル座標系から他のWidgetのローカル座標系に変換する。

戻り値:
targetWidget のローカル座標系に変換された座標
引数:
targetWidget変換先の Widget
x自身のローカル座標系の座標 X
y自身のローカル座標系の座標 Y
Vector2 ConvertLocalToScreen ( Vector2  localPoint)

指定した座標をローカル座標系からスクリーン座標系に変換する。

戻り値:
スクリーン座標系に変換された座標
引数:
localPointーカル座標系の座標
Vector2 ConvertLocalToScreen ( float  localX,
float  localY 
)

指定した座標をローカル座標系からスクリーン座標系に変換する。

戻り値:
スクリーン座標系に変換された座標
引数:
localXローカル座標系の座標 X
localYローカル座標系の座標 Y
Vector2 ConvertScreenToLocal ( Vector2  screenPoint)

指定した座標をスクリーン座標系からローカル座標系に変換する。

戻り値:
ローカル座標系に変換された座標
引数:
screenPointスクリーン座標系の座標
Vector2 ConvertScreenToLocal ( float  screenX,
float  screenY 
)

指定した座標をスクリーン座標系からローカル座標系に変換する。

戻り値:
ローカル座標系に変換された座標
引数:
screenXスクリーン座標系の座標 X
screenYスクリーン座標系の座標 Y
virtual void Dispose ( bool  disposing) [protected, virtual]

このウィジェット、および子ウィジェットの所有するアンマネージドリソースを解放する

親ウィジェットから自身を削除し、子ウィジェットに対して DisposeSelf() を再帰的に呼び出します。 派生クラスでDisposeを実装する場合は DisposeSelf() をオーバーライドしてください。

引数:
disposingDispose() から呼び出された場合 true
void Dispose ( )

このウィジェット、および子ウィジェットの所有するアンマネージドリソースを解放する

このウィジェットとそのツリー以下のすべてのウィジェット、およびそれぞれの RootUIElement のツリーに所属するすべての UIElement を再帰的に解放します。 一度 Dispose() が呼ばれたウィジェットは再利用することはできません。 ウィジェット派生クラスでツリーに所属しないウィジェットやUIElement、その他の Dispose が必要なオブジェクトを作成した場合は、 DisposeSelf() をオーバーライドしてそれらの Dispose を呼ばなければなりません。

virtual void DisposeSelf ( ) [protected, virtual]

このウィジェットの所有するアンマネージドリソースを解放する

このメソッドは Dispose() からその子ウィジェットに対して再帰的に呼び出されます。 ウィジェット派生クラスでツリーに所属しないウィジェットやUIElement、その他の Dispose が必要なオブジェクトを作成した場合は、 このメソッドをオーバーライドしてそれらの Dispose を呼ばなければなりません。

BusyIndicator, Button, CheckBox, Dialog, EditableText, Label, ListPanelItem, LiveFlipPanel, LiveScrollPanel, MessageDialog, PagePanel, PopupList, ProgressBar, ScrollBar, Slider, と UIAnimationPlayerで再定義されています。

virtual bool HitTest ( Vector2  screenPoint) [virtual]

指定した座標でこのウィジェットがヒットするかどうかを取得する

引数:
screenPointスクリーン座標系での位置
戻り値:
ヒットしている場合はtrue。ヒットしていない場合はfalse。

DatePicker, RootWidget, と TimePickerで再定義されています。

void InsertChildAfter ( Widget  child,
Widget  prevChild 
) [protected]

指定した子ウィジェットの直後に挿入する。

引数:
child挿入する子ウィジェット
prevChild挿入する子ウィジェットの直前となる子ウィジェット

既に追加されている場合は指定した子ウィジェットの直後に移動する。

ContainerWidget, LiveScrollPanel, LiveSpringPanel, と ScrollPanelで再定義されています。

void InsertChildBefore ( Widget  child,
Widget  nextChild 
) [protected]

指定した子ウィジェットの直前に挿入する。

引数:
child挿入する子ウィジェット
nextChild挿入する子ウィジェットの直後となる子ウィジェット

既に追加されている場合は指定した子ウィジェットの直前に移動する。

ContainerWidget, LiveScrollPanel, LiveSpringPanel, と ScrollPanelで再定義されています。

virtual internal void OnKeyEvent ( KeyEvent  keyEvent) [protected, virtual]

キーイベントハンドラ

引数:
keyEventキーイベント
virtual internal void OnMotionEvent ( MotionEvent  motionEvent) [protected, virtual]

モーションイベントハンドラ

引数:
motionEventモーションイベント

LiveSpringPanelで再定義されています。

virtual void OnPressStateChanged ( PressStateChangedEventArgs  e) [protected, virtual]

プレス状態が変化したときに呼び出される

引数:
eイベント引数

Button, CheckBox, EditableText, ListPanelItem, と PopupListで再定義されています。

virtual internal void OnPreviewKeyEvent ( KeyEvent  keyEvent) [protected, virtual]

事前キーイベントのハンドラ

引数:
keyEventキーイベント

GridListPanel, ListPanel, LiveListPanel, PagePanel, ScrollPanel, と Sliderで再定義されています。

virtual internal void OnTouchEvent ( TouchEventCollection  touchEvents) [protected, virtual]

タッチイベントハンドラ

引数:
touchEventsタッチイベント

GridListPanel, ListPanel, LiveFlipPanel, LiveListPanel, LiveScrollPanel, LiveSphere, PagePanel, Panel, と ScrollPanelで再定義されています。

virtual void OnUpdate ( float  elapsedTime) [protected, virtual]

更新処理

引数:
elapsedTime前回のUpdateからの経過時間（ミリ秒）

AnimationImageBox, Button, EditableText, GridListPanel, ListPanel, LiveFlipPanel, LiveJumpPanel, LiveListPanel, LiveScrollPanel, LiveSphere, LiveSpringPanel, PagePanel, ProgressBar, と ScrollPanelで再定義されています。

void RemoveChild ( Widget  child) [protected]

指定された子ウィジェットを削除する。

引数:
child削除する子ウィジェット

ContainerWidget, LiveScrollPanel, LiveSpringPanel, と ScrollPanelで再定義されています。

bool RemoveGestureDetector ( GestureDetector  gestureDetector)

ジェスチャ検出機能を削除する。

引数:
gestureDetectorジェスチャ検出機構
例外:
ArgumentNullExceptionGestureDetectorがnull
戻り値:
削除できたかどうか
void RenderToFrameBuffer ( FrameBuffer  frameBuffer)

フレームバッファへ描画する。

引数:
frameBufferフレームバッファ
void RenderToFrameBuffer ( FrameBuffer  frameBuffer,
Matrix4  transform 
)

フレームバッファへ描画する。

引数:
frameBufferフレームバッファ
transform変換行列
void RenderToTexture ( Texture2D  texture)

テクスチャへ描画する。

引数:
texture2Dのテクスチャ
void RenderToTexture ( Texture2D  texture,
Matrix4  transform 
)

テクスチャへ描画する。

引数:
texture2Dのテクスチャ
transform変換行列
internal void ResetState ( bool  includeSelf) [protected]

自分以下の全ウィジェットの状態をリセットする。

引数:
includeSelf自分をリセットする場合はtrue。自分をリセットしない場合はfalse。
internal Widget SearchNextFocus ( FourWayDirection  direction) [protected]

次にフォーカスの当たるウィジェットを探す

引数:
direction方向キーの方向
戻り値:
見つからない場合は null
internal Widget SearchNextFocusFromChild ( FourWayDirection  direction,
Widget  currentFocusWidget 
) [protected]

自分の子ウィジェット（子孫を含む）の中から次にフォーカスの当たるウィジェットを探す

自分自身は検索対象から除きます。

引数:
direction方向キーの方向
currentFocusWidget現在フォーカスのあるウィジェット
戻り値:
見つからない場合は null
void SetFocus ( bool  active)

自分自身にフォーカスをあてる

引数:
activetrue: フォーカスをアクティブにする false: 現状維持

Focusable、Visible、Enabledプロパティおよび表示範囲内にあるかにかかわらずフォーカスを設定します。 active を true に設定した場合でも、所属するSceneがフォーカス対象のSceneでない場合はフォーカスがアクティブになりません。

virtual void SetPosition ( float  x,
float  y 
) [virtual]

親の座標系での位置を設定する。

引数:
x親の座標系でのX座標
y親の座標系でのY座標
virtual void SetSize ( float  width,
float  height 
) [virtual]

サイズを設定する。

引数:
width幅
height高さ

LiveSphereで再定義されています。

override string ToString ( )

文字列を返す

戻り値:
"Name : 型名" 形式の文字列（Nameプロパティが設定されている場合）

プロパティ

virtual float Alpha [get, set]

透明度を取得・設定する。（０～１）

すべての子Widgetに透明度が乗算されて表示される。

IEnumerable<Widget> Children [get, protected]

子ウィジェットを取得する。

コレクションを反復処理する列挙子を返す。

ContainerWidget, LiveScrollPanel, と ScrollPanelで再定義されています。

internal bool Clip [get, set, protected]

子要素(Widget、UIElement)をクリップするかどうかを取得・設定する。

クリップ領域は2次元の座標として計算される。

Panelで再定義されています。

virtual bool Focusable [get, set]

フォーカスが当たるかどうかを取得・設定する

親ウィジェットが false でも、子ウィジェットが true であれば子ウィジェットにフォーカスが当たる可能性があります。

PagePanel, と ScrollPanelで再定義されています。

String Name [get, set]

ウィジェットの名前を取得・設定する。

このプロパティはアプリケーションで任意に使用可能。

virtual PivotType PivotType [get, set]

ウィジェットの原点を取得・設定する。

移動、回転、スケーリングするときの中心となる点。

PressStateTouchLeaveBehavior TouchLeaveBehavior [get, set, protected]

タッチが領域の内側から外側に移動した場合のプレス状態の挙動を取得・設定する

この値は Pressable プロパティがtrueの場合のみ有効です。