summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authorMarcel Hollerbach <mail@marcel-hollerbach.de>2019-07-30 12:09:53 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2019-07-31 10:50:14 +0200
commitf00e24de29a26163379fdfb44dcc9dcef84ef1dd (patch)
tree3b7f44142340a016d27992e3230d86a6531d1fab /src/lib
parent14ff010601548d20d9d163e76d6fa62c1ec954ed (diff)
efl_pan: improve docs
Summary: documentation now reflects what is happening in the functions Reviewers: bu5hm4n Reviewed By: bu5hm4n Subscribers: cedric, #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D8863
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/elementary/efl_ui_pan.eo48
1 files changed, 32 insertions, 16 deletions
diff --git a/src/lib/elementary/efl_ui_pan.eo b/src/lib/elementary/efl_ui_pan.eo
index 9923a39463..894fd719ad 100644
--- a/src/lib/elementary/efl_ui_pan.eo
+++ b/src/lib/elementary/efl_ui_pan.eo
@@ -1,39 +1,55 @@
1class @beta Efl.Ui.Pan extends Efl.Canvas.Group implements Efl.Content 1class @beta Efl.Ui.Pan extends Efl.Canvas.Group implements Efl.Content
2{ 2{
3 [[Elementary pan class]] 3 [[Pan widget class.
4
5 This widget positions its contents (set using @Efl.Content.content) relative to the widget itself.
6 This is particularly useful for large content which does not fit inside its container. In this case
7 only a portion is shown.
8
9 The position of this "window" into the content can be changed using @Efl.Ui.Pan.pan_position.
10 This widget does not provide means for a user to change the content's position (like scroll bars).
11 This widget is meant to be used internally by other clases like @Efl.Ui.Scroll.Manager.
12 ]]
4 methods { 13 methods {
5 @property pan_position { 14 @property pan_position {
6 [[Position]] 15 [[Position of the content inside the Pan widget.
7 set { 16
8 } 17 Setting the position to @Efl.Ui.Pan.pan_position_min makes the upper left corner of the content visible.
9 get { 18 Setting the position to @Efl.Ui.Pan.pan_position_max makes the lower right corner of the content visible.
10 } 19 Values outside this range are valid and make the background show.
20 ]]
11 values { 21 values {
12 position: Eina.Position2D; 22 position: Eina.Position2D; [[Content position.]]
13 } 23 }
14 } 24 }
15 @property content_size { 25 @property content_size {
16 [[Content size]] 26 [[Size of the content currently set through @Efl.Content.content.
27 This is a convenience proxy.
28 ]]
17 get { 29 get {
18 } 30 }
19 values { 31 values {
20 size: Eina.Size2D; 32 size: Eina.Size2D; [[The size of the content.]]
21 } 33 }
22 } 34 }
23 @property pan_position_min { 35 @property pan_position_min {
24 [[The minimal position to scroll]] 36 [[Position you can set to @Efl.Ui.Pan.pan_position so that the content's upper left corner is visible.
37 Always (0, 0).
38 ]]
25 get { 39 get {
26 } 40 }
27 values { 41 values {
28 pos: Eina.Position2D; 42 pos: Eina.Position2D; [[Content's upper left corner position.]]
29 } 43 }
30 } 44 }
31 @property pan_position_max { 45 @property pan_position_max {
32 [[The maximal position to scroll]] 46 [[Position you can set to @Efl.Ui.Pan.pan_position so that the content's lower right corner is visible.
47 It depends both on the content's size and this widget's size.
48 ]]
33 get { 49 get {
34 } 50 }
35 values { 51 values {
36 pos: Eina.Position2D; 52 pos: Eina.Position2D; [[Content's lower right corner position.]]
37 } 53 }
38 } 54 }
39 } 55 }
@@ -48,8 +64,8 @@ class @beta Efl.Ui.Pan extends Efl.Canvas.Group implements Efl.Content
48 Efl.Canvas.Group.group_calculate; 64 Efl.Canvas.Group.group_calculate;
49 } 65 }
50 events { 66 events {
51 pan,content,changed: void; [[Called when pan content changed]] 67 pan,content,changed: void; [[The content has changed.]]
52 pan,viewport,changed: void; [[Called when pan viewport changed]] 68 pan,viewport,changed: void; [[This widget's position or size has changed.]]
53 pan,position,changed: void; [[Called when pan position changed]] 69 pan,position,changed: void; [[The content's position has changed.]]
54 } 70 }
55} 71}