summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Blumenkrantz <zmike@samsung.com>2020-03-13 12:16:57 -0400
committerMike Blumenkrantz <zmike@samsung.com>2020-03-13 12:17:22 -0400
commit57d6d9bfcedfb45932d8b34a4383257cf6346fcf (patch)
tree67e3d1bba71ec4d79ea0e599b22b9925b08dc621
parentaf96a44ef7af66f9b8e969a211bfee1e42fa03a3 (diff)
efl/wl: add docs for surface object and re-namespace
Summary: Depends on D11501 Reviewers: segfaultxavi Reviewed By: segfaultxavi Subscribers: cedric, #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D11504
-rw-r--r--src/lib/efl_canvas_wl/efl_canvas_wl.eo14
-rw-r--r--src/lib/efl_canvas_wl/efl_canvas_wl_surface.eo46
2 files changed, 47 insertions, 13 deletions
diff --git a/src/lib/efl_canvas_wl/efl_canvas_wl.eo b/src/lib/efl_canvas_wl/efl_canvas_wl.eo
index 4b0e4fa353..4481ef4f12 100644
--- a/src/lib/efl_canvas_wl/efl_canvas_wl.eo
+++ b/src/lib/efl_canvas_wl/efl_canvas_wl.eo
@@ -26,7 +26,7 @@ class @beta Efl.Canvas.Wl extends Efl.Canvas.Group
26 [[A multiseat xdg-shell compliant Wayland compositor which runs in a canvas object. 26 [[A multiseat xdg-shell compliant Wayland compositor which runs in a canvas object.
27 27
28 All toplevel windows will be sized to the size of the compositor object unless extracted with 28 All toplevel windows will be sized to the size of the compositor object unless extracted with
29 @Efl.Canvas.Wl.Surface.extract. 29 @Efl.Canvas.Wl_Surface.extract.
30 30
31 Only clients executed with @Efl.Canvas.Wl.run or added with @.allowed_pid_add will 31 Only clients executed with @Efl.Canvas.Wl.run or added with @.allowed_pid_add will
32 be permitted to connect to this compositor. 32 be permitted to connect to this compositor.
@@ -82,11 +82,11 @@ class @beta Efl.Canvas.Wl extends Efl.Canvas.Group
82 } 82 }
83 surface_next { 83 surface_next {
84 [[Activate and raise the bottom-most toplevel surface.]] 84 [[Activate and raise the bottom-most toplevel surface.]]
85 return: Efl.Canvas.Wl.Surface; [[The surface that was activated, or $NULL if no change was made.]] 85 return: Efl.Canvas.Wl_Surface; [[The surface that was activated, or $NULL if no change was made.]]
86 } 86 }
87 surface_prev { 87 surface_prev {
88 [[Activate and raise the second top-most toplevel surface.]] 88 [[Activate and raise the second top-most toplevel surface.]]
89 return: Efl.Canvas.Wl.Surface; [[The surface that was activated, or $NULL if no change was made.]] 89 return: Efl.Canvas.Wl_Surface; [[The surface that was activated, or $NULL if no change was made.]]
90 } 90 }
91 @property active_surface { 91 @property active_surface {
92 [[This is the currently activated surface in the compositor widget. 92 [[This is the currently activated surface in the compositor widget.
@@ -97,7 +97,7 @@ class @beta Efl.Canvas.Wl extends Efl.Canvas.Group
97 return: bool; [[Returns $true if a change was successfully made.]] 97 return: bool; [[Returns $true if a change was successfully made.]]
98 } 98 }
99 values { 99 values {
100 surface: Efl.Canvas.Wl.Surface; [[The activated surface.]] 100 surface: Efl.Canvas.Wl_Surface; [[The activated surface.]]
101 } 101 }
102 } 102 }
103 @property aspect_propagate { 103 @property aspect_propagate {
@@ -175,9 +175,9 @@ class @beta Efl.Canvas.Wl extends Efl.Canvas.Group
175 Efl.Gfx.Entity.scale { get; set; } 175 Efl.Gfx.Entity.scale { get; set; }
176 } 176 }
177 events { 177 events {
178 toplevel,added: Efl.Canvas.Wl.Surface; [[Contains the toplevel surface which was added.]] 178 toplevel,added: Efl.Canvas.Wl_Surface; [[Contains the toplevel surface which was added.]]
179 child,added: Efl.Canvas.Wl.Surface; [[Contains the toplevel child surface which was added.]] 179 child,added: Efl.Canvas.Wl_Surface; [[Contains the toplevel child surface which was added.]]
180 popup,added: Efl.Canvas.Wl.Surface; [[Contains the popup surface which was added.]] 180 popup,added: Efl.Canvas.Wl_Surface; [[Contains the popup surface which was added.]]
181 seat,added: Efl.Input.Device; [[Contains the seat object that was added.]] 181 seat,added: Efl.Input.Device; [[Contains the seat object that was added.]]
182 } 182 }
183} 183}
diff --git a/src/lib/efl_canvas_wl/efl_canvas_wl_surface.eo b/src/lib/efl_canvas_wl/efl_canvas_wl_surface.eo
index f2a351becc..d2646f8431 100644
--- a/src/lib/efl_canvas_wl/efl_canvas_wl_surface.eo
+++ b/src/lib/efl_canvas_wl/efl_canvas_wl_surface.eo
@@ -1,27 +1,61 @@
1class @beta Efl.Canvas.Wl.Surface extends Efl.Canvas.Group 1class @beta Efl.Canvas.Wl_Surface extends Efl.Canvas.Group
2{ 2{
3 [[@since 1.24]] 3 [[A canvas object representing a Wayland toplevel or popup surface.
4
5 This object's geometry properties reflect the properties of the underlying surface. If
6 the client is using a protocol to export its size hints, those hints will be directly
7 applied to this object any time they change in the application.
8
9 Changes to geometry and visibility of this object must not be made while @.extracted
10 is $false.
11
12 Changes to size of this object will be immediately propagated to the underlying application.
13
14 Hiding this object will have differing effects based on the surface's xdg-shell role.
15 If the surface is a popup, it will be sent the 'done' protocol event which will close it.
16 If the surface is a toplevel, it will be deactivated if it was active.
17
18 This object's lifetime is bound to the lifetime of the underlying surface or the compositor widget.
19
20 This object must not be manually deleted.
21 @since 1.24
22 ]]
4 data: Comp_Surface; 23 data: Comp_Surface;
5 methods { 24 methods {
6 extract { 25 extract {
7 return: bool; 26 [[Extract a surface from the compositor widget.
27
28 Call this prior to making any calls which directly modify the geometry of
29 the surface. Once extracted, the compositor will no longer attempt to automatically
30 apply geometry or stacking changes to the surface.
31
32 Once extracted, a surface cannot be un-extracted.
33 ]]
34 return: bool; [[Returns $true if the surface was successfully extracted.]]
8 } 35 }
9 @property pid { 36 @property pid {
37 [[The process id of the surface's application.]]
10 get {} 38 get {}
11 values { 39 values {
12 pid: int; 40 pid: int; [[The process id, or -1 if the surface has been asynchronously destroyed.]]
13 } 41 }
14 } 42 }
15 @property parent_surface { 43 @property parent_surface {
44 [[The parent surface of the given surface. This value is $NULL for toplevel surfaces without a parent.
45
46 For popup surfaces, this may be another popup or a toplevel.
47 For toplevel surfaces, this will always be another toplevel or $NULL.
48 ]]
16 get {} 49 get {}
17 values { 50 values {
18 parent: Efl.Canvas.Wl.Surface; 51 parent: Efl.Canvas.Wl_Surface; [[The parent surface. $NULL if no parent exists or the surface was asynchronously destroyed.]]
19 } 52 }
20 } 53 }
21 @property extracted { 54 @property extracted {
55 [[The extracted state of the surface.]]
22 get {} 56 get {}
23 values { 57 values {
24 extracted: bool; 58 extracted: bool; [[$true if @.extract was successfully called previously.]]
25 } 59 }
26 } 60 }
27 } 61 }