summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Blumenkrantz <zmike@samsung.com>2019-02-15 16:20:58 +0100
committerXavi Artigas <xavierartigas@yahoo.es>2019-02-15 16:24:21 +0100
commit4935202caab9485c0b62006ffece5b85c334773a (patch)
tree84f42ec6262f1a61a4dfe11e3f51e030f75b72ad
parent8eb06f71e487e88d091c855ee3dd2cff1fd9e7fb (diff)
efl.canvas.scene: improve class docs
Summary: these were some pretty efl docs, and I've tried to make them more accessible ref T7584 Reviewers: segfaultxavi Reviewed By: segfaultxavi Subscribers: cedric, #reviewers, #committers Tags: #efl Maniphest Tasks: T7584 Differential Revision: https://phab.enlightenment.org/D7954
-rw-r--r--src/lib/efl/interfaces/efl_canvas_scene.eo64
1 files changed, 33 insertions, 31 deletions
diff --git a/src/lib/efl/interfaces/efl_canvas_scene.eo b/src/lib/efl/interfaces/efl_canvas_scene.eo
index 2133378..07f9d6c 100644
--- a/src/lib/efl/interfaces/efl_canvas_scene.eo
+++ b/src/lib/efl/interfaces/efl_canvas_scene.eo
@@ -3,18 +3,18 @@ import efl_gfx_types;
3 3
4interface @beta Efl.Canvas.Scene 4interface @beta Efl.Canvas.Scene
5{ 5{
6 [[Common interface for window and some internal classes in EFL.]] 6 [[Interface containing basic canvas-related methods and events.]]
7 methods { 7 methods {
8 @property image_max_size { 8 @property image_max_size {
9 get { 9 get {
10 [[Get the maximum image size evas can possibly handle. 10 [[Get the maximum image size the canvas can possibly handle.
11 11
12 This function returns the largest image or surface size that 12 This function returns the largest image or surface size that
13 evas can handle in pixels, and if there is one, returns $true. 13 the canvas can handle in pixels, and if there is one, returns $true.
14 It returns $false if no extra constraint on maximum image 14 It returns $false if no extra constraint on maximum image
15 size exists. You still should check the return values of 15 size exists.
16 $maxw and $maxh as there may still be a limit, just a 16
17 much higher one. 17 The default limit is 65535x65535.
18 18
19 ]] 19 ]]
20 return: bool; [[$true on success, $false otherwise]] 20 return: bool; [[$true on success, $false otherwise]]
@@ -38,17 +38,15 @@ interface @beta Efl.Canvas.Scene
38 } 38 }
39 } 39 }
40 objects_at_xy_get { 40 objects_at_xy_get {
41 [[Retrieve a list of objects lying over a given position in 41 [[Retrieve a list of objects at a given position in a canvas.
42 a canvas.
43 42
44 This function will traverse all the layers of the given canvas, 43 This function will traverse all the layers of the given canvas,
45 from top to bottom, querying for objects with areas covering the 44 from top to bottom, querying for objects with areas covering the
46 given position. The user can remove from query objects which are 45 given position. The user can exclude from the query objects which are
47 hidden and/or which are set to pass events. 46 hidden and/or which are set to pass events.
48 47
49 Warning: This function will skip objects parented by smart 48 Warning: This function will only evaluate top-level objects; child
50 objects, acting only on the ones at the "top level", with 49 or "sub" objects will be skipped.
51 regard to object parenting.
52 ]] 50 ]]
53 return: iterator<Efl.Gfx.Entity> @owned @warn_unused; [[ 51 return: iterator<Efl.Gfx.Entity> @owned @warn_unused; [[
54 The list of objects that are over the given position in $e. 52 The list of objects that are over the given position in $e.
@@ -71,14 +69,13 @@ interface @beta Efl.Canvas.Scene
71 69
72 This function will traverse all the layers of the given canvas, 70 This function will traverse all the layers of the given canvas,
73 from top to bottom, querying for objects with areas covering the 71 from top to bottom, querying for objects with areas covering the
74 given position. The user can remove from the query 72 given position. The user can exclude from the query objects which are
75 objects which are hidden and/or which are set to pass events. 73 hidden and/or which are set to pass events.
76 74
77 Warning: This function will skip objects parented by smart 75 Warning: This function will only evaluate top-level objects; child
78 objects, acting only on the ones at the "top level", with 76 or "sub" objects will be skipped.
79 regard to object parenting.
80 ]] 77 ]]
81 return: Efl.Gfx.Entity @warn_unused; [[The Evas object that is over all other objects at the given position.]] 78 return: Efl.Gfx.Entity @warn_unused; [[The canvas object that is over all other objects at the given position.]]
82 params { 79 params {
83 @in pos: Eina.Position2D; [[The pixel position.]] 80 @in pos: Eina.Position2D; [[The pixel position.]]
84 @in include_pass_events_objects: bool; [[ 81 @in include_pass_events_objects: bool; [[
@@ -92,18 +89,16 @@ interface @beta Efl.Canvas.Scene
92 } 89 }
93 } 90 }
94 objects_in_rectangle_get { 91 objects_in_rectangle_get {
95 [[Retrieve a list of objects lying over a given 92 [[Retrieve a list of objects overlapping a given rectangular region in a canvas.
96 rectangular region in a canvas.
97 93
98 This function will traverse all the layers of the given canvas, 94 This function will traverse all the layers of the given canvas,
99 from top to bottom, querying for objects with areas overlapping 95 from top to bottom, querying for objects with areas overlapping
100 with the given rectangular region inside $e. The user can remove 96 with the given rectangular region. The user can exclude
101 from the query objects which are hidden and/or which are set to 97 from the query objects which are hidden and/or which are set to
102 pass events. 98 pass events.
103 99
104 Warning: This function will skip objects parented by smart 100 Warning: This function will only evaluate top-level objects; child
105 objects, acting only on the ones at the "top level", with 101 or "sub" objects will be skipped.
106 regard to object parenting.
107 ]] 102 ]]
108 return: iterator<Efl.Gfx.Entity> @owned @warn_unused; [[Iterator to objects]] 103 return: iterator<Efl.Gfx.Entity> @owned @warn_unused; [[Iterator to objects]]
109 params { 104 params {
@@ -119,18 +114,17 @@ interface @beta Efl.Canvas.Scene
119 } 114 }
120 } 115 }
121 object_top_in_rectangle_get @const { 116 object_top_in_rectangle_get @const {
122 [[Retrieve the Evas object stacked at the top of a given 117 [[Retrieve the canvas object stacked at the top of a given
123 rectangular region in a canvas 118 rectangular region in a canvas
124 119
125 This function will traverse all the layers of the given canvas, 120 This function will traverse all the layers of the given canvas,
126 from top to bottom, querying for objects with areas overlapping 121 from top to bottom, querying for objects with areas overlapping
127 with the given rectangular region inside $e. The user can remove 122 with the given rectangular region. The user can exclude
128 from the query objects which are hidden and/or which are set to 123 from the query objects which are hidden and/or which are set to
129 pass events. 124 pass events.
130 125
131 Warning: This function will skip objects parented by smart 126 Warning: This function will only evaluate top-level objects; child
132 objects, acting only on the ones at the "top level", with 127 or "sub" objects will be skipped.
133 regard to object parenting.
134 ]] 128 ]]
135 return: Efl.Gfx.Entity @warn_unused; [[ 129 return: Efl.Gfx.Entity @warn_unused; [[
136 The object that is over all other objects at the given 130 The object that is over all other objects at the given
@@ -149,7 +143,11 @@ interface @beta Efl.Canvas.Scene
149 } 143 }
150 } 144 }
151 seats { 145 seats {
152 [[Iterate over the input device seats. 146 [[Iterate over the available input device seats for the canvas.
147
148 A "seat" is the term used for a group of input devices, typically including
149 a pointer and a keyboard. A seat object is the parent of the individual input
150 devices.
153 151
154 @since 1.20 152 @since 1.20
155 ]] 153 ]]
@@ -175,7 +173,11 @@ interface @beta Efl.Canvas.Scene
175 } 173 }
176 } 174 }
177 @property seat { 175 @property seat {
178 [[A seat attached to this canvas, found by id. 176 [[Get a seat attached to this canvas using the seat's id property.
177
178 Seats are associated with an arbitrary integer id. The id is not a
179 persistent value and should never be hardcoded, as it may change between
180 runs of an application depending on the environment.
179 181
180 See also @.device to find a seat by name instead of by id. 182 See also @.device to find a seat by name instead of by id.
181 ]] 183 ]]