App:Library:LVGL:docs:Overview:Scroll

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

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

Scroll

Overview

英文 自動翻訳

In LVGL scrolling works very intuitively: if an object is outside its parent content area (the size without padding), the parent becomes scrollable and scrollbar(s) will appear.

That's it.


Any object can be scrollable including lv_obj_t, lv_img, lv_btn, lv_meter, etc.

The object can either be scrolled horizontally or vertically in one stroke; diagonal scrolling is not possible.

LVGLのスクロールは、非常に直感的に動作します。オブジェクトが親のコンテンツ領域（パディングなしのサイズ）の外に出た場合、親はスクロール可能になり、スクロールバー（複数可）が表示されます。

これだけです。


lv_obj_t, lv_img, lv_btn, lv_meter,など、どんなオブジェクトもスクロール可能にすることができます。

オブジェクトは、水平または垂直にのみスクロールできます。

斜め方向のスクロールはできません。

戻る : Previous


Scrollbar

Mode

英文 自動翻訳

Scrollbars are displayed according to a configured mode. The following modes exist:

  • LV_SCROLLBAR_MODE_OFF Never show the scrollbars
  • LV_SCROLLBAR_MODE_ON Always show the scrollbars
  • LV_SCROLLBAR_MODE_ACTIVE Show scroll bars while an object is being scrolled
  • LV_SCROLLBAR_MODE_AUTO Show scroll bars when the content is large enough to be scrolled

lv_obj_set_scrollbar_mode(obj, LV_SCROLLBAR_MODE_...) sets the scrollbar mode on an object.

スクロールバーは、設定されたmodeに従って表示されます。以下のmodeが存在する。
  • LV_SCROLLBAR_MODE_OFF スクロールバーは表示しません。
  • LV_SCROLLBAR_MODE_ON スクロールバーを常に表示する。
  • LV_SCROLLBAR_MODE_ACTIVE オブジェクトをスクロールしている間、スクロールバーを表示します。
  • LV_SCROLLBAR_MODE_AUTO コンテンツがスクロール可能な大きさになったらスクロールバーを表示する

lv_obj_set_scrollbar_mode(obj, LV_SCROLLBAR_MODE_...) は、オブジェクトのスクロールバーモードを設定します。

戻る : Previous


Styling

英文 自動翻訳

The scrollbars have their own dedicated part, called LV_PART_SCROLLBAR.

For example a scrollbar can turn to red like this: 

 static lv_style_t style_red;
 lv_style_init(&style_red);
 lv_style_set_bg_color(&style_red, lv_color_red());
 
 ...
 
 lv_obj_add_style(obj, &style_red, LV_PART_SCROLLBAR);

An object goes to the LV_STATE_SCROLLED state while it's being scrolled.


This allows adding different styles to the scrollbar or the object itself when scrolled.

This code makes the scrollbar blue when the object is scrolled: 

 static lv_style_t style_blue;
 lv_style_init(&style_blue);
 lv_style_set_bg_color(&style_blue, lv_color_blue());
 
 ...
 
 lv_obj_add_style(obj, &style_blue, LV_STATE_SCROLLED | LV_PART_SCROLLBAR);

If the base direction of the LV_PART_SCROLLBAR is RTL (LV_BASE_DIR_RTL) the vertical scrollbar will be placed on the left. Note that, the base_dir style property is inherited.


Therefore, it can be set directly on the LV_PART_SCROLLBAR part of an object or on the object's or any parent's main part to make a scrollbar inherit the base direction.

pad_left/right/top/bottom sets the spacing around the scrollbars and width sets the scrollbar's width.

スクロールバーは、LV_PART_SCROLLBARという専用のパーツを持っています。

例えば、スクロールバーはこのように赤色に変化します。 

 static lv_style_t style_red;
 lv_style_init(&style_red);
 lv_style_set_bg_color(&style_red, lv_color_red());
 
 ...
 
 lv_obj_add_style(obj, &style_red, LV_PART_SCROLLBAR);

オブジェクトは、スクロールされている間、LV_STATE_SCROLLED 状態になります。


これにより、スクロールされたときに、スクロールバーやオブジェクト自体に異なるスタイルを追加することができます。

このコードでは、オブジェクトがスクロールされると、スクロールバーが青くなります。 

 static lv_style_t style_blue;
 lv_style_init(&style_blue);
 lv_style_set_bg_color(&style_blue, lv_color_blue());
 
 ...
 
 lv_obj_add_style(obj, &style_blue, LV_STATE_SCROLLED | LV_PART_SCROLLBAR);

LV_PART_SCROLLBAR ベース方向がRTL (LV_BASE_DIR_RTL)の場合、垂直スクロールバーは左側に配置されます。なお、base_dir style プロパティは継承されます。


したがって、オブジェクトの LV_PART_SCROLLBAR部分に直接設定するか、オブジェクトまたは任意の親のメインパーツに設定して、スクロールバーにベース方向を継承させることが可能です。


pad_left/right/top/bottomは、スクロールバーの周囲の間隔を設定し、width は、スクロールバーの幅を設定します。

戻る : Previous

Events

英文 自動翻訳

The following events are related to scrolling:

  • LV_EVENT_SCROLL_BEGIN Scrolling begins
  • LV_EVENT_SCROLL_END Scrolling ends
  • LV_EVENT_SCROLL Scroll happened. Triggered on every position change. Scroll events
 スクロールに関連するイベントとして、以下のものがあります。
  • LV_EVENT_SCROLL_BEGIN スクロール開始
  • LV_EVENT_SCROLL_END スクロール終了
  • LV_EVENT_SCROLL スクロールが発生した。位置が変わるごとにトリガーされます。スクロールイベント
戻る : Previous


Basic example

英文 自動翻訳

TODO

戻る : Previous


Features of scrolling

英文 自動翻訳

Besides, managing "normal" scrolling there are many interesting and useful additional features.

また、「通常の」スクロールを管理する以外にも、多くの興味深く便利な機能が追加されています。
戻る : Previous


Scrollable

英文 自動翻訳

It's possible to make an object non-scrollable with lv_obj_clear_flag(obj, LV_OBJ_FLAG_SCROLLABLE).


Non-scrollable objects can still propagate the scrolling (chain) to their parents.


The direction in which scrolling happens can be controlled by lv_obj_set_scroll_dir(obj, LV_DIR_...).


The following values are possible for the direction:

  • LV_DIR_TOP only scroll up
  • LV_DIR_LEFT only scroll left
  • LV_DIR_BOTTOM only scroll down
  • LV_DIR_RIGHT only scroll right
  • LV_DIR_HOR only scroll horizontally
  • LV_DIR_TOP only scroll vertically
  • LV_DIR_ALL scroll any directions


OR-ed values are also possible. E.g. LV_DIR_TOP | LV_DIR_LEFT.

lv_obj_clear_flag(obj, LV_OBJ_FLAG_SCROLLABLE).でオブジェクトをスクロール不可能にできます。


スクロール不可能なオブジェクトは、まだその親にスクロール（チェーン）を伝搬することができます。


スクロールが起こる方向は、 lv_obj_set_scroll_dir(obj, LV_DIR_...).によって制御することができます。


方向には次のような値が可能である。

  • LV_DIR_TOP 上方向のみスクロール
  • LV_DIR_LEFT 左方向のみスクロール
  • LV_DIR_BOTTOM 下方向のみスクロール
  • LV_DIR_RIGHT 右方向のみスクロール
  • LV_DIR_HOR 水平方向のみスクロール
  • LV_DIR_TOP 垂直方向のみスクロール
  • LV_DIR_ALL 任意の方向にスクロール


OR-ed値も可能。例： LV_DIR_TOP | LV_DIR_LEFT.

戻る : Previous


Scroll chain

英文 自動翻訳

If an object can't be scrolled further (e.g. its content has reached the bottom-most position) additional scrolling is propagated to its parent.


If the parent can be scrolled in that direction than it will be scrolled instead.


It continues propagating to the grandparent and grand-grandparents as well.


The propagation on scrolling is called "scroll chaining" and it can be enabled/disabled with LV_OBJ_FLAG_SCROLL_CHAIN_HOR/VER flag.


If chaining is disabled the propagation stops on the object and the parent(s) won't be scrolled.

オブジェクトがこれ以上スクロールできない場合 (たとえば、そのコンテンツが最下部に達した場合)、追加のスクロールがその親に伝搬されます。


親がその方向にスクロールできる場合は、代わりに親がスクロールされます。


これは、祖父母と孫祖父母にも同様に伝搬され続けます。


スクロール時の伝搬をスクロールチェイニングと呼び、LV_OBJ_FLAG_SCROLL_CHAIN_HOR/VER フラグで有効/無効を設定できます。


チェイニングを無効にすると、そのオブジェクトで伝播が止まり、親はスクロールされなくなります。

戻る : Previous


Scroll momentum

英文 自動翻訳

When the user scrolls an object and releases it, LVGL can emulate inertial momentum for the scrolling.


It's like the object was thrown and scrolling slows down smoothly.

The scroll momentum can be enabled/disabled with the LV_OBJ_FLAG_SCROLL_MOMENTUM flag.

ユーザーがオブジェクトをスクロールしてそれを放したとき、LVGLはスクロールの慣性モーメンタムをエミュレートすることができます。


オブジェクトが投げられたようになり、スクロールがスムーズに遅くなります。


スクロールの勢いは、LV_OBJ_FLAG_SCROLL_MOMENTUMフラグで有効/無効を設定することができます。

戻る : Previous


Elastic scroll

英文 自動翻訳

Normally an object can't be scrolled past the extremeties of its content.


That is the top side of the content can't be below the top side of the object.


However, with LV_OBJ_FLAG_SCROLL_ELASTIC a fancy effect is added when the user "over-scrolls" the content.


The scrolling slows down, and the content can be scrolled inside the object.


When the object is released the content scrolled in it will be animated back to the valid position.

通常、オブジェクトはそのコンテンツの極限を越えてスクロールすることはできません。


つまり、コンテンツの上側がオブジェクトの上側より下になることはありません。


しかし、LV_OBJ_FLAG_SCROLL_ELASTICを使用すると、ユーザーがコンテンツを「オーバースクロール」したときに、派手なエフェクトが追加されます。


スクロールは遅くなり、コンテンツはオブジェクトの内側でスクロールできるようになります。


オブジェクトがリリースされると、その中でスクロールされたコンテンツは有効な位置にアニメーションで戻されます。

戻る : Previous


Snapping

英文 自動翻訳

The children of an object can be snapped according to specific rules when scrolling ends. Children can be made snappable individually with the LV_OBJ_FLAG_SNAPPABLE flag.

An object can align snapped children in four ways:

  • LV_SCROLL_SNAP_NONE Snapping is disabled. (default)
  • LV_SCROLL_SNAP_START Align the children to the left/top side of a scrolled object
  • LV_SCROLL_SNAP_END Align the children to the right/bottom side of a scrolled object
  • LV_SCROLL_SNAP_CENTER Align the children to the center of a scrolled object

Snap alignment is set with lv_obj_set_scroll_snap_x/y(obj, LV_SCROLL_SNAP_...):

Under the hood the following happens:

  1. User scrolls an object and releases the screen
  2. LVGL calculates where the scroll would end considering scroll momentum
  3. LVGL finds the nearest scroll point
  4. LVGL scrolls to the snap point with an animation
 オブジェクトの子オブジェクトは、スクロール終了時に特定のルールに従ってスナップさせることができる。子オブジェクトは LV_OBJ_FLAG_SNAPPABLE フラグで個別にスナップ可能にすることができます。

オブジェクトは、スナップされた子オブジェクトを4つの方法で整列させることができます。

  • LV_SCROLL_SNAP_NONE スナップは無効です。(デフォルト)
  • LV_SCROLL_SNAP_START スクロールされたオブジェクトの左側/上側に子オブジェクトを配置します。
  • LV_SCROLL_SNAP_END Align the children to the right/bottom side of a scrolled object
  • LV_SCROLL_SNAP_CENTER スクロールされたオブジェクトの右側/下側に子オブジェクトを配置します。

スナップアライメントは lv_obj_set_scroll_snap_x/y(obj, LV_SCROLL_SNAP_...)で設定されます。

内部では、次のようになります。

  1. ユーザーがオブジェクトをスクロールし、画面を離す
  2. LVGLがスクロールの勢いを考慮し、スクロールの終了位置を計算する
  3. LVGLは最も近いスクロールポイントを見つけます
  4. LVGLはアニメーションでスナップポイントまでスクロールする
戻る : Previous


Scroll one

英文 自動翻訳

The "scroll one" feature tells LVGL to allow scrolling only one snappable child at a time.

This requires making the children snappable and setting a scroll snap alignment different from LV_SCROLL_SNAP_NONE.

This feature can be enabled by the LV_OBJ_FLAG_SCROLL_ONE flag.

"scroll one"機能は、LVGLに、一度に1つのスナップ可能な子だけをスクロールすることを許可するように指示します。

これには、子プロセスをスナップ可能にし、LV_SCROLL_SNAP_NONEとは異なるスクロールスナップアライメントを設定する必要があります。


この機能は、 LV_OBJ_FLAG_SCROLL_ONEフラグで有効にすることができます。

戻る : Previous


Scroll on focus

英文 自動翻訳

Imagine that there a lot of objects in a group that are on a scrollable object.


Pressing the "Tab" button focuses the next object but it might be outside the visible area of the scrollable object.


If the "scroll on focus" feature is enabled LVGL will automatically scroll objects to bring their children into view.


The scrolling happens recursively therefore even nested scrollable objects are handled properly.


The object will be scrolled into view even if it's on a different page of a tabview.

スクロール可能なオブジェクト上にあるグループ内の多くのオブジェクトを想像してください。


Tab "ボタンを押すと次のオブジェクトがフォーカスされますが、それはスクロール可能なオブジェクトの可視領域の外にある可能性があります。


もし、"scroll on focus "機能が有効なら、LVGLは自動的にオブジェクトをスクロールして、その子オブジェクトを表示させるでしょう。


スクロールは再帰的に行われるため、ネストしたスクロール可能なオブジェクトも適切に処理されます。


オブジェクトは、タブビューの別のページにある場合でも、視界に入るようにスクロールされます。

戻る : Previous


Scroll manually

英文 自動翻訳

The following API functions allow manual scrolling of objects:

  • lv_obj_scroll_by(obj, x, y, LV_ANIM_ON/OFF) scroll by x and y values
  • lv_obj_scroll_to(obj, x, y, LV_ANIM_ON/OFF) scroll to bring the given coordinate to the top left corner
  • lv_obj_scroll_to_x(obj, x, LV_ANIM_ON/OFF) scroll to bring the given coordinate to the left side
  • lv_obj_scroll_to_y(obj, y, LV_ANIM_ON/OFF) scroll to bring the given coordinate to the top side
 以下の API 関数により、オブジェクトを手動でスクロールさせることができる。
  • lv_obj_scroll_by(obj, x, y, LV_ANIM_ON/OFF) ：x と y の値でスクロールする．
  • lv_obj_scroll_to(obj, x, y, LV_ANIM_ON/OFF) ：与えられた座標を左上隅に移動するようにスクロールする．
  • lv_obj_scroll_to_x(obj, x, LV_ANIM_ON/OFF) ：与えられた座標を左側に持ってくるようにスクロールします．
  • lv_obj_scroll_to_y(obj, y, LV_ANIM_ON/OFF) ：与えられた座標を上側に持ってくるようにスクロールさせます．
戻る : Previous


Self size

英文 自動翻訳

Self size is a property of an object. Normally, the user shouldn't use this parameter but if a custom widget is created it might be useful.


In short, self size establishes the size of an object's content.


To understand it better take the example of a table.

Let's say it has 10 rows each with 50 px height.

So the total height of the content is 500 px.

In other words the "self height" is 500 px.


If the user sets only 200 px height for the table LVGL will see that the self size is larger and make the table scrollable.

This means not only the children can make an object scrollable but a larger self size will too.


LVGL uses the LV_EVENT_GET_SELF_SIZE event to get the self size of an object.


Here is an example to see how to handle the event: 

 if(event_code == LV_EVENT_GET_SELF_SIZE) {
 	lv_point_t * p = lv_event_get_param(e);
   
   //If x or y < 0 then it doesn't neesd to be calculated now
   if(p->x >= 0) {
     p->x = 200;	//Set or calculate the self width
   }
   
   if(p->y >= 0) {
     p->y = 50;	//Set or calculate the self height
   }
 }
Self size は、オブジェクトのプロパティです。通常、ユーザーはこのパラメータを使うべきではありませんが、カスタムウィジェットが作成された場合、役に立つかもしれません。


簡単に言うと、セルフサイズは、オブジェクトのコンテンツの大きさを設定します。


これをよりよく理解するために、テーブルを例にとって考えてみましょう。

例えば、高さ50pxの10行のテーブルがあるとします。

つまり、コンテンツの高さは合計で500pxとなる。

言い換えれば、「自分の高さ」は500pxです。


もしユーザーがテーブルに200pxの高さしか設定しなかった場合、LVGLは自己のサイズの方が大きいと判断して、テーブルをスクロール可能にする。

つまり、子オブジェクトだけでなく、自己サイズが大きければ、オブジェクトをスクロール可能にすることができるのです。


LVGLは、LV_EVENT_GET_SELF_SIZE イベントを使って、オブジェクトのセルフ・サイズを取得します。


ここでは、このイベントをどのように扱うかの例を示します。 

 if(event_code == LV_EVENT_GET_SELF_SIZE) {
 	lv_point_t * p = lv_event_get_param(e);
   
   //If x or y < 0 then it doesn't neesd to be calculated now
   if(p->x >= 0) {
     p->x = 200;	//Set or calculate the self width
   }
   
   if(p->y >= 0) {
     p->y = 50;	//Set or calculate the self height
   }
 }
戻る : Previous


Examples

英文 自動翻訳

Nested scrolling

LVGL docs example 036.png

Snapping

LVGL docs example 037.png

Floating button

LVGL docs example 038.png

Styling the scrollbars

LVGL docs example 039.png

Right to left scrolling

LVGL docs example 040.png

Translate on scroll

LVGL docs example 041.png


戻る : Previous

「https://robot-jp.com/wiki/index.php?title=App:Library:LVGL:docs:Overview:Scroll&oldid=5227」から取得