webcface.view module

class webcface.view.View(base: Field, field: str = '')[source]

Bases: Field

add(*args: TemporalComponent | str | bool | SupportsFloat, **kwargs) → View[source]

Viewに要素を追加

Parameters:: args – 追加する要素

複数指定した場合すべて追加される。 :arg kwargs: (ver3.0〜) argsが初期化済みの要素でない場合、要素の初期化時に渡すオプション。詳細は TemporalComponent のコンストラクタを参照

child(field: str) → View[source]

子フィールドを返す

Returns:: 「(thisのフィールド名).(子フィールド名)」をフィールド名とするView

exists() → bool[source]

このフィールドにデータが存在すればtrue (ver2.0〜)

try_get() などとは違って、実際のデータを受信しない。リクエストもしない。

get() → List[ViewComponent][source]: Viewをlistで返す、まだリクエストされてなければ自動でリクエストされる

init() → View[source]: このViewオブジェクトにaddした内容を初期化する

property member: Member: Memberを返す

property name: str: field名を返す

on_change(func: Callable) → Callable[source]

値が変化したときのイベント (ver2.0〜)

コールバックの引数にはViewオブジェクトが渡される。

まだ値をリクエストされてなければ自動でリクエストされる

request() → None[source]: 値の受信をリクエストする

set(components: List[TemporalComponent | str | bool | SupportsFloat]) → View[source]: Viewのリストをセットする

Deprecated since version ver3.0.

sync() → View[source]: Viewの内容をclientに反映し送信可能にする

try_get() → List[ViewComponent] | None[source]: ViewをlistまたはNoneで返す、まだリクエストされてなければ自動でリクエストされる

class webcface.view.ViewComponent(base: ViewComponentBase, data: ClientData | None, id: str)[source]

Bases: ViewComponentBase

property bg_color: int

背景の色

ViewColor Enumを使う

property bind: Variant | None

inputの現在の値を取得 (ver2.0〜)

viewを作成したときにbindしたかon_changeをセットしたかに関わらず、値の変更はbindではなくon_changeから行う

property id: str: 要素のid (ver3.0〜)

property max: float | None: inputの最大値 (ver2.0〜)

property min: float | None: inputの最小値 (ver2.0〜)

property on_change: Func | None

値が変化したときに呼び出す関数 (ver2.0〜)

run_asyncの引数に変更後の値を入れて呼び出すことで、inputの値を変更する

内部実装はon_clickと共通になっている

property on_click: Func | None: クリックしたときに呼び出す関数

property option: List[float | bool | str]: inputの選択肢 (ver2.0〜)

property step: float | None: inputの刻み幅 (ver2.0〜)

property text: str: 表示する文字列

property text_color: int

文字の色

ViewColor Enumを使う

property type: int

コンポーネントの種類

ViewComponentType Enumを使う

class webcface.view.ViewData[source]

Bases: object

components: Dict[str, ViewComponentBase]

ids: List[str]

tmp_components: List[TemporalComponent]