App:Library:LVGL:docs:Overview:Objects

提供: robot-jp wiki
ナビゲーションに移動検索に移動

https://docs.lvgl.io/8.2/overview/object.html

Objects

英文 自動翻訳

In LVGL the basic building blocks of a user interface are the objects, also called Widgets.

For example a Button, Label, Image, List, Chart or Text area.


You can see all the Object types here.


All objects are referenced using an lv_obj_t pointer as a handle.

This pointer can later be used to set or get the attributes of the object.

LVGLでは、ユーザー・インターフェースの基本的な構成要素は、ウィジェットとも呼ばれるオブジェクトです。

例えば、 Button, Label, Image, List, Chart or Text areaなどです。


すべての Object types をここで見ることができます。


すべてのオブジェクトは、lv_obj_t ポインタをハンドルとして参照されます。

このポインタは、後で、オブジェクトの属性を設定したり、取得したりするために使用されます。

戻る : Previous


Attributes

Basic attributes

英文 自動翻訳

All object types share some basic attributes:

  • Position
  • Size
  • Parent
  • Styles
  • Event handlers
  • Etc


You can set/get these attributes with lv_obj_set_... and lv_obj_get_... functions.

For example:

 /*Set basic object attributes*/
 lv_obj_set_size(btn1, 100, 50);	  /*Set a button's size*/
 lv_obj_set_pos(btn1, 20,30);      /*Set a button's position*/ 

To see all the available functions visit the Base object's documentation.

すべてのオブジェクトタイプは、いくつかの基本的な属性を共有しています。
  • Position
  • Size
  • Parent
  • Styles
  • Event handlers
  • Etc


これらの属性は, lv_obj_set_... and lv_obj_get_... 関数で設定/取得することができます.

For example:

 /*Set basic object attributes*/
 lv_obj_set_size(btn1, 100, 50);	  /*Set a button's size*/
 lv_obj_set_pos(btn1, 20,30);      /*Set a button's position*/ 

使用可能なすべての関数については、 Base object's documentationを参照してください。

戻る : Previous

Specific attributes

英文 自動翻訳

The object types have special attributes too. For example, a slider has

  • Minimum and maximum values
  • Current value


For these special attributes, every object type may have unique API functions.

For example for a slider:

 /*Set slider specific attributes*/
 lv_slider_set_range(slider1, 0, 100);	   				/*Set the min. and max. values*/
 lv_slider_set_value(slider1, 40, LV_ANIM_ON);		/*Set the current value (position)*/

The API of the widgets is described in their Documentation but you can also check the respective header files (e.g. widgets/lv_slider.h)

オブジェクト型にも特殊な属性があります。たとえば、スライダには
  • 最小値と最大値
  • 現在の値


これらの特殊な属性では、すべてのオブジェクトタイプに固有のAPI関数があります。

スライダの例:

 /*Set slider specific attributes*/
 lv_slider_set_range(slider1, 0, 100);	   				/*Set the min. and max. values*/
 lv_slider_set_value(slider1, 40, LV_ANIM_ON);		/*Set the current value (position)*/

ウィジェットのAPIはそれぞれの Documentation but you can に記載されていますが、ヘッダファイル (e.g. widgets/lv_slider.h)で確認することもできます。

戻る : Previous

Working mechanisms

Parent-child structure

英文 自動翻訳

A parent object can be considered as the container of its children.

Every object has exactly one parent object (except screens), but a parent can have any number of children.

There is no limitation for the type of the parent but there are objects which are typically a parent (e.g. button) or a child (e.g. label).

親オブジェクトは、その子オブジェクトのコンテナと考えることができます。


すべてのオブジェクトは正確に1つの親オブジェクトを持ちますが(スクリーンを除く)、親は任意の数の子を持つことができます。


親のタイプに制限はありませんが、典型的な親(例:ボタン)または子(例:ラベル)になるオブジェクトがあります。

戻る : Previous


Moving together

英文 自動翻訳

If the position of a parent changes, the children will move along with it.

Therefore, all positions are relative to the parent.

LVGL docs overview objects 01.png

lv_obj_t * parent = lv_obj_create(lv_scr_act());   /*Create a parent object on the current screen*/
lv_obj_set_size(parent, 100, 80);	                 /*Set the size of the parent*/

lv_obj_t * obj1 = lv_obj_create(parent);	         /*Create an object on the previously created parent object*/
lv_obj_set_pos(obj1, 10, 10);	                     /*Set the position of the new object*/


Modify the position of the parent:

LVGL docs overview objects 02.png

lv_obj_set_pos(parent, 50, 50);	/*Move the parent. The child will move with it.*/

(For simplicity the adjusting of colors of the objects is not shown in the example.)

戻る : Previous


Visibility only on the parent

英文 自動翻訳

If a child is partially or fully outside its parent then the parts outside will not be visible.

LVGL docs overview objects 03.png

lv_obj_set_x(obj1, -30);	/*Move the child a little bit off the parent*/

This behavior can be overwritten with lv_obj_add_flag(obj, LV_OBJ_FLAG_OVERFLOW_VISIBLE); which allow the children to be drawn out of the parent.

この動作は lv_obj_add_flag(obj, LV_OBJ_FLAG_OVERFLOW_VISIBLE);で上書きすることができ、これにより親から子への描画が可能になります。
戻る : Previous


Create and delete objects

英文 自動翻訳

In LVGL, objects can be created and deleted dynamically at run time.

It means only the currently created (existing) objects consume RAM.

This allows for the creation of a screen just when a button is clicked to open it, and for deletion of screens when a new screen is loaded.


UIs can be created based on the current environment of the device.

For example one can create meters, charts, bars and sliders based on the currently attached sensors.


Every widget has its own create function with a prototype like this:

 lv_obj_t * lv_<widget>_create(lv_obj_t * parent, <other parameters if any>);


Typically, the create functions only have a parent parameter telling them on which object to create the new widget.

The return value is a pointer to the created object with lv_obj_t * type.


There is a common delete function for all object types.

It deletes the object and all of its children.

 void lv_obj_del(lv_obj_t * obj);
<code style="color: #bb0000;">lv_obj_del</code> will delete the object immediately. If for any reason you can't delete the object immediately you can use <c

ode>lv_obj_del_async(obj) which will perform the deletion on the next call of lv_timer_handler().


This is useful e.g. if you want to delete the parent of an object in the child's LV_EVENT_DELETE handler.

You can remove all the children of an object (but not the object itself) using lv_obj_clean(obj).

You can use lv_obj_del_delayed(obj, 1000) to delete an object after some time. The delay is expressed in milliseconds.

LVGLでは、オブジェクトは実行時に動的に作成・削除することができます。

つまり、現在作成されている(既存の)オブジェクトだけがRAMを消費します。

このため、ボタンをクリックして画面を開くだけで画面を作成したり、新しい画面を読み込むと画面を削除したりすることが可能です。

端末の現在の環境に応じたUIを作成することができる。

例えば、現在装着されているセンサーを元にメーター、チャート、バー、スライダーを作成することができます。

各ウィジェットは、このようなプロトタイプを持つ独自のcreate関数を持っています。
 lv_obj_t * lv_<widget>_create(lv_obj_t * parent, <other parameters if any>);


一般に、create 関数は、どのオブジェクトに新しいウィジェットを作成するかを示す親パラメータを持つだけです。

戻り値は、lv_obj_t * 型の作成されたオブジェクトへのポインタです。

すべてのオブジェクトタイプに共通の delete 関数があります。

これは、オブジェクトとその子オブジェクトをすべて削除します。
 void lv_obj_del(lv_obj_t * obj);
<code style="color: #bb0000;">lv_obj_del</code> will delete the object immediately. If for any reason you can't delete the object immediately you can use <c

ode>lv_obj_del_async(obj) とすると、次の lv_timer_handler() のコールで削除が実行されます。


これは、例えば、子の LV_EVENT_DELETEハンドラで、オブジェクトの親を削除したい場合に便利です。


lv_obj_clean(obj)を使用すると、オブジェクトのすべての子を削除できます(ただし、オブジェクト自身は削除されません)。


lv_obj_del_delayed(obj, 1000)を使用すると、ある時間後にオブジェクトを削除することができます。遅延時間はミリ秒単位で表されます。

戻る : Previous


Screens

Create screens

英文 自動翻訳

The screens are special objects which have no parent object.

So they can be created like:

 lv_obj_t * scr1 = lv_obj_create(NULL);

Screens can be created with any object type.

For example, a Base object or an image to make a wallpaper.

スクリーンは、親オブジェクトを持たない特別なオブジェクトです。 そのため、次のように作成することができます。
 lv_obj_t * scr1 = lv_obj_create(NULL);

画面は、どのようなオブジェクトタイプでも作成することができます。

例えば、 Base object や画像を使って壁紙を作ることができます。

戻る : Previous


Get the active screen

英文 自動翻訳

There is always an active screen on each display.

By default, the library creates and loads a "Base object" as a screen for each display.

To get the currently active screen use the lv_scr_act() function.

各ディスプレイには、常にアクティブなスクリーンが存在します。

デフォルトでは、ライブラリは各ディスプレイのスクリーンとして "Base object" を作成し、ロードします。

現在アクティブな画面を取得するには、lv_scr_act()関数を使用します。

戻る : Previous


Load screens

英文 自動翻訳

To load a new screen, use lv_scr_load(scr1).

新しい画面を読み込むには、 lv_scr_load(scr1)を使用します。
戻る : Previous


Layers

英文 自動翻訳

There are two automatically generated layers:

  • top layer
  • system layer


They are independent of the screens and they will be shown on every screen.

The top layer is above every object on the screen and the system layer is above the top layer.

You can add any pop-up windows to the top layer freely.

But, the system layer is restricted to system-level things (e.g. mouse cursor will be placed there with lv_indev_set_cursor()).

The lv_layer_top() and lv_layer_sys() functions return pointers to the top and system layers respectively.


Read the Layer overview section to learn more about layers.

自動生成されるレイヤーは2つです。
  • top layer
  • system layer


これらはスクリーンから独立しており、どのスクリーンにも表示されます。

トップレイヤーは画面上のあらゆるオブジェクトの上にあり、システムレイヤーはトップレイヤーの上にあります。

トップレイヤーには、任意のポップアップウィンドウを自由に追加することができます。


しかし、システムレイヤーはシステムレベルのものに限定されます(例えば、マウスカーソルはlv_indev_set_cursor()でそこに配置されます)。

lv_layer_top()lv_layer_sys() 関数は、それぞれトップレイヤーとシステムレイヤーへのポインタを返します。


レイヤーについてもっと知るには、 Layer overview section を読んでください。

戻る : Previous


Load screen with animation

英文 自動翻訳

A new screen can be loaded with animation by using lv_scr_load_anim(scr, transition_type, time, delay, auto_del). The following transition types exist:

  • LV_SCR_LOAD_ANIM_NONE Switch immediately after delay milliseconds
  • LV_SCR_LOAD_ANIM_OVER_LEFT/RIGHT/TOP/BOTTOM Move the new screen over the current towards the given direction
  • LV_SCR_LOAD_ANIM_MOVE_LEFT/RIGHT/TOP/BOTTOM Move both the current and new screens towards the given direction
  • LV_SCR_LOAD_ANIM_FADE_ON Fade the new screen over the old screen


Setting auto_del to true will automatically delete the old screen when the animation is finished.

The new screen will become active (returned by lv_scr_act()) when the animation starts after delay time.

lv_scr_load_anim(scr, transition_type, time, delay, auto_del) を使用すると、新しいスクリーンにアニメーションをロードすることができます。以下のトランジションタイプが存在します:
  • LV_SCR_LOAD_ANIM_NONEdelay ミリ秒後に即座に切り替わる。
  • LV_SCR_LOAD_ANIM_OVER_LEFT/RIGHT/TOP/BOTTOM 現在の画面の上に指定された方向へ移動します。
  • LV_SCR_LOAD_ANIM_MOVE_LEFT/RIGHT/TOP/BOTTOM 現在の画面と新しい画面の両方を指定された方向へ移動させる
  • LV_SCR_LOAD_ANIM_FADE_ON 古い画面の上に新しい画面をフェードさせる


Setting auto_deltrue に設定すると、アニメーションが終了したときに古い画面が自動的に削除される。

新しい画面は、delay time後にアニメーションが始まるとアクティブになります (returned by lv_scr_act())

戻る : Previous


Handling multiple displays

英文 自動翻訳

Screens are created on the currently selected default display.

The default display is the last registered display with lv_disp_drv_register.

You can also explicitly select a new default display using lv_disp_set_default(disp).

lv_scr_act(), lv_scr_load() and lv_scr_load_anim() operate on the default screen.


Visit Multi-display support to learn more.

画面は、現在選択されているデフォルト・ディスプレイで作成されます。

デフォルトディスプレイは、lv_disp_drv_registerで最後に登録されたディスプレイです。

lv_disp_set_default(disp)を使用して、明示的に新しいデフォルトディスプレイを選択することも可能です。

lv_scr_act(), lv_scr_load() , lv_scr_load_anim() はデフォルトスクリーンで操作します。

詳細については、 Multi-display support を参照してください。

戻る : Previous


Parts

英文 自動翻訳

The widgets are built from multiple parts.

For example a Base object uses the main and scrollbar parts but a Slider uses the main, indicator and knob parts.

Parts are similar to pseudo-elements in CSS.

The following predefined parts exist in LVGL:

  • LV_PART_MAIN A background like rectangle
  • LV_PART_SCROLLBAR The scrollbar(s)
  • LV_PART_INDICATOR Indicator, e.g. for slider, bar, switch, or the tick box of the checkbox
  • LV_PART_KNOB Like a handle to grab to adjust the value
  • LV_PART_SELECTED Indicate the currently selected option or section
  • LV_PART_ITEMS Used if the widget has multiple similar elements (e.g. table cells)
  • LV_PART_TICKS Ticks on scales e.g. for a chart or meter
  • LV_PART_CURSOR Mark a specific place e.g. text area's or chart's cursor
  • LV_PART_CUSTOM_FIRST Custom parts can be added from here.


The main purpose of parts is to allow styling the "components" of the widgets.

They are described in more detail in the Style overview section.

ウィジェットは、複数のパーツから構成されています。

たとえば Base オブジェクトは main と scrollbar のパーツを使いますが、Slider は main、indicator、knob のパーツを使用します。

パーツは、CSSの擬似要素に似ています。

LVGLには以下の定義済みパーツが存在します。

  • LV_PART_MAIN 矩形のような背景画像
  • LV_PART_SCROLLBAR スクロールバー。
  • LV_PART_INDICATORスライダ、バー、スイッチ、チェックボックスなどのインジケータ
  • LV_PART_KNOB 値を調整するためにつかむハンドルのようなもの
  • LV_PART_SELECTED 現在選択されているオプションやセクションを表すもの
  • LV_PART_ITEMS ウィジェットに複数の類似した要素(例:テーブルセル)がある場合に使用されます。
  • LV_PART_TICKS グラフやメーターのような目盛りの刻み目
  • LV_PART_CURSOR テキストエリアやグラフのカーソルなど、特定の場所を示すマーク
  • LV_PART_CUSTOM_FIRST ここからカスタムパーツを追加することができます。


パーツの主な目的は、ウィジェットの「コンポーネント」をスタイリングできるようにすることです。

詳細については、 Style overview section で説明します。

戻る : Previous


States

英文 自動翻訳

The object can be in a combination of the following states:

  • LV_STATE_DEFAULT Normal, released state
  • LV_STATE_CHECKED Toggled or checked state
  • LV_STATE_FOCUSED Focused via keypad or encoder or clicked via touchpad/mouse
  • LV_STATE_FOCUS_KEY Focused via keypad or encoder but not via touchpad/mouse
  • LV_STATE_EDITED Edit by an encoder
  • LV_STATE_HOVERED Hovered by mouse (not supported now)
  • LV_STATE_PRESSED Being pressed
  • LV_STATE_SCROLLED Being scrolled
  • LV_STATE_DISABLED Disabled state
  • LV_STATE_USER_1 Custom state
  • LV_STATE_USER_2 Custom state
  • LV_STATE_USER_3 Custom state
  • LV_STATE_USER_4 Custom state


The states are usually automatically changed by the library as the userinteracts qith an object (presses, releases, focuses, etc.).

However, the states can be changed manually too.

To set or clear given state (but leave the other states untouched) use lv_obj_add/clear_state(obj, LV_STATE_...) In both cases OR-ed state values can be used as well.

E.g. lv_obj_add_state(obj, part, LV_STATE_PRESSED | LV_PRESSED_CHECKED).

To learn more about the states read the related section of the Style overview.

オブジェクトは、以下の状態の組み合わせであり得る。
  • LV_STATE_DEFAULT 通常状態、解除状態
  • LV_STATE_CHECKED トグル状態またはチェック状態
  • LV_STATE_FOCUSED キーパッドまたはエンコーダでフォーカス、またはタッチパッド/マウスでクリックされた状態
  • LV_STATE_FOCUS_KEY キーパッドまたはエンコーダでフォーカスされ、タッチパッド/マウスでフォーカスされない状態
  • LV_STATE_EDITED エンコーダで編集されたもの
  • LV_STATE_HOVERED マウスでホバリングする(現在はサポートされていません)。
  • LV_STATE_PRESSED 押された状態
  • LV_STATE_SCROLLED スクロールされている状態
  • LV_STATE_DISABLED 無効状態
  • LV_STATE_USER_1 カスタム状態
  • LV_STATE_USER_2 カスタム状態
  • LV_STATE_USER_3 カスタム状態
  • LV_STATE_USER_4 カスタム状態


通常、ユーザーがオブジェクトを操作(押す、離す、フォーカスするなど)すると、ライブラリによって状態が自動的に変更されます。

しかし、状態を手動で変更することもできます。

与えられた状態を設定またはクリアするには(他の状態はそのままにして) lv_obj_add/clear_state(obj, LV_STATE_...) を使います。どちらの場合も、状態の値を OR にすることができます。

例えば、 lv_obj_add_state(obj, part, LV_STATE_PRESSED | LV_PRESSED_CHECKED)のように。

ステートの詳細については、スタイル概要の関連セクションを参照してください。

戻る : Previous


Snapshot

英文 自動翻訳

A snapshot image can be generated for an object together with its children. Check details in Snapshot.

オブジェクトとその子オブジェクトに対して、スナップショット画像を生成することができます。詳しくはSnapshotでご確認ください。


戻る : Previous