「App:Library:LVGL:docs:Widgets:Base object」の版間の差分

提供: robot-jp wiki
ナビゲーションに移動検索に移動
 
(同じ利用者による、間の47版が非表示)
1行目: 1行目:
 +
https://docs.lvgl.io/latest/en/html/widgets/obj.html
 +
 
https://docs.lvgl.io/8.2/widgets/index.html
 
https://docs.lvgl.io/8.2/widgets/index.html
−
__NOTOC__
+
 
 +
 
 +
= Base object (lv_obj) =
 +
== Overview ==
 
{| class="wikitable"
 
{| class="wikitable"
 
!英文
 
!英文
6行目: 11行目:
 
|-
 
|-
 
|
 
|
−
|
 
−
|}
 
−
 
−
 
−
 
−
= Base object (lv_obj) =
 
−
 
−
== Overview ==
 
 
The 'Base Object' implements the basic properties of widgets on a screen, such as:
 
The 'Base Object' implements the basic properties of widgets on a screen, such as:
  
23行目: 20行目:
  
  
−
In object-oriented thinking, it is the base class from which all other objects in LVGL are inherited.
 
  
−
The functions and functionalities of the Base object can be used with other widgets too. For example <code style="color: #bb0000;">lv_obj_set_width(slider, 100)</code>
+
In object-oriented thinking, it is the base class from which all other objects in LVGL are inherited.
 +
 
 +
This, among another things, helps reduce code duplication.
 +
 
 +
The functions and functionalities of Base object can be used with other widgets too. For example <code style="color: #bb0000;">lv_obj_set_width(slider, 100)</code>
 +
 
 +
 
 +
The Base object can be directly used as a simple widgets. It nothing else then a rectangle.
 +
|ベースオブジェクト」は、画面上のウィジェットの基本的なプロパティを実装したもので、次のようなものです。
 +
 
 +
* 座標
 +
* 親オブジェクト
 +
* 子供
 +
* スタイルが含まれています
 +
*''Clickable''、''Scrollable''などの属性。
  
  
−
The Base object can be directly used as a simple widget: it's nothing more than a rectangle. In HTML terms, think of it as a <code style="color: #bb0000;"><nowiki><div></nowiki></code>.
+
 
 +
オブジェクト指向の考え方では、LVGL の他のすべてのオブジェクトが継承される基本クラスです。
 +
 
 +
これはコードの重複を減らすのに役立ちます。
 +
 
 +
 
 +
 
 +
Base オブジェクトの関数と機能は、他のウィジェットでも使用できます。 例えば <code style="color: #bb0000;">lv_obj_set_width(slider, 100)</code>
 +
 
 +
 
 +
 
 +
Base オブジェクトは、単純なウィジェットとして直接使用できます。 長方形に他なりません。
 +
|}
 +
:[[App:Library:LVGL:docs:Widgets|戻る : Previous]]
 +
 
  
 
=== Coordinates ===
 
=== Coordinates ===
−
Only a small subset of coordinate settings is described here. To see all the features of LVGL (padding, coordinates in styles, layouts, etc) visit the Coordinates page.
 
  
 
==== Size ====
 
==== Size ====
 +
{| class="wikitable"
 +
!英文
 +
!自動翻訳
 +
|-
 +
|
 
The object size can be modified on individual axes with <code style="color: #bb0000;">lv_obj_set_width(obj, new_width)</code> and <code style="color: #bb0000;">lv_obj_set_height(obj, new_height)</code>, or both axes can be modified at the same time with <code style="color: #bb0000;">lv_obj_set_size(obj, new_width, new_height)</code>.
 
The object size can be modified on individual axes with <code style="color: #bb0000;">lv_obj_set_width(obj, new_width)</code> and <code style="color: #bb0000;">lv_obj_set_height(obj, new_height)</code>, or both axes can be modified at the same time with <code style="color: #bb0000;">lv_obj_set_size(obj, new_width, new_height)</code>.
 +
 +
 +
Styles can add Margin to the objects. Margin tells that "I want this space around me". To set width or height reduced by the margin <code style="color: #bb0000;">lv_obj_set_width_margin(obj, new_width)</code> or <code style="color: #bb0000;">lv_obj_set_height_margin(obj, new_height)</code>. In more exact way: <code style="color: #bb0000;">new_width = left_margin + object_width + right_margin</code>.
 +
 +
 +
To get the width or height which includes the margins use <code style="color: #bb0000;">lv_obj_get_width/height_margin(obj)</code>.
 +
 +
 +
 +
Styles can add Padding to the object as well. Padding means "I don't want my children too close to my sides, so keep this space".
 +
 +
To set width or height reduced by the padding <code style="color: #bb0000;">lv_obj_set_width_fit(obj, new_width)</code> or <code style="color: #bb0000;">lv_obj_set_height_fit(obj, new_height)</code>.
 +
 +
In a more exact way: <code style="color: #bb0000;">new_width = left_pad + object_width + right_pad</code>
 +
 +
To get the width or height which is REDUCED by padding use <code style="color: #bb0000;">lv_obj_get_width/height_fit(obj)</code>.
 +
 +
It can be considered the "useful size of the object".
 +
 +
 +
 +
Margin and padding gets important when Layout or Auto-fit is used by other widgets.
 +
|オブジェクトのサイズは、<code style="color: #bb0000;">lv_obj_set_width(obj, new_width)</code>および<code style="color: #bb0000;">lv_obj_set_height(obj, new_height)</code>を使用して個々の軸上で変更することも、<code style="color: #bb0000;">lv_obj_set_size(obj, new_width, new_height)</code>を使用して両方の軸を同時に変更することもできます。
 +
 +
 +
 +
スタイルは、オブジェクトに余白を追加できます。 マージンは「自分の周りにこのスペースが欲しい」と語っています。 マージン <code style="color: #bb0000;">lv_obj_set_width_margin(obj, new_width)</code>または <code style="color: #bb0000;">lv_obj_set_height_margin(obj, new_height)</code> だけ縮小された幅または高さを設定します。 より正確には、<code style="color: #bb0000;">new_width = left_margin + object_width + right_margin</code> です。
 +
 +
 +
 +
マージンを含む幅または高さを取得するには、<code style="color: #bb0000;">lv_obj_get_width/height_margin(obj)</code>を使用します。
 +
 +
 +
 +
スタイルは、オブジェクトにパディングを追加することもできます。 パディングとは、「子供たちを脇に近づけたくないので、このスペースを確保してください」という意味です。
 +
 +
パディング <code style="color: #bb0000;">lv_obj_set_width_fit(obj, new_width)</code> または <code style="color: #bb0000;">lv_obj_set_height_fit(obj, new_height)</code>によって縮小された幅または高さを設定します。
 +
 +
より正確な方法: <code style="color: #bb0000;">new_width = left_pad + object_width + right_pad</code>
 +
 +
パディングによって削減された幅または高さを取得するには、<code style="color: #bb0000;">lv_obj_get_width/height_fit(obj)</code>を使用します。
 +
 +
これは「オブジェクトの有用なサイズ」と見なすことができます。
 +
 +
 +
 +
レイアウトまたは自動調整が他のウィジェットで使用されている場合、マージンとパディングが重要になります。
 +
|}
 +
:[[App:Library:LVGL:docs:Widgets|戻る : Previous]]
 +
  
 
==== Position ====
 
==== Position ====
 +
{| class="wikitable"
 +
!英文
 +
!自動翻訳
 +
|-
 +
|
 
You can set the position relative to the parent with <code style="color: #bb0000;">lv_obj_set_x(obj, new_x)</code> and <code style="color: #bb0000;">lv_obj_set_y(obj, new_y)</code>, or both axes at the same time with <code style="color: #bb0000;">lv_obj_set_pos(obj, new_x, new_y)</code>.
 
You can set the position relative to the parent with <code style="color: #bb0000;">lv_obj_set_x(obj, new_x)</code> and <code style="color: #bb0000;">lv_obj_set_y(obj, new_y)</code>, or both axes at the same time with <code style="color: #bb0000;">lv_obj_set_pos(obj, new_x, new_y)</code>.
 +
|親からの相対位置は、<code style="color: #bb0000;">lv_obj_set_x(obj, new_x)</code>と<code style="color: #bb0000;">lv_obj_set_y(obj, new_y)</code>、または<code style="color: #bb0000;">lv_obj_set_pos(obj, new_x, new_y)</code>を使用して同時に設定できます。
 +
|}
 +
:[[App:Library:LVGL:docs:Widgets|戻る : Previous]]
 +
  
 
==== Alignment ====
 
==== Alignment ====
−
You can align the object on its parent with <code style="color: #bb0000;">lv_obj_set_align(obj, LV_ALIGN_...)</code>. After this every x and y setting will be relative to the set alignment mode. For example, this will shift the object by 10;20 px from the center of its parent:
+
{| class="wikitable"
−
<syntaxhighlight lang="C++" style="border":1px dashed gray;">
+
!英文
−
lv_obj_set_align(obj, LV_ALIGN_CENTER);
+
!自動翻訳
−
lv_obj_set_pos(obj, 10, 20);
+
|-
−
+
|You can align the object to another with <code style="color: #bb0000;">lv_obj_align(obj, obj_ref, LV_ALIGN_..., x_ofs, y_ofs)</code>.
−
//Or in one function
+
 
−
lv_obj_align(obj, LV_ALIGN_CENTER, 10, 20);
+
* <code style="color: #bb0000;">obj</code> is the object to align.
−
</syntaxhighlight>
+
* <code style="color: #bb0000;">obj_ref</code> is a reference object. <code style="color: #bb0000;">obj</code> will be aligned to it. If <code style="color: #bb0000;">obj_ref = NULL</code>, then the parent of <code style="color: #bb0000;">obj</code> will be used.
−
To align one object to another use: <code style="color: #bb0000;">lv_obj_align_to(obj_to_align, obj_referece, LV_ALIGN_..., x, y)</code>
+
* The third argument is the ''type'' of alignment. These are the possible options:
 +
|<code style="color: #bb0000;">lv_obj_align(obj, obj_ref, LV_ALIGN_..., x_ofs, y_ofs)</code> を使用して、オブジェクトを別のオブジェクトに位置合わせできます。
 +
 
 +
*<code style="color: #bb0000;">obj</code> は整列するオブジェクトです。
 +
*<code style="color: #bb0000;">obj_ref</code> は参照オブジェクトです。 <code style="color: #bb0000;">obj</code> がそれに合わせられます。 <code style="color: #bb0000;">obj_ref = NULL</code> の場合、<code style="color: #bb0000;">obj</code> の親が使用されます。
 +
* 3 番目の引数は、配置のタイプです。 可能なオプションは次のとおりです。
 +
|-
 +
| colspan="2" |[[file:LVGL Lib docs obj.png|link=https://docs.lvgl.io/latest/en/html/widgets/obj.html#base-objects-with-custom-styles]]
 +
|-
 +
|
 +
* The alignment types build like <code style="color: #bb0000;">LV_ALIGN_OUT_TOP_MID</code>.
 +
* The last two arguments allow you to shift the object by a specified number of pixels after aligning it.
 +
|
 +
* 配置タイプは <code style="color: #bb0000;">LV_ALIGN_OUT_TOP_MID</code> のように構築されます。
 +
* 最後の 2 つの引数を使用すると、位置合わせ後に、指定したピクセル数だけオブジェクトをシフトできます。
 +
|-
 +
|For example, to align a text below an image: <code style="color: #bb0000;">lv_obj_align(text, image, LV_ALIGN_OUT_BOTTOM_MID, 0, 10)</code>.
 +
Or to align a text in the middle of its parent: <code style="color: #bb0000;">lv_obj_align(text, NULL, LV_ALIGN_CENTER, 0, 0)</code>.
 +
 
 +
 
 +
<code style="color: #bb0000;">lv_obj_align_origo</code> works similarly to <code style="color: #bb0000;">lv_obj_align</code> but it aligns the center of the object.
 +
 
 +
 
 +
For example, <code style="color: #bb0000;">lv_obj_align_origo(btn, image, LV_ALIGN_OUT_BOTTOM_MID, 0, 0)</code> will align the center of the button the bottom of the image.
 +
 
 +
 
 +
The parameters of the alignment will be saved in the object if <code style="color: #bb0000;">LV_USE_OBJ_REALIGN</code> is enabled in '''''lv_conf.h'''''.
 +
 
 +
You can then realign the objects simply by calling <code style="color: #bb0000;">lv_obj_realign(obj)</code>.
 +
 
 +
It's equivalent to calling <code style="color: #bb0000;">lv_obj_align</code> again with the same parameters.
 +
|たとえば、画像の下にテキストを配置するには: <code style="color: #bb0000;">lv_obj_align(text, image, LV_ALIGN_OUT_BOTTOM_MID, 0, 10)</code>。
 +
または、テキストをその親の中央に配置するには: <code style="color: #bb0000;">lv_obj_align(text, NULL, LV_ALIGN_CENTER, 0, 0)</code>。
 +
 
 +
 
 +
<code style="color: #bb0000;">lv_obj_align_origo</code> は <code style="color: #bb0000;">lv_obj_align</code> と同様に機能しますが、オブジェクトの中心を揃えます。
 +
 
 +
 
 +
たとえば、<code style="color: #bb0000;">lv_obj_align_origo(btn, image, LV_ALIGN_OUT_BOTTOM_MID, 0, 0)</code> は、ボタンの中心を画像の下に揃えます。
 +
 
 +
 
 +
<code style="color: #bb0000;">LV_USE_OBJ_REALIGN</code> が '''''lv_conf.h''''' で有効になっている場合、アラインメントのパラメーターはオブジェクトに保存されます。
 +
 
 +
その後、<code style="color: #bb0000;">lv_obj_realign(obj)</code> を呼び出すだけでオブジェクトを再配置できます。
 +
 
 +
同じパラメーターで <code style="color: #bb0000;">lv_obj_align</code> を再度呼び出すことと同じです。
 +
|-
 +
|If the alignment happened with <code style="color: #bb0000;">lv_obj_align_origo</code>, then it will be used when the object is realigned.
 +
 
 +
 
 +
The <code style="color: #bb0000;">lv_obj_align_x/y</code> and <code style="color: #bb0000;">lv_obj_align_origo_x/y</code> function can be used t align only on one axis.
 +
 
 +
 
 +
If <code style="color: #bb0000;">lv_obj_set_auto_realign(obj, true)</code> is used the object will be realigned automatically, if its size changes in <code style="color: #bb0000;">lv_obj_set_width/height/size()</code> functions. It's very useful when size animations are applied to the object and the original position needs to be kept.
 +
 
 +
 
 +
'''Note that the coordinates of screens can't be changed. Attempting to use these functions on screens will result in undefined behavior.'''
 +
|アライメントが <code style="color: #bb0000;">lv_obj_align_origo</code> で発生した場合、オブジェクトが再アライメントされるときに使用されます。
 +
 
 +
 
 +
<code style="color: #bb0000;">lv_obj_align_x/y</code> および <code style="color: #bb0000;">lv_obj_align_origo_x/y</code>関数は、1 つの軸でのみ整列するために使用できます。
 +
 
  
−
For example, to align a text below an image: <code style="color: #bb0000;">lv_obj_align_to(text, image, LV_ALIGN_OUT_BOTTOM_MID, 0, 10)</code>.
+
<code style="color: #bb0000;">lv_obj_set_auto_realign(obj, true)</code> が使用されている場合、そのサイズが <code style="color: #bb0000;">lv_obj_set_width/height/size()</code> 関数で変更された場合、オブジェクトは自動的に再配置されます。 オブジェクトにサイズ アニメーションを適用し、元の位置を維持する必要がある場合に非常に便利です。
  
−
The following align types exist:
 
−
[[file:LVGL docs widgets obj 01.png|link=https://docs.lvgl.io/8.2/widgets/obj.html#alignment]]
 
  
 +
 +
'''画面の座標は変更できないことに注意してください。 これらの関数を画面で使用しようとすると、未定義の動作が発生します。'''
 +
|}
 +
:[[App:Library:LVGL:docs:Widgets|戻る : Previous]]
  
  
 
=== Parents and children ===
 
=== Parents and children ===
−
You can set a new parent for an object with <code style="color: #bb0000;">lv_obj_set_parent(obj, new_parent)</code>. To get the current parent, use <code style="color: #bb0000;">lv_obj_get_parent(obj)</code>.
+
{| class="wikitable"
 +
!英文
 +
!自動翻訳
 +
|-
 +
|You can set a new parent for an object with <code style="color: #bb0000;">lv_obj_set_parent(obj, new_parent)</code>.
 +
To get the current parent, use <code style="color: #bb0000;">lv_obj_get_parent(obj)</code>.
  
−
To get a specific child of a parent use <code style="color: #bb0000;">lv_obj_get_child(parent, idx)</code>. Some examples for <code style="color: #bb0000;">idx</code>:
+
To get the children of an object, use <code style="color: #bb0000;">lv_obj_get_child(obj, child_prev)</code> (from last to first) or <code style="color: #bb0000;">lv_obj_get_child_back(obj, child_prev)</code> (from first to last). To get the first child, pass <code style="color: #bb0000;">NULL</code> as the second parameter and use the return value to iterate through the children. The function will return <code style="color: #bb0000;">NULL</code> if there are no more children. For example:
 +
|<code style="color: #bb0000;">lv_obj_set_parent(obj, new_parent)</code>を使用して、オブジェクトの新しい親を設定できます。
 +
現在の親を取得するには、<code style="color: #bb0000;">lv_obj_get_parent(obj)</code> を使用します。
  
−
* <code style="color: #bb0000;">0</code> get the child created first
 
−
* <code style="color: #bb0000;">1</code> get the child created second
 
−
* <code style="color: #bb0000;">-1</code> get the child created last
 
  
−
The children can be iterated lke this:
+
オブジェクトの子を取得するには、l<code style="color: #bb0000;">lv_obj_get_child(obj, child_prev)</code> (最後から最初へ) または <code style="color: #bb0000;">lv_obj_get_child_back(obj, child_prev)</code> (最初から最後へ) を使用します。 最初の子を取得するには、2 番目のパラメーターとして <code style="color: #bb0000;">NULL</code> を渡し、戻り値を使用して子を反復処理します。 子がそれ以上ない場合、関数は <code style="color: #bb0000;">NULL</code> を返します。 例えば：
−
<syntaxhighlight lang="C++" style="border: 1px dashed gray;">
+
|-
−
uint32_t i;
+
| colspan="2" |
−
for(i = 0i < lv_obj_get_child_cnt(parent)i++) {
+
<syntaxhighlight lang="c++" style="border: 1px dashed gray;">
−
  lv_obj_t * child = lv_obj_get_child(parent, i);
+
lv_obj_t * child = lv_obj_get_child(parent, NULL);
−
  /*Do something with child*/
+
while(child) {
−
}
+
    /*Do something with "child" */
 +
    child = lv_obj_get_child(parent, child);
 +
}
 
</syntaxhighlight>
 
</syntaxhighlight>
−
<code style="color: #bb0000;">lv_obj_get_index(obj)</code> returns the index of the object in its parent. It is equivalent to the number of younger children in the parent.
+
|-
 +
|<code style="color: #bb0000;">lv_obj_get_index(obj)</code> tells the number of children on an object.
 +
It is equivalent to the number of younger children in the parent.
 +
 
 +
 
 +
<code style="color: #bb0000;">lv_obj_count_children_recursive(obj)</code> also tells the number of children but counts children of children recursively.
 +
|<code style="color: #bb0000;">lv_obj_get_index(obj)</code> は、オブジェクトの子の数を示します。
 +
これは、親の年少の子供の数に相当します。
 +
 
 +
 
 +
<code style="color: #bb0000;">lv_obj_count_children_recursive(obj)</code> も子の数を示しますが、子の子を再帰的にカウントします。
 +
|}
 +
:[[App:Library:LVGL:docs:Widgets|戻る : Previous]]
 +
 
 +
 
 +
=== Screens ===
 +
{| class="wikitable"
 +
!英文
 +
!自動翻訳
 +
|-
 +
|
 +
When you have created a screen like <code style="color: #bb0000;">lv_obj_t * screen = lv_obj_create(NULL, NULL)</code>, you can load it with <code style="color: #bb0000;">lv_scr_load(screen)</code>.
 +
 
 +
The <code style="color: #bb0000;">lv_scr_act()</code> function gives you a pointer to the current screen.
 +
 
 +
 
 +
 
 +
If you have more display then it's important to know that these functions operate on the lastly created or the explicitly selected (with <code style="color: #bb0000;">lv_disp_set_default</code>) display.
 +
 
 +
 
 +
To get an object's screen use the <code style="color: #bb0000;">lv_obj_get_screen(obj)</code> function.
 +
|<code style="color: #bb0000;">lv_obj_t * screen = lv_obj_create(NULL, NULL)</code>のように画面を作成したら、<code style="color: #bb0000;">lv_scr_load(screen)</code> で読み込むことができます。
 +
<code style="color: #bb0000;">lv_scr_act()</code>関数は、現在の画面へのポインターを提供します。
 +
 
 +
 
 +
より多くのディスプレイがある場合、これらの関数は最後に作成されたディスプレイまたは明示的に選択された (<code style="color: #bb0000;">lv_disp_set_default</code>を使用して) ディスプレイで動作することを知っておくことが重要です。
 +
 
 +
 
 +
オブジェクトの画面を取得するには、<code style="color: #bb0000;">lv_obj_get_screen(obj)</code>関数を使用します。
 +
 
 +
|}
 +
:[[App:Library:LVGL:docs:Widgets|戻る : Previous]]
 +
 
 +
 
 +
=== Layers ===
 +
{| class="wikitable"
 +
!英文
 +
!自動翻訳
 +
|-
 +
|
 +
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'' too. 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 here in <code style="color: #bb0000;">lv_indev_set_cursor()</code>).
 +
 
 +
 
 +
The <code style="color: #bb0000;">lv_layer_top()</code> and <code style="color: #bb0000;">lv_layer_sys()</code> functions gives a pointer to the top or system layer.
 +
 
  
 
You can bring an object to the foreground or send it to the background with <code style="color: #bb0000;">lv_obj_move_foreground(obj)</code> and <code style="color: #bb0000;">lv_obj_move_background(obj)</code>.
 
You can bring an object to the foreground or send it to the background with <code style="color: #bb0000;">lv_obj_move_foreground(obj)</code> and <code style="color: #bb0000;">lv_obj_move_background(obj)</code>.
  
−
You can change the index of an object in its parent using <code style="color: #bb0000;">lv_obj_move_to_index(obj, index)</code>.
 
  
−
You can swap the position of two objects with <code style="color: #bb0000;">lv_obj_swap(obj1, obj2)</code>.
+
Read the Layer overview section to learn more about [[App:Library:LVGL:docs:Overview:Layers|<u>'''layers'''</u>]].
 +
|2 つの自動生成レイヤーがあります。
  
−
=== Display and Screens ===
+
* 上層
−
At the highest level of the LVGL object hierarchy is the ''display'' which represents the driver for a display device (physical display or simulator). A display can have one or more screens associated with it. Each screen contains a hierarchy of objects for graphical widgets representing a layout that covers the entire display.
+
* システム層
  
−
When you have created a screen like <code style="color: #bb0000;">lv_obj_t * screen = lv_obj_create(NULL)</code>, you can make it active with <code style="color: #bb0000;">lv_scr_load(screen)</code>. The <code style="color: #bb0000;">lv_scr_act()</code> function gives you a pointer to the active screen.
 
  
−
If you have multiple displays, it's important to know that the screen functions operate on the most recently created display or the one explicitly selected with <code style="color: #bb0000;">lv_disp_set_default</code>.
+
それらは画面から独立しており、すべての画面に表示されます。 最上位レイヤーは画面上のすべてのオブジェクトの上にあり、システム レイヤーも最上位レイヤーの上にあります。
 +
 
 +
最上層に任意のポップアップ ウィンドウを自由に追加できます。
 +
 
 +
ただし、システム レイヤーはシステム レベルのものに制限されます (たとえば、マウス カーソルは <code style="color: #bb0000;">lv_indev_set_cursor()</code> でここに配置されます)。
 +
 
 +
 
 +
 
 +
<code style="color: #bb0000;">lv_layer_top()</code> および<code style="color: #bb0000;">lv_layer_sys()</code>関数は、最上位層またはシステム層へのポインターを提供します。
 +
 
 +
 
 +
 
 +
<code style="color: #bb0000;">lv_obj_move_foreground(obj)</code> と <code style="color: #bb0000;">lv_obj_move_background(obj)</code>を使用して、オブジェクトをフォアグラウンドに移動したり、バックグラウンドに移動したりできます。
 +
 
 +
 
 +
[[App:Library:LVGL:docs:Overview:Layers|<u>'''layers'''</u>]]の詳細については、レイヤーの概要セクションを参照してください。
 +
 
 +
|}
 +
:[[App:Library:LVGL:docs:Widgets|戻る : Previous]]
  
−
To get an object's screen use the <code style="color: #bb0000;">lv_obj_get_screen(obj)</code> function.
 
  
 
=== Events ===
 
=== Events ===
 +
{| class="wikitable"
 +
!英文
 +
!自動翻訳
 +
|-
 +
|
 
To set an event callback for an object, use <code style="color: #bb0000;">lv_obj_add_event_cb(obj, event_cb, LV_EVENT_..., user_data)</code>,
 
To set an event callback for an object, use <code style="color: #bb0000;">lv_obj_add_event_cb(obj, event_cb, LV_EVENT_..., user_data)</code>,
 +
  
 
To manually send an event to an object, use <code style="color: #bb0000;">lv_event_send(obj, LV_EVENT_..., param)</code>
 
To manually send an event to an object, use <code style="color: #bb0000;">lv_event_send(obj, LV_EVENT_..., param)</code>
  
 
Read the Event overview to learn more about events.
 
Read the Event overview to learn more about events.
 +
|オブジェクトにイベントコールバックを設定するには、<code style="color: #bb0000;">lv_obj_add_event_cb(obj, event_cb, LV_EVENT_..., user_data)</code>を使い、
 +
イベントを手動でオブジェクトに送信するには、<code style="color: #bb0000;">lv_event_send(obj, LV_EVENT_..., param)</code>を使います。
 +
 +
イベントの詳細については、 「イベントの概要」 を参照してください。
 +
|}
 +
:[[App:Library:LVGL:docs:Widgets|戻る : Previous]]
 +
 +
 +
== Parts ==
 +
{| class="wikitable"
 +
!英文
 +
!自動翻訳
 +
|-
 +
|To set an event callback for an object, use <code style="color: #bb0000;">lv_obj_set_event_cb(obj, event_cb)</code>,
 +
 +
 +
To manually send an event to an object, use <code style="color: #bb0000;">lv_event_send(obj, LV_EVENT_..., data)</code>
 +
 +
 +
Read the Event overview to learn more about the events.
 +
|オブジェクトのイベント コールバックを設定するには、<code style="color: #bb0000;">lv_obj_set_event_cb(obj, event_cb)</code>を使用します。
 +
 +
 +
イベントをオブジェクトに手動で送信するには、<code style="color: #bb0000;">lv_event_send(obj, LV_EVENT_..., data)</code> を使用します。
 +
 +
 +
 +
イベントの詳細については、イベントの概要をご覧ください。
 +
|}
 +
:[[App:Library:LVGL:docs:Widgets|戻る : Previous]]
 +
 +
=== States ===
 +
{| class="wikitable"
 +
!英文
 +
!自動翻訳
 +
|-
 +
|The widgets can have multiple parts. For example a Button has only a main part but a Slider is built from a background, an indicator and a knob.
 +
 +
 +
The name of the parts is constructed like <code style="color: #bb0000;">LV_ + <TYPE> _PART_ <NAME></code>. For example <code style="color: #bb0000;">LV_BTN_PART_MAIN</code> or <code style="color: #bb0000;">LV_SLIDER_PART_KNOB</code>. The parts are usually used when styles are add to the objects. Using parts different styles can be assigned to the different parts of the objects.
 +
 +
 +
To learn more about the parts read the related section of the Style overview.
 +
|ウィジェットには複数のパーツを含めることができます。 たとえば、ボタンには主要な部分しかありませんが、スライダーは背景、インジケーター、およびノブから構築されます。
 +
 +
 +
 +
 +
パーツの名前は、<code style="color: #bb0000;">LV_ + <TYPE> _PART_ <NAME></code>のように構成されます。 たとえば、<code style="color: #bb0000;">LV_BTN_PART_MAIN</code> または <code style="color: #bb0000;">LV_SLIDER_PART_KNOB</code> です。 パーツは通常、オブジェクトにスタイルを追加するときに使用されます。 パーツを使用すると、オブジェクトのさまざまなパーツにさまざまなスタイルを割り当てることができます。
 +
 +
 +
パーツの詳細については、スタイルの概要の関連セクションをお読みください。
 +
|}
 +
:[[App:Library:LVGL:docs:Widgets|戻る : Previous]]
 +
  
 
=== Styles ===
 
=== Styles ===
−
Be sure to read the Style overview. Here only the most essential functions are described.
+
{| class="wikitable"
 +
!英文
 +
!自動翻訳
 +
|-
 +
|
 +
Be sure to read the Style overview first.
  
−
A new style can be added to an object with the <code style="color: #bb0000;">lv_obj_add_style(obj, &new_style, selector)</code> function. <code style="color: #bb0000;">selector</code> is an ORed combination of part and state(s). E.g. <code style="color: #bb0000;">LV_PART_SCROLLBAR | LV_STATE_PRESSED</code>.
 
  
−
The base objects use <code style="color: #bb0000;">LV_PART_MAIN</code> style properties and <code style="color: #bb0000;">LV_PART_SCROLLBAR</code> with the typical background style properties.
+
To add a style to an object use <code style="color: #bb0000;">lv_obj_add_style(obj, part, &new_style)</code> function.  
  
−
=== Flags ===
+
The Base object use all the rectangle-like style properties.
−
There are some attributes which can be enabled/disabled by <code style="color: #bb0000;">lv_obj_add/clear_flag(obj, LV_OBJ_FLAG_...)</code>:
 
  
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_HIDDEN</code> Make the object hidden. (Like it wasn't there at all)
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_CLICKABLE</code> Make the object clickable by input devices
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_CLICK_FOCUSABLE</code> Add focused state to the object when clicked
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_CHECKABLE</code> Toggle checked state when the object is clicked
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_SCROLLABLE</code> Make the object scrollable
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_SCROLL_ELASTIC</code> Allow scrolling inside but with slower speed
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_SCROLL_MOMENTUM</code> Make the object scroll further when "thrown"
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_SCROLL_ONE</code> Allow scrolling only one snappable children
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_SCROLL_CHAIN_HOR</code> Allow propagating the horizontal scroll to a parent
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_SCROLL_CHAIN_VER</code> Allow propagating the vertical scroll to a parent
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_SCROLL_CHAIN</code> Simple packaging for (<code style="color: #bb0000;">LV_OBJ_FLAG_SCROLL_CHAIN_HOR | LV_OBJ_FLAG_SCROLL_CHAIN_VER</code>)
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_SCROLL_ON_FOCUS</code> Automatically scroll object to make it visible when focused
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_SCROLL_WITH_ARROW</code> Allow scrolling the focused object with arrow keys
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_SNAPPABLE</code> If scroll snap is enabled on the parent it can snap to this object
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_PRESS_LOCK</code> Keep the object pressed even if the press slid from the object
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_EVENT_BUBBLE</code> Propagate the events to the parent too
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_GESTURE_BUBBLE</code> Propagate the gestures to the parent
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_ADV_HITTEST</code> Allow performing more accurate hit (click) test. E.g. accounting for rounded corners
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_IGNORE_LAYOUT</code> Make the object positionable by the layouts
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_FLOATING</code> Do not scroll the object when the parent scrolls and ignore layout
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_OVERFLOW_VISIBLE</code> Do not clip the children's content to the parent's boundary
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_LAYOUT_1</code> Custom flag, free to use by layouts
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_LAYOUT_2</code> Custom flag, free to use by layouts
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_WIDGET_1</code> Custom flag, free to use by widget
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_WIDGET_2</code> Custom flag, free to use by widget
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_USER_1</code> Custom flag, free to use by user
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_USER_2</code> Custom flag, free to use by user
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_USER_3</code> Custom flag, free to use by user
 
−
* <code style="color: #bb0000;">LV_OBJ_FLAG_USER_4</code> Custom flag, free to use by user
 
  
−
Some examples:
+
To remove all styles from an object use <code style="color: #bb0000;">lv_obj_reset_style_list(obj, part)</code>
−
<syntaxhighlight lang="C++" style="border":1px dashed gray;">
 
−
/*Hide on object*/
 
−
lv_obj_add_flag(obj, LV_OBJ_FLAG_HIDDEN);
 
−
 
−
/*Make an object non-clickable*/
 
−
lv_obj_clear_flag(obj, LV_OBJ_FLAG_CLICKABLE);
 
−
</syntaxhighlight>
 
  
  
−
=== Groups ===
+
If you modify a style, which is already used by objects, in order to refresh the affected objects you can use either <code style="color: #bb0000;">lv_obj_refresh_style(obj)</code> on each object using it or to notify all objects with a given style use <code style="color: #bb0000;">lv_obj_report_style_mod(&style)</code>.  
−
Read the Input devices overview to learn more about ''Groups''.
 
  
−
Objects are added to a ''group'' with <code style="color: #bb0000;">lv_group_add_obj(group, obj)</code>, and you can use <code style="color: #bb0000;">lv_obj_get_group(obj)</code> to see which group an object belongs to.
+
If the parameter of <code style="color: #bb0000;">lv_obj_report_style_mod</code> is <code style="color: #bb0000;">NULL</code>, all objects will be notified.
 +
|最初に必ずスタイルの概要をお読みください。
  
−
<code style="color: #bb0000;">lv_obj_is_focused(obj)</code> returns if the object is currently focused on its group or not. If the object is not added to a group, <code style="color: #bb0000;">false</code> will be returned.
 
  
  
−
=== Extended click area ===
 
−
By default, the objects can be clicked only within their bounding area. However, this can be extended with <code style="color: #bb0000;">lv_obj_set_ext_click_area(obj, size)</code>.
 
  
−
== Events ==
+
オブジェクトにスタイルを追加するには、<code style="color: #bb0000;">lv_obj_add_style(obj, part, &new_style)</code> 関数を使用します。
−
* <code style="color: #bb0000;">LV_EVENT_VALUE_CHANGED</code> when the <code style="color: #bb0000;">LV_OBJ_FLAG_CHECKABLE</code> flag is enabled and the object clicked (on transition to/from the checked state)
 
−
* <code style="color: #bb0000;">LV_EVENT_DRAW_PART_BEGIN</code> and <code style="color: #bb0000;">LV_EVENT_DRAW_PART_END</code> is sent for the following types:
 
−
** <code style="color: #bb0000;">LV_OBJ_DRAW_PART_RECTANGLE</code> The main rectangle
 
−
*** <code style="color: #bb0000;">part</code>: <code style="color: #bb0000;">LV_PART_MAIN</code>
 
−
*** <code style="color: #bb0000;">rect_dsc</code>
 
−
*** <code style="color: #bb0000;">draw_area</code>: the area of the rectangle
 
−
** <code style="color: #bb0000;">LV_OBJ_DRAW_PART_BORDER_POST</code> The border if the <code style="color: #bb0000;">border_post</code> style property is <code style="color: #bb0000;">true</code>
 
−
*** <code style="color: #bb0000;">part</code>: <code style="color: #bb0000;">LV_PART_MAIN</code>
 
−
*** <code style="color: #bb0000;">rect_dsc</code>
 
−
*** <code style="color: #bb0000;">draw_area</code>: the area of the rectangle
 
−
** <code style="color: #bb0000;">LV_OBJ_DRAW_PART_SCROLLBAR</code> the scrollbars
 
−
*** <code style="color: #bb0000;">part</code>: <code style="color: #bb0000;">LV_PART_SCROLLBAR</code>
 
−
*** <code style="color: #bb0000;">rect_dsc</code>
 
−
*** <code style="color: #bb0000;">draw_area</code>: the area of the rectangle
 
  
−
Learn more about Events.
+
Base オブジェクトは、すべての長方形のようなスタイル プロパティを使用します。
  
−
== Keys ==
 
−
If <code style="color: #bb0000;">LV_OBJ_FLAG_CHECKABLE</code> is enabled, <code style="color: #bb0000;">LV_KEY_RIGHT</code> and <code style="color: #bb0000;">LV_KEY_UP</code> make the object checked, and <code style="color: #bb0000;">LV_KEY_LEFT</code> and <code style="color: #bb0000;">LV_KEY_DOWN</code> make it unchecked.
 
  
−
If <code style="color: #bb0000;">LV_OBJ_FLAG_SCROLLABLE</code> is enabled, but the object is not editable (as declared by the widget class), the arrow keys (<code style="color: #bb0000;">LV_KEY_UP</code>, <code style="color: #bb0000;">LV_KEY_DOWN</code>, <code style="color: #bb0000;">LV_KEY_LEFT</code>, <code style="color: #bb0000;">LV_KEY_RIGHT</code>) scroll the object. If the object can only scroll vertically, <code style="color: #bb0000;">LV_KEY_LEFT</code> and <code style="color: #bb0000;">LV_KEY_RIGHT</code> will scroll up/down instead, making it compatible with an encoder input device. See Input devices overview for more on encoder behaviors and the edit mode.
 
  
−
Learn more about Keys.
+
オブジェクトからすべてのスタイルを削除するには、<code style="color: #bb0000;">lv_obj_reset_style_list(obj, part)</code>を使用します
  
−
== Example ==
 
−
=== Base objects with custom styles ===
 
−
[[file:LVGL docs example 042.png|link=https://docs.lvgl.io/8.2/widgets/obj.html#base-objects-with-custom-styles]]
 
  
−
----
+
オブジェクトで既に使用されているスタイルを変更する場合、影響を受けるオブジェクトを更新するには、それを使用する各オブジェクトで <code style="color: #bb0000;">lv_obj_refresh_style(obj)</code> を使用するか、指定されたスタイルを持つすべてのオブジェクトに <code style="color: #bb0000;">lv_obj_report_style_mod(&style)</code>を使用して通知します。 <code style="color: #bb0000;">lv_obj_report_style_mod</code>のパラメーターが <code style="color: #bb0000;">NULL</code> の場合、すべてのオブジェクトが通知されます。
−
=== Make an object draggable ===
+
|}
−
[[file:LVGL docs example 043.png|link=https://docs.lvgl.io/8.2/widgets/obj.html#make-an-object-draggable]]
+
:[[App:Library:LVGL:docs:Widgets|戻る : Previous]]
  
−
----
 
  
 +
=== Attributes ===
 +
{| class="wikitable"
 +
!英文
 +
!自動翻訳
 +
|-
 +
|There are some attributes which can be enabled/disabled by <code style="color: #bb0000;">lv_obj_set_...(obj, true/false)</code>:
  
 +
* hidden - Hide the object. It will not be drawn and will be considered by input devices as if it doesn't exist., Its children will be hidden too.
 +
* click - Allows you to click the object via input devices. If disabled, then click events are passed to the object behind this one. (E.g. Labels are not clickable by default)
 +
* top - If enabled then when this object or any of its children is clicked then this object comes to the foreground.
 +
* drag - Enable dragging (moving by an input device)
 +
* drag_dir - Enable dragging only in specific directions. Can be <code style="color: #bb0000;">LV_DRAG_DIR_HOR/VER/ALL</code>.
 +
* drag_throw - Enable "throwing" with dragging as if the object would have momentum
 +
* drag_parent - If enabled then the object's parent will be moved during dragging. It will look like as if the parent is dragged. Checked recursively, so can propagate to grandparents too.
 +
* parent_event - Propagate the events to the parents too. Checked recursively, so can propagate to grandparents too.
 +
* opa_scale_enable - Enable opacity scaling. See the [#opa-scale](Opa scale) section.
 +
|<code style="color: #bb0000;">lv_obj_set_...(obj, true/false)</code>で有効/無効にできる属性がいくつかあります:
  
−
== API ==
+
* hidden - オブジェクトを隠します。それは描画されず、入力デバイスによって存在しないかのように見なされます。その子も非表示になります。
−
Typedefs
+
* click - 入力デバイスを介してオブジェクトをクリックできるようにします。無効にすると、クリック イベントはこのオブジェクトの背後にあるオブジェクトに渡されます。 (例: ラベルはデフォルトではクリックできません)
 +
* top - 有効にすると、このオブジェクトまたはその子のいずれかをクリックすると、このオブジェクトが前面に表示されます。
 +
* drag - ドラッグを有効にする (入力デバイスによる移動)
 +
* drag_dir - 特定の方向へのドラッグのみを有効にします。 <code style="color: #bb0000;">LV_DRAG_DIR_HOR/VER/ALL</code>を指定できます。
 +
* drag_throw - オブジェクトに勢いがあるかのように、ドラッグで「投げ」を有効にします
 +
* drag_parent - 有効にすると、ドラッグ中にオブジェクトの親が移動します。親がドラッグされているように見えます。再帰的にチェックされるため、祖父母にも伝播できます。
 +
* parent_event - イベントを親にも伝播します。再帰的にチェックされるため、祖父母にも伝播できます。
 +
* opa_scale_enable - 不透明度のスケーリングを有効にします。 [#opa-scale](オパ スケール) セクションを参照してください。
 +
|}
 +
:[[App:Library:LVGL:docs:Widgets|戻る : Previous]]
  
−
typedef uint16_t lv_state_t
 
−
:
 
  
−
typedef uint32_t lv_part_t
+
=== Protect ===
−
:
+
{| class="wikitable"
 +
!英文
 +
!自動翻訳
 +
|-
 +
|There are some specific actions which happen automatically in the library.
 +
To prevent one or more that kind of actions, you can protect the object against them.
  
−
typedef uint32_t lv_obj_flag_t
+
The following protections exists:
−
:
 
  
−
typedef struct _lv_obj_t lv_obj_t
+
* '''LV_PROTECT_NONE''' No protection
−
:
+
* '''LV_PROTECT_POS''' Prevent automatic positioning (e.g. Layout in Containers)
 +
* '''LV_PROTECT_FOLLOW''' Prevent the object be followed (make a "line break") in automatic ordering (e.g. Layout in Containers)
 +
* '''LV_PROTECT_PARENT''' Prevent automatic parent change. (e.g. Page moves the children created on the background to the scrollable)
 +
* '''LV_PROTECT_PRESS_LOST''' Prevent losing press when the press is slid out of the objects. (E.g. a Button can be released out of it if it was being pressed)
 +
* '''LV_PROTECT_CLICK_FOCUS''' Prevent automatically focusing the object if it's in a ''Group'' and click focus is enabled.
 +
* '''LV_PROTECT_CHILD_CHG''' Disable the child change signal. Used internally by the library
  
−
Enums
 
  
−
enum [anonymous]
+
The <code style="color: #bb0000;">lv_obj_add/clear_protect(obj, LV_PROTECT_...)</code> sets/clears the protection. You can use ''<nowiki/>'OR'ed'' values of protection types too.
−
: Possible states of a widget. OR-ed values are possible  ''Values:''
+
|ライブラリで自動的に発生する特定のアクションがいくつかあります。
−
:enumerator LV_STATE_DEFAULT
+
そのようなアクションを 1 つ以上防止するために、オブジェクトをそれらから保護することができます。
−
::
 
−
:enumerator LV_STATE_CHECKED
 
−
::
 
−
:enumerator LV_STATE_FOCUSED
 
−
::
 
−
:enumerator LV_STATE_FOCUS_KEY
 
−
::
 
−
:enumerator LV_STATE_EDITED
 
−
::
 
−
:enumerator LV_STATE_HOVERED
 
−
::
 
−
:enumerator LV_STATE_PRESSED
 
−
::
 
−
:enumerator LV_STATE_SCROLLED
 
−
::
 
−
:enumerator LV_STATE_DISABLED
 
−
::
 
−
:enumerator LV_STATE_USER_1
 
−
::
 
−
:enumerator LV_STATE_USER_2
 
−
::
 
−
:enumerator LV_STATE_USER_3
 
−
::
 
−
:enumerator LV_STATE_USER_4
 
−
::
 
−
:enumerator LV_STATE_ANY
 
−
:: Special value can be used in some functions to target all states
 
  
−
enum [anonymous]
+
次の保護が存在します。
−
: The possible parts of widgets. The parts can be considered as the internal building block of the widgets. E.g. slider = background + indicator + knob Note every part is used by every widget  ''Values:''
 
−
:enumerator LV_PART_MAIN
 
−
:: A background like rectangle
 
−
:enumerator LV_PART_SCROLLBAR
 
−
:: The scrollbar(s)
 
−
:enumerator LV_PART_INDICATOR
 
−
:: Indicator, e.g. for slider, bar, switch, or the tick box of the checkbox
 
−
:enumerator LV_PART_KNOB
 
−
:: Like handle to grab to adjust the value
 
−
:enumerator LV_PART_SELECTED
 
−
:: Indicate the currently selected option or section
 
−
:enumerator LV_PART_ITEMS
 
−
:: Used if the widget has multiple similar elements (e.g. table cells)
 
−
:enumerator LV_PART_TICKS
 
−
:: Ticks on scale e.g. for a chart or meter
 
−
:enumerator LV_PART_CURSOR
 
−
:: Mark a specific place e.g. for text area's cursor or on a chart
 
−
:enumerator LV_PART_CUSTOM_FIRST
 
−
:: Extension point for custom widgets
 
−
:enumerator LV_PART_ANY
 
−
:: Special value can be used in some functions to target all parts
 
  
−
enum [anonymous]
+
* '''LV_PROTECT_NONE''' 保護なし
−
: On/Off features controlling the object's behavior. OR-ed values are possible  ''Values:''
+
* '''LV_PROTECT_POS''' 自動配置を防止します (例: コンテナー内のレイアウト)
−
:enumerator LV_OBJ_FLAG_HIDDEN
+
* '''LV_PROTECT_FOLLOW''' 自動順序付け (例: コンテナー内のレイアウト) でオブジェクトが続く (「改行」を行う) のを防ぎます。
−
:: Make the object hidden. (Like it wasn't there at all)
+
* '''LV_PROTECT_PARENT''' 自動親変更を防ぎます。 (例: Page は、背景に作成された子をスクロール可能に移動します)
−
:enumerator LV_OBJ_FLAG_CLICKABLE
+
* '''LV_PROTECT_PRESS_LOST''' プレスがオブジェクトからスライドしたときにプレスが失われるのを防ぎます。 (たとえば、ボタンが押されていた場合、ボタンを離すことができます)
−
:: Make the object clickable by the input devices
+
* '''LV_PROTECT_CLICK_FOCUS''' オブジェクトがグループ内にあり、クリック フォーカスが有効になっている場合、オブジェクトが自動的にフォーカスされるのを防ぎます。
−
:enumerator LV_OBJ_FLAG_CLICK_FOCUSABLE
+
* '''LV_PROTECT_CHILD_CHG''' 子変更信号を無効にします。ライブラリによって内部的に使用されます
−
:: Add focused state to the object when clicked
 
−
:enumerator LV_OBJ_FLAG_CHECKABLE
 
−
:: Toggle checked state when the object is clicked
 
−
:enumerator LV_OBJ_FLAG_SCROLLABLE
 
−
:: Make the object scrollable
 
−
:enumerator LV_OBJ_FLAG_SCROLL_ELASTIC
 
−
:: Allow scrolling inside but with slower speed
 
−
:enumerator LV_OBJ_FLAG_SCROLL_MOMENTUM
 
−
:: Make the object scroll further when "thrown"
 
−
:enumerator LV_OBJ_FLAG_SCROLL_ONE
 
−
:: Allow scrolling only one snappable children
 
−
:enumerator LV_OBJ_FLAG_SCROLL_CHAIN_HOR
 
−
:: Allow propagating the horizontal scroll to a parent
 
−
:enumerator LV_OBJ_FLAG_SCROLL_CHAIN_VER
 
−
:: Allow propagating the vertical scroll to a parent
 
−
:enumerator LV_OBJ_FLAG_SCROLL_CHAIN
 
−
::
 
−
:enumerator LV_OBJ_FLAG_SCROLL_ON_FOCUS
 
−
:: Automatically scroll object to make it visible when focused
 
−
:enumerator LV_OBJ_FLAG_SCROLL_WITH_ARROW
 
−
:: Allow scrolling the focused object with arrow keys
 
−
:enumerator LV_OBJ_FLAG_SNAPPABLE
 
−
:: If scroll snap is enabled on the parent it can snap to this object
 
−
:enumerator LV_OBJ_FLAG_PRESS_LOCK
 
−
:: Keep the object pressed even if the press slid from the object
 
−
:enumerator LV_OBJ_FLAG_EVENT_BUBBLE
 
−
:: Propagate the events to the parent too
 
−
:enumerator LV_OBJ_FLAG_GESTURE_BUBBLE
 
−
:: Propagate the gestures to the parent
 
−
:enumerator LV_OBJ_FLAG_ADV_HITTEST
 
−
:: Allow performing more accurate hit (click) test. E.g. consider rounded corners.
 
−
:enumerator LV_OBJ_FLAG_IGNORE_LAYOUT
 
−
:: Make the object position-able by the layouts
 
−
:enumerator LV_OBJ_FLAG_FLOATING
 
−
:: Do not scroll the object when the parent scrolls and ignore layout
 
−
:enumerator LV_OBJ_FLAG_OVERFLOW_VISIBLE
 
−
:: Do not clip the children's content to the parent's boundary
 
−
:enumerator LV_OBJ_FLAG_LAYOUT_1
 
−
:: Custom flag, free to use by layouts
 
−
:enumerator LV_OBJ_FLAG_LAYOUT_2
 
−
:: Custom flag, free to use by layouts
 
−
:enumerator LV_OBJ_FLAG_WIDGET_1
 
−
:: Custom flag, free to use by widget
 
−
:enumerator LV_OBJ_FLAG_WIDGET_2
 
−
:: Custom flag, free to use by widget
 
−
:enumerator LV_OBJ_FLAG_USER_1
 
−
:: Custom flag, free to use by user
 
−
:enumerator LV_OBJ_FLAG_USER_2
 
−
:: Custom flag, free to use by user
 
−
:enumerator LV_OBJ_FLAG_USER_3
 
−
:: Custom flag, free to use by user
 
−
:enumerator LV_OBJ_FLAG_USER_4
 
−
:: Custom flag, free to use by user
 
  
−
enum lv_obj_draw_part_type_t
 
−
: <code style="color: #bb0000;">type</code> field in <code style="color: #bb0000;">lv_obj_dra</code><code style="color: #bb0000;">w_part_dsc_t</code> if <code style="color: #bb0000;">class_p = lv_obj_class</code> Used in <code style="color: #bb0000;">LV_EVENT_DRAW_PART_BEGIN</code> and <code style="color: #bb0000;">LV_EVENT_DRAW_PART_END</code>  ''Values:''
 
−
:enumerator LV_OBJ_DRAW_PART_RECTANGLE
 
−
:: The main rectangle
 
−
:enumerator LV_OBJ_DRAW_PART_BORDER_POST
 
−
:: The border if style_border_post = true
 
−
:enumerator LV_OBJ_DRAW_PART_SCROLLBAR
 
−
:: The scrollbar
 
  
−
Functions
+
<code style="color: #bb0000;">lv_obj_add/clear_protect(obj, LV_PROTECT_...)</code> は、保護を設定/クリアします。保護タイプの「OR」値も使用できます。
 +
|}
 +
:[[App:Library:LVGL:docs:Widgets|戻る : Previous]]
  
−
void lv_init(void)
 
−
: Initialize LVGL library. Should be called before any other LVGL related function.
 
  
−
void lv_deinit(void)  
+
=== Groups ===
−
: Deinit the 'lv' library Currently only implemented when not using custom allocators, or GC is enabled.
+
{| class="wikitable"
 +
!英文
 +
!自動翻訳
 +
|-
 +
|
 +
Once, an object is added to ''group'' with <code style="color: #bb0000;">lv_group_add_obj(group, obj)</code> the object's current group can be get with <code style="color: #bb0000;">lv_obj_get_group(obj)</code>.
  
−
bool lv_is_initialized(void)
 
−
: Returns whether the 'lv' library is currently initialized
 
  
−
lv_obj_t *lv_obj_create(lv_obj_t *parent)
+
<code style="color: #bb0000;">lv_obj_is_focused(obj)</code> tells if the object is currently focused on its group or not. If the object is not added to a group, <code style="color: #bb0000;">false</code> will be returned.
−
: Create a base object (a rectangle)
 
−
:Parameters
 
−
:: parent -- pointer to a parent object. If NULL then a screen will be created.
 
−
:Returns
 
−
:: pointer to the new object
 
  
−
void lv_obj_add_flag(lv_obj_t *obj, lv_obj_flag_t f)
 
−
: Set one or more flags
 
−
:Parameters
 
−
::* obj -- pointer to an object
 
−
::* f -- R-ed values from <code style="color: #bb0000;">lv_obj_flag_t</code> to set.
 
  
−
void lv_obj_clear_flag(lv_obj_t *obj, lv_obj_flag_t f)
+
Read the Input devices overview to learn more about the ''Groups''.
−
: Clear one or more flags
+
|オブジェクトが <code style="color: #bb0000;">lv_group_add_obj(group, obj)</code>でグループに追加されると、オブジェクトの現在のグループは <code style="color: #bb0000;">lv_obj_get_group(obj)</code> で取得できます。
−
:Parameters
 
−
::* obj -- pointer to an object
 
−
::* f -- OR-ed values from <code style="color: #bb0000;">lv_obj_flag_t</code> to set.
 
  
−
void lv_obj_add_state(lv_obj_t *obj, lv_state_t state)
 
−
: Add one or more states to the object. The other state bits will remain unchanged. If specified in the styles, transition animation will be started from the previous state to the current.
 
−
:Parameters
 
−
::* obj -- pointer to an object
 
−
::* state -- the states to add. E.g <code style="color: #bb0000;">LV_STATE_PRESSED | LV_STATE_FOCUSED</code>
 
  
−
void lv_obj_clear_state(lv_obj_t *obj, lv_state_t state)  
+
<code style="color: #bb0000;">lv_obj_is_focused(obj)</code>は、オブジェクトが現在そのグループにフォーカスされているかどうかを示します。 オブジェクトがグループに追加されていない場合は、<code style="color: #bb0000;">false</code> が返されます。
−
: Remove one or more states to the object. The other state bits will remain unchanged. If specified in the styles, transition animation will be started from the previous state to the current.
 
−
:Parameters
 
−
::* obj -- pointer to an object
 
−
::* state -- the states to add. E.g <code style="color: #bb0000;">LV_STATE_PRESSED | LV_STATE_FOCUSED</code>
 
  
−
static inline void lv_obj_set_user_data(lv_obj_t *obj, void *user_data)
 
−
: Set the user_data field of the object
 
−
:Parameters
 
−
::* obj -- pointer to an object
 
−
::* user_data -- pointer to the new user_data.
 
  
−
bool lv_obj_has_flag(const lv_obj_t *obj, lv_obj_flag_t f)
 
−
: Check if a given flag or all the given flags are set on an object.
 
−
:Parameters
 
−
::* obj -- pointer to an object
 
−
::* f -- the flag(s) to check (OR-ed values can be used)
 
−
:Returns
 
−
:: true: all flags are setfalse: not all flags are set
 
  
−
bool lv_obj_has_flag_any(const lv_obj_t *obj, lv_obj_flag_t f)
+
グループの詳細については、入力デバイスの概要をご覧ください。
−
: Check if a given flag or any of the flags are set on an object.
+
|}
−
:Parameters
+
:[[App:Library:LVGL:docs:Widgets|戻る : Previous]]
−
::* obj -- pointer to an object
 
−
::* f -- the flag(s) to check (OR-ed values can be used)
 
−
:Returns
 
−
:: true: at lest one flag flag is setfalse: none of the flags are set
 
  
−
lv_state_t lv_obj_get_state(const lv_obj_t *obj)
 
−
: Get the state of an object
 
−
:Parameters
 
−
:: obj -- pointer to an object
 
−
:Returns
 
−
:: the state (OR-ed values from <code style="color: #bb0000;">lv_state_t</code>)
 
  
−
bool lv_obj_has_state(const lv_obj_t *obj, lv_state_t state)
+
=== Extended click area ===
−
: Check if the object is in a given state or not.
+
{| class="wikitable"
−
:Parameters
+
!英文
−
::* obj -- pointer to an object
+
!自動翻訳
−
::* state -- a state or combination of states to check
+
|-
−
:Returns
+
|
−
:: true: <code style="color: #bb0000;">obj</code> is in <code style="color: #bb0000;">state</code>false: <code style="color: #bb0000;">obj</code> is not in <code style="color: #bb0000;">state</code>
+
By default, the objects can be clicked only on their coordinates, however, this area can be extended with <code style="color: #bb0000;">lv_obj_set_ext_click_area(obj, left, right, top, bottom)</code>.
  
−
void *lv_obj_get_group(const lv_obj_t *obj)
+
<code style="color: #bb0000;">left/right/top/bottom</code> describes how far the clickable area should extend past the default in each direction.
−
: Get the group of the object
 
−
:Parameters
 
−
:: obj -- pointer to an object
 
−
:Returns
 
−
:: the pointer to group of the object
 
  
−
static inline void *lv_obj_get_user_data(lv_obj_t *obj)
 
−
: Get the user_data field of the object
 
−
:Parameters
 
−
:: obj -- pointer to an object
 
−
:Returns
 
−
:: the pointer to the user_data of the object
 
  
−
void lv_obj_allocate_spec_attr(lv_obj_t *obj)
+
This feature needs to enabled in ''lv_conf.h'' with <code style="color: #bb0000;">LV_USE_EXT_CLICK_AREA</code>.  
−
: Allocate special data for an object if not allocated yet.
 
−
:Parameters
 
−
:: obj -- pointer to an object
 
  
−
bool lv_obj_check_type(const lv_obj_t *obj, const lv_obj_class_t *class_p)
+
The possible values are:
−
: Check the type of obj.
 
−
:Parameters
 
−
::* obj -- pointer to an object
 
−
::* class_p -- a class to check (e.g. <code style="color: #bb0000;">lv_slider_class</code>)
 
−
:Returns
 
−
:: true: <code style="color: #bb0000;">class_p</code> is the <code style="color: #bb0000;">obj</code> class.
 
  
−
bool lv_obj_has_class(const lv_obj_t *obj, const lv_obj_class_t *class_p)
+
* LV_EXT_CLICK_AREA_FULL store all 4 coordinates as <code style="color: #bb0000;">lv_coord_t</code>
−
: Check if any object has a given class (type). It checks the ancestor classes too.
+
* LV_EXT_CLICK_AREA_TINY store only horizontal and vertical coordinates (use the greater value of left/right and top/bottom) as <code style="color: #bb0000;">uint8_t</code>
−
:Parameters
+
* LV_EXT_CLICK_AREA_OFF Disable this feature
−
::* obj -- pointer to an object
+
|デフォルトでは、オブジェクトは座標上でのみクリックできますが、この領域は<code style="color: #bb0000;">v_obj_set_ext_click_area(obj, left, right, top, bottom)</code>で拡張できます。
−
::* class_p -- a class to check (e.g. <code style="color: #bb0000;">lv_slider_class</code>)
+
<code style="color: #bb0000;">left/right/top/bottom</code>は、クリック可能な領域がデフォルトを超えて各方向にどれだけ拡張されるかを示します。
−
:Returns
 
−
:: true: <code style="color: #bb0000;">obj</code> has the given class
 
  
−
const lv_obj_class_t *lv_obj_get_class(const lv_obj_t *obj)
 
−
: Get the class (type) of the object
 
−
:Parameters
 
−
:: obj -- pointer to an object
 
−
:Returns
 
−
:: the class (type) of the object
 
  
−
bool lv_obj_is_valid(const lv_obj_t *obj)
+
この機能は、<code style="color: #bb0000;">LV_USE_EXT_CLICK_AREA</code> を使用して lv_conf.h で有効にする必要があります。
−
: Check if any object is still "alive".
 
−
:Parameters
 
−
:: obj -- pointer to an object
 
−
:Returns
 
−
:: true: valid
 
  
−
static inline lv_coord_t lv_obj_dpx(const lv_obj_t *obj, lv_coord_t n)
+
可能な値は次のとおりです。
−
: Scale the given number of pixels (a distance or size) relative to a 160 DPI display considering the DPI of the <code style="color: #bb0000;">obj</code>'s display. It ensures that e.g. <code style="color: #bb0000;">lv_dpx(100)</code> will have the same physical size regardless to the DPI of the display.
 
−
:Parameters
 
−
::* obj -- an object whose display's dpi should be considered
 
−
::* n -- the number of pixels to scale
 
−
:Returns
 
−
:: <code style="color: #bb0000;">n x current_dpi/160</code>
 
  
−
Variables
+
* LV_EXT_CLICK_AREA_FULL 4 つの座標すべてを <code style="color: #bb0000;">lv_coord_t</code> として保存します
 +
* LV_EXT_CLICK_AREA_TINY は、<code style="color: #bb0000;">uint8_t</code> として水平および垂直座標のみを格納します (左/右および上/下の大きい方の値を使用)。
 +
* LV_EXT_CLICK_AREA_OFF この機能を無効にする
 +
|}
 +
:[[App:Library:LVGL:docs:Widgets|戻る : Previous]]
  
−
const lv_obj_class_t lv_obj_class
 
−
: Make the base object's class publicly available.
 
  
−
struct _lv_obj_spec_attr_t
+
== Events ==
−
: ''#include <lv_obj.h>'' Special, rarely used attributes. They are allocated automatically if any elements is set.  Public Members
+
{| class="wikitable"
−
:struct _lv_obj_t **children
+
!英文
−
:: Store the pointer of the children in an array.
+
!自動翻訳
−
:uint32_t child_cnt
+
|-
−
:: Number of children
+
|Only the [[App:Library:LVGL:docs:Overview:Events#Generic events|'''<u>Generic events</u>''']] are sent by the object type.
−
:lv_group_t *group_p
 
−
::
 
−
:struct _lv_event_dsc_t *event_dsc
 
−
:: Dynamically allocated event callback and user data array
 
−
:lv_point_t scroll
 
−
:: The current X/Y scroll offset
 
−
:lv_coord_t ext_click_pad
 
−
:: Extra click padding in all direction
 
−
:lv_coord_t ext_draw_size
 
−
:: EXTend the size in every direction for drawing.
 
−
:lv_scrollbar_mode_t scrollbar_mode
 
−
:: How to display scrollbars
 
−
:lv_scroll_snap_t scroll_snap_x
 
−
:: Where to align the snappable children horizontally
 
−
:lv_scroll_snap_t scroll_snap_y
 
−
:: Where to align the snappable children vertically
 
−
:lv_dir_t scroll_dir
 
−
:: The allowed scroll direction(s)
 
−
:uint8_t event_dsc_cnt
 
−
:: Number of event callbacks stored in <code style="color: #bb0000;">event_dsc</code> array
 
  
−
struct _lv_obj_t
 
−
: Public Members
 
−
:const lv_obj_class_t *class_p
 
−
::
 
−
:struct _lv_obj_t *parent
 
−
::
 
−
:_lv_obj_spec_attr_t *spec_attr
 
−
::
 
−
:_lv_obj_style_t *styles
 
−
::
 
−
:void *user_data
 
−
::
 
−
:lv_area_t coords
 
−
::
 
−
:lv_obj_flag_t flags
 
−
::
 
−
:lv_state_t state
 
−
::
 
−
:uint16_t layout_inv
 
−
::
 
−
:uint16_t scr_layout_inv
 
−
::
 
−
:uint16_t skip_trans
 
−
::
 
−
:uint16_t style_cnt
 
−
::
 
−
:uint16_t h_layout
 
−
::
 
−
:uint16_t w_layout
 
  
 +
Learn more about [[App:Library:LVGL:docs:Overview:Events|<u>'''Events'''</u>]].
  
 +
|オブジェクト タイプによって送信されるのは [[App:Library:LVGL:docs:Overview:Events#Generic events|'''<u>Generic events</u>''']] のみです。
  
 +
詳細は[[App:Library:LVGL:docs:Overview:Events|<u>'''Events'''</u>]]をご覧ください。
  
 +
|}
 +
:[[App:Library:LVGL:docs:Widgets|戻る : Previous]]
  
  
 +
== Keys ==
 +
{| class="wikitable"
 +
!英文
 +
!自動翻訳
 +
|-
 +
|
 +
No ''Keys'' are processed by the object type.
 +
 +
 +
Learn more about [[App:Library:LVGL:docs:Overview:Input devices|'''<u>Keys</u>''']].
 +
|オブジェクト タイプによって処理されるキーはありません。
 +
 +
 +
詳細は[[App:Library:LVGL:docs:Overview:Input devices|'''<u>Keys</u>''']]をご覧ください。
 +
|}
 +
:[[App:Library:LVGL:docs:Widgets|戻る : Previous]]
  
  
 +
== Example ==
 +
=== Base objects with custom styles ===
 +
{| class="wikitable"
 +
|-
 +
|[[file:LVGL Lib docs BaseObj.png|link=https://docs.lvgl.io/latest/en/html/widgets/obj.html#base-objects-with-custom-styles]]
 +
|}
 +
:[[App:Library:LVGL:docs:Widgets|戻る : Previous]]
  
 +
== [https://docs.lvgl.io/latest/en/html/widgets/obj.html#api API] ==
  
  
  
−
:[[App:Library:LVGL#Widgets|戻る : Previous]]
+
:[[App:Library:LVGL:docs:Widgets|戻る : Previous]]

2022年8月31日 (水) 21:20時点における最新版

https://docs.lvgl.io/latest/en/html/widgets/obj.html

https://docs.lvgl.io/8.2/widgets/index.html


Base object (lv_obj)

Overview

英文 自動翻訳

The 'Base Object' implements the basic properties of widgets on a screen, such as:

  • coordinates
  • parent object
  • children
  • contains the styles
  • attributes like Clickable, Scrollable, etc.


In object-oriented thinking, it is the base class from which all other objects in LVGL are inherited.

This, among another things, helps reduce code duplication.

The functions and functionalities of Base object can be used with other widgets too. For example lv_obj_set_width(slider, 100)


The Base object can be directly used as a simple widgets. It nothing else then a rectangle.

ベースオブジェクト」は、画面上のウィジェットの基本的なプロパティを実装したもので、次のようなものです。
  • 座標
  • 親オブジェクト
  • 子供
  • スタイルが含まれています
  • Clickable、Scrollableなどの属性。


オブジェクト指向の考え方では、LVGL の他のすべてのオブジェクトが継承される基本クラスです。

これはコードの重複を減らすのに役立ちます。


Base オブジェクトの関数と機能は、他のウィジェットでも使用できます。 例えば lv_obj_set_width(slider, 100)


Base オブジェクトは、単純なウィジェットとして直接使用できます。 長方形に他なりません。

戻る : Previous


Coordinates

Size

英文 自動翻訳

The object size can be modified on individual axes with lv_obj_set_width(obj, new_width) and lv_obj_set_height(obj, new_height), or both axes can be modified at the same time with lv_obj_set_size(obj, new_width, new_height).


Styles can add Margin to the objects. Margin tells that "I want this space around me". To set width or height reduced by the margin lv_obj_set_width_margin(obj, new_width) or lv_obj_set_height_margin(obj, new_height). In more exact way: new_width = left_margin + object_width + right_margin.


To get the width or height which includes the margins use lv_obj_get_width/height_margin(obj).


Styles can add Padding to the object as well. Padding means "I don't want my children too close to my sides, so keep this space".

To set width or height reduced by the padding lv_obj_set_width_fit(obj, new_width) or lv_obj_set_height_fit(obj, new_height).

In a more exact way: new_width = left_pad + object_width + right_pad

To get the width or height which is REDUCED by padding use lv_obj_get_width/height_fit(obj).

It can be considered the "useful size of the object".


Margin and padding gets important when Layout or Auto-fit is used by other widgets.

オブジェクトのサイズは、lv_obj_set_width(obj, new_width)およびlv_obj_set_height(obj, new_height)を使用して個々の軸上で変更することも、lv_obj_set_size(obj, new_width, new_height)を使用して両方の軸を同時に変更することもできます。


スタイルは、オブジェクトに余白を追加できます。 マージンは「自分の周りにこのスペースが欲しい」と語っています。 マージン lv_obj_set_width_margin(obj, new_width)または lv_obj_set_height_margin(obj, new_height) だけ縮小された幅または高さを設定します。 より正確には、new_width = left_margin + object_width + right_margin です。


マージンを含む幅または高さを取得するには、lv_obj_get_width/height_margin(obj)を使用します。


スタイルは、オブジェクトにパディングを追加することもできます。 パディングとは、「子供たちを脇に近づけたくないので、このスペースを確保してください」という意味です。

パディング lv_obj_set_width_fit(obj, new_width) または lv_obj_set_height_fit(obj, new_height)によって縮小された幅または高さを設定します。

より正確な方法: new_width = left_pad + object_width + right_pad

パディングによって削減された幅または高さを取得するには、lv_obj_get_width/height_fit(obj)を使用します。

これは「オブジェクトの有用なサイズ」と見なすことができます。


レイアウトまたは自動調整が他のウィジェットで使用されている場合、マージンとパディングが重要になります。

戻る : Previous


Position

英文 自動翻訳

You can set the position relative to the parent with lv_obj_set_x(obj, new_x) and lv_obj_set_y(obj, new_y), or both axes at the same time with lv_obj_set_pos(obj, new_x, new_y).

親からの相対位置は、lv_obj_set_x(obj, new_x)とlv_obj_set_y(obj, new_y)、またはlv_obj_set_pos(obj, new_x, new_y)を使用して同時に設定できます。
戻る : Previous


Alignment

英文 自動翻訳
You can align the object to another with lv_obj_align(obj, obj_ref, LV_ALIGN_..., x_ofs, y_ofs).
  • obj is the object to align.
  • obj_ref is a reference object. obj will be aligned to it. If obj_ref = NULL, then the parent of obj will be used.
  • The third argument is the type of alignment. These are the possible options:
 lv_obj_align(obj, obj_ref, LV_ALIGN_..., x_ofs, y_ofs) を使用して、オブジェクトを別のオブジェクトに位置合わせできます。
  • obj は整列するオブジェクトです。
  • obj_ref は参照オブジェクトです。 obj がそれに合わせられます。 obj_ref = NULL の場合、obj の親が使用されます。
  • 3 番目の引数は、配置のタイプです。 可能なオプションは次のとおりです。
LVGL Lib docs obj.png
  • The alignment types build like LV_ALIGN_OUT_TOP_MID.
  • The last two arguments allow you to shift the object by a specified number of pixels after aligning it.
  • 配置タイプは LV_ALIGN_OUT_TOP_MID のように構築されます。
  • 最後の 2 つの引数を使用すると、位置合わせ後に、指定したピクセル数だけオブジェクトをシフトできます。
For example, to align a text below an image: lv_obj_align(text, image, LV_ALIGN_OUT_BOTTOM_MID, 0, 10).

Or to align a text in the middle of its parent: lv_obj_align(text, NULL, LV_ALIGN_CENTER, 0, 0).


lv_obj_align_origo works similarly to lv_obj_align but it aligns the center of the object.


For example, lv_obj_align_origo(btn, image, LV_ALIGN_OUT_BOTTOM_MID, 0, 0) will align the center of the button the bottom of the image.


The parameters of the alignment will be saved in the object if LV_USE_OBJ_REALIGN is enabled in lv_conf.h.

You can then realign the objects simply by calling lv_obj_realign(obj).

It's equivalent to calling lv_obj_align again with the same parameters.

たとえば、画像の下にテキストを配置するには: lv_obj_align(text, image, LV_ALIGN_OUT_BOTTOM_MID, 0, 10)。

または、テキストをその親の中央に配置するには: lv_obj_align(text, NULL, LV_ALIGN_CENTER, 0, 0)。


lv_obj_align_origo は lv_obj_align と同様に機能しますが、オブジェクトの中心を揃えます。


たとえば、lv_obj_align_origo(btn, image, LV_ALIGN_OUT_BOTTOM_MID, 0, 0) は、ボタンの中心を画像の下に揃えます。


LV_USE_OBJ_REALIGN が lv_conf.h で有効になっている場合、アラインメントのパラメーターはオブジェクトに保存されます。

その後、lv_obj_realign(obj) を呼び出すだけでオブジェクトを再配置できます。

同じパラメーターで lv_obj_align を再度呼び出すことと同じです。

If the alignment happened with lv_obj_align_origo, then it will be used when the object is realigned.


The lv_obj_align_x/y and lv_obj_align_origo_x/y function can be used t align only on one axis.


If lv_obj_set_auto_realign(obj, true) is used the object will be realigned automatically, if its size changes in lv_obj_set_width/height/size() functions. It's very useful when size animations are applied to the object and the original position needs to be kept.


Note that the coordinates of screens can't be changed. Attempting to use these functions on screens will result in undefined behavior.

アライメントが lv_obj_align_origo で発生した場合、オブジェクトが再アライメントされるときに使用されます。


lv_obj_align_x/y および lv_obj_align_origo_x/y関数は、1 つの軸でのみ整列するために使用できます。


lv_obj_set_auto_realign(obj, true) が使用されている場合、そのサイズが lv_obj_set_width/height/size() 関数で変更された場合、オブジェクトは自動的に再配置されます。 オブジェクトにサイズ アニメーションを適用し、元の位置を維持する必要がある場合に非常に便利です。


画面の座標は変更できないことに注意してください。 これらの関数を画面で使用しようとすると、未定義の動作が発生します。

戻る : Previous


Parents and children

英文 自動翻訳
You can set a new parent for an object with lv_obj_set_parent(obj, new_parent).

To get the current parent, use lv_obj_get_parent(obj).

To get the children of an object, use lv_obj_get_child(obj, child_prev) (from last to first) or lv_obj_get_child_back(obj, child_prev) (from first to last). To get the first child, pass NULL as the second parameter and use the return value to iterate through the children. The function will return NULL if there are no more children. For example:

lv_obj_set_parent(obj, new_parent)を使用して、オブジェクトの新しい親を設定できます。

現在の親を取得するには、lv_obj_get_parent(obj) を使用します。


オブジェクトの子を取得するには、llv_obj_get_child(obj, child_prev) (最後から最初へ) または lv_obj_get_child_back(obj, child_prev) (最初から最後へ) を使用します。 最初の子を取得するには、2 番目のパラメーターとして NULL を渡し、戻り値を使用して子を反復処理します。 子がそれ以上ない場合、関数は NULL を返します。 例えば： 

lv_obj_t * child = lv_obj_get_child(parent, NULL);
while(child) {
    /*Do something with "child" */
    child = lv_obj_get_child(parent, child);
}
lv_obj_get_index(obj) tells the number of children on an object.

It is equivalent to the number of younger children in the parent.


lv_obj_count_children_recursive(obj) also tells the number of children but counts children of children recursively.

lv_obj_get_index(obj) は、オブジェクトの子の数を示します。

これは、親の年少の子供の数に相当します。


lv_obj_count_children_recursive(obj) も子の数を示しますが、子の子を再帰的にカウントします。

戻る : Previous


Screens

英文 自動翻訳

When you have created a screen like lv_obj_t * screen = lv_obj_create(NULL, NULL), you can load it with lv_scr_load(screen).

The lv_scr_act() function gives you a pointer to the current screen.


If you have more display then it's important to know that these functions operate on the lastly created or the explicitly selected (with lv_disp_set_default) display.


To get an object's screen use the lv_obj_get_screen(obj) function.

lv_obj_t * screen = lv_obj_create(NULL, NULL)のように画面を作成したら、lv_scr_load(screen) で読み込むことができます。

lv_scr_act()関数は、現在の画面へのポインターを提供します。


より多くのディスプレイがある場合、これらの関数は最後に作成されたディスプレイまたは明示的に選択された (lv_disp_set_defaultを使用して) ディスプレイで動作することを知っておくことが重要です。


オブジェクトの画面を取得するには、lv_obj_get_screen(obj)関数を使用します。

戻る : 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 too. 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 here in lv_indev_set_cursor()).


The lv_layer_top() and lv_layer_sys() functions gives a pointer to the top or system layer.


You can bring an object to the foreground or send it to the background with lv_obj_move_foreground(obj) and lv_obj_move_background(obj).


Read the Layer overview section to learn more about layers.

2 つの自動生成レイヤーがあります。
  • 上層
  • システム層


それらは画面から独立しており、すべての画面に表示されます。 最上位レイヤーは画面上のすべてのオブジェクトの上にあり、システム レイヤーも最上位レイヤーの上にあります。

最上層に任意のポップアップ ウィンドウを自由に追加できます。

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


lv_layer_top() およびlv_layer_sys()関数は、最上位層またはシステム層へのポインターを提供します。


lv_obj_move_foreground(obj) と lv_obj_move_background(obj)を使用して、オブジェクトをフォアグラウンドに移動したり、バックグラウンドに移動したりできます。


layersの詳細については、レイヤーの概要セクションを参照してください。

戻る : Previous


Events

英文 自動翻訳

To set an event callback for an object, use lv_obj_add_event_cb(obj, event_cb, LV_EVENT_..., user_data),


To manually send an event to an object, use lv_event_send(obj, LV_EVENT_..., param)

Read the Event overview to learn more about events.

オブジェクトにイベントコールバックを設定するには、lv_obj_add_event_cb(obj, event_cb, LV_EVENT_..., user_data)を使い、

イベントを手動でオブジェクトに送信するには、lv_event_send(obj, LV_EVENT_..., param)を使います。

イベントの詳細については、 「イベントの概要」 を参照してください。

戻る : Previous


Parts

英文 自動翻訳
To set an event callback for an object, use lv_obj_set_event_cb(obj, event_cb),


To manually send an event to an object, use lv_event_send(obj, LV_EVENT_..., data)


Read the Event overview to learn more about the events.

オブジェクトのイベント コールバックを設定するには、lv_obj_set_event_cb(obj, event_cb)を使用します。


イベントをオブジェクトに手動で送信するには、lv_event_send(obj, LV_EVENT_..., data) を使用します。


イベントの詳細については、イベントの概要をご覧ください。

戻る : Previous

States

英文 自動翻訳
The widgets can have multiple parts. For example a Button has only a main part but a Slider is built from a background, an indicator and a knob.


The name of the parts is constructed like LV_ + <TYPE> _PART_ <NAME>. For example LV_BTN_PART_MAIN or LV_SLIDER_PART_KNOB. The parts are usually used when styles are add to the objects. Using parts different styles can be assigned to the different parts of the objects.


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

ウィジェットには複数のパーツを含めることができます。 たとえば、ボタンには主要な部分しかありませんが、スライダーは背景、インジケーター、およびノブから構築されます。



パーツの名前は、LV_ + <TYPE> _PART_ <NAME>のように構成されます。 たとえば、LV_BTN_PART_MAIN または LV_SLIDER_PART_KNOB です。 パーツは通常、オブジェクトにスタイルを追加するときに使用されます。 パーツを使用すると、オブジェクトのさまざまなパーツにさまざまなスタイルを割り当てることができます。


パーツの詳細については、スタイルの概要の関連セクションをお読みください。

戻る : Previous


Styles

英文 自動翻訳

Be sure to read the Style overview first.


To add a style to an object use lv_obj_add_style(obj, part, &new_style) function.

The Base object use all the rectangle-like style properties.


To remove all styles from an object use lv_obj_reset_style_list(obj, part)


If you modify a style, which is already used by objects, in order to refresh the affected objects you can use either lv_obj_refresh_style(obj) on each object using it or to notify all objects with a given style use lv_obj_report_style_mod(&style).

If the parameter of lv_obj_report_style_mod is NULL, all objects will be notified.

最初に必ずスタイルの概要をお読みください。



オブジェクトにスタイルを追加するには、lv_obj_add_style(obj, part, &new_style) 関数を使用します。

Base オブジェクトは、すべての長方形のようなスタイル プロパティを使用します。


オブジェクトからすべてのスタイルを削除するには、lv_obj_reset_style_list(obj, part)を使用します


オブジェクトで既に使用されているスタイルを変更する場合、影響を受けるオブジェクトを更新するには、それを使用する各オブジェクトで lv_obj_refresh_style(obj) を使用するか、指定されたスタイルを持つすべてのオブジェクトに lv_obj_report_style_mod(&style)を使用して通知します。 lv_obj_report_style_modのパラメーターが NULL の場合、すべてのオブジェクトが通知されます。

戻る : Previous


Attributes

英文 自動翻訳
There are some attributes which can be enabled/disabled by lv_obj_set_...(obj, true/false):
  • hidden - Hide the object. It will not be drawn and will be considered by input devices as if it doesn't exist., Its children will be hidden too.
  • click - Allows you to click the object via input devices. If disabled, then click events are passed to the object behind this one. (E.g. Labels are not clickable by default)
  • top - If enabled then when this object or any of its children is clicked then this object comes to the foreground.
  • drag - Enable dragging (moving by an input device)
  • drag_dir - Enable dragging only in specific directions. Can be LV_DRAG_DIR_HOR/VER/ALL.
  • drag_throw - Enable "throwing" with dragging as if the object would have momentum
  • drag_parent - If enabled then the object's parent will be moved during dragging. It will look like as if the parent is dragged. Checked recursively, so can propagate to grandparents too.
  • parent_event - Propagate the events to the parents too. Checked recursively, so can propagate to grandparents too.
  • opa_scale_enable - Enable opacity scaling. See the [#opa-scale](Opa scale) section.
 lv_obj_set_...(obj, true/false)で有効/無効にできる属性がいくつかあります:
  • hidden - オブジェクトを隠します。それは描画されず、入力デバイスによって存在しないかのように見なされます。その子も非表示になります。
  • click - 入力デバイスを介してオブジェクトをクリックできるようにします。無効にすると、クリック イベントはこのオブジェクトの背後にあるオブジェクトに渡されます。 (例: ラベルはデフォルトではクリックできません)
  • top - 有効にすると、このオブジェクトまたはその子のいずれかをクリックすると、このオブジェクトが前面に表示されます。
  • drag - ドラッグを有効にする (入力デバイスによる移動)
  • drag_dir - 特定の方向へのドラッグのみを有効にします。 LV_DRAG_DIR_HOR/VER/ALLを指定できます。
  • drag_throw - オブジェクトに勢いがあるかのように、ドラッグで「投げ」を有効にします
  • drag_parent - 有効にすると、ドラッグ中にオブジェクトの親が移動します。親がドラッグされているように見えます。再帰的にチェックされるため、祖父母にも伝播できます。
  • parent_event - イベントを親にも伝播します。再帰的にチェックされるため、祖父母にも伝播できます。
  • opa_scale_enable - 不透明度のスケーリングを有効にします。 [#opa-scale](オパ スケール) セクションを参照してください。
戻る : Previous


Protect

英文 自動翻訳
There are some specific actions which happen automatically in the library.

To prevent one or more that kind of actions, you can protect the object against them.

The following protections exists:

  • LV_PROTECT_NONE No protection
  • LV_PROTECT_POS Prevent automatic positioning (e.g. Layout in Containers)
  • LV_PROTECT_FOLLOW Prevent the object be followed (make a "line break") in automatic ordering (e.g. Layout in Containers)
  • LV_PROTECT_PARENT Prevent automatic parent change. (e.g. Page moves the children created on the background to the scrollable)
  • LV_PROTECT_PRESS_LOST Prevent losing press when the press is slid out of the objects. (E.g. a Button can be released out of it if it was being pressed)
  • LV_PROTECT_CLICK_FOCUS Prevent automatically focusing the object if it's in a Group and click focus is enabled.
  • LV_PROTECT_CHILD_CHG Disable the child change signal. Used internally by the library


The lv_obj_add/clear_protect(obj, LV_PROTECT_...) sets/clears the protection. You can use 'OR'ed values of protection types too.

ライブラリで自動的に発生する特定のアクションがいくつかあります。

そのようなアクションを 1 つ以上防止するために、オブジェクトをそれらから保護することができます。

次の保護が存在します。

  • LV_PROTECT_NONE 保護なし
  • LV_PROTECT_POS 自動配置を防止します (例: コンテナー内のレイアウト)
  • LV_PROTECT_FOLLOW 自動順序付け (例: コンテナー内のレイアウト) でオブジェクトが続く (「改行」を行う) のを防ぎます。
  • LV_PROTECT_PARENT 自動親変更を防ぎます。 (例: Page は、背景に作成された子をスクロール可能に移動します)
  • LV_PROTECT_PRESS_LOST プレスがオブジェクトからスライドしたときにプレスが失われるのを防ぎます。 (たとえば、ボタンが押されていた場合、ボタンを離すことができます)
  • LV_PROTECT_CLICK_FOCUS オブジェクトがグループ内にあり、クリック フォーカスが有効になっている場合、オブジェクトが自動的にフォーカスされるのを防ぎます。
  • LV_PROTECT_CHILD_CHG 子変更信号を無効にします。ライブラリによって内部的に使用されます


lv_obj_add/clear_protect(obj, LV_PROTECT_...) は、保護を設定/クリアします。保護タイプの「OR」値も使用できます。

戻る : Previous


Groups

英文 自動翻訳

Once, an object is added to group with lv_group_add_obj(group, obj) the object's current group can be get with lv_obj_get_group(obj).


lv_obj_is_focused(obj) tells if the object is currently focused on its group or not. If the object is not added to a group, false will be returned.


Read the Input devices overview to learn more about the Groups.

オブジェクトが lv_group_add_obj(group, obj)でグループに追加されると、オブジェクトの現在のグループは lv_obj_get_group(obj) で取得できます。


lv_obj_is_focused(obj)は、オブジェクトが現在そのグループにフォーカスされているかどうかを示します。 オブジェクトがグループに追加されていない場合は、false が返されます。


グループの詳細については、入力デバイスの概要をご覧ください。

戻る : Previous


Extended click area

英文 自動翻訳

By default, the objects can be clicked only on their coordinates, however, this area can be extended with lv_obj_set_ext_click_area(obj, left, right, top, bottom).

left/right/top/bottom describes how far the clickable area should extend past the default in each direction.


This feature needs to enabled in lv_conf.h with LV_USE_EXT_CLICK_AREA.

The possible values are:

  • LV_EXT_CLICK_AREA_FULL store all 4 coordinates as lv_coord_t
  • LV_EXT_CLICK_AREA_TINY store only horizontal and vertical coordinates (use the greater value of left/right and top/bottom) as uint8_t
  • LV_EXT_CLICK_AREA_OFF Disable this feature
 デフォルトでは、オブジェクトは座標上でのみクリックできますが、この領域はv_obj_set_ext_click_area(obj, left, right, top, bottom)で拡張できます。

left/right/top/bottomは、クリック可能な領域がデフォルトを超えて各方向にどれだけ拡張されるかを示します。


この機能は、LV_USE_EXT_CLICK_AREA を使用して lv_conf.h で有効にする必要があります。

可能な値は次のとおりです。

  • LV_EXT_CLICK_AREA_FULL 4 つの座標すべてを lv_coord_t として保存します
  • LV_EXT_CLICK_AREA_TINY は、uint8_t として水平および垂直座標のみを格納します (左/右および上/下の大きい方の値を使用)。
  • LV_EXT_CLICK_AREA_OFF この機能を無効にする
戻る : Previous


Events

英文 自動翻訳
Only the Generic events are sent by the object type.


Learn more about Events.

オブジェクト タイプによって送信されるのは Generic events のみです。

詳細はEventsをご覧ください。

戻る : Previous


Keys

英文 自動翻訳

No Keys are processed by the object type.


Learn more about Keys.

オブジェクト タイプによって処理されるキーはありません。


詳細はKeysをご覧ください。

戻る : Previous


Example

Base objects with custom styles

LVGL Lib docs BaseObj.png
戻る : Previous

API

戻る : Previous
「https://robot-jp.com/wiki/index.php?title=App:Library:LVGL:docs:Widgets:Base_object&oldid=5493」から取得