summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Blumenkrantz <zmike@samsung.com>2019-09-10 11:21:39 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2019-09-10 11:23:44 +0200
commit0867b51a1ddf6e62d4683f66b445e177c98f7de8 (patch)
treecde56ae93fdaa0f72fab5f0a294b3ff875927d97
parentc10c9b21cc4334ea1ab2344e7060982815066b7c (diff)
efl_ui/popup: improve backwall docs
Summary: ref T7717 Reviewers: segfaultxavi Reviewed By: segfaultxavi Subscribers: cedric, #reviewers, #committers Tags: #efl_docs Maniphest Tasks: T7717 Differential Revision: https://phab.enlightenment.org/D9884
-rw-r--r--src/lib/elementary/efl_ui_popup_part_backwall.eo31
1 files changed, 18 insertions, 13 deletions
diff --git a/src/lib/elementary/efl_ui_popup_part_backwall.eo b/src/lib/elementary/efl_ui_popup_part_backwall.eo
index 8b4eea33bf..7cb01544b9 100644
--- a/src/lib/elementary/efl_ui_popup_part_backwall.eo
+++ b/src/lib/elementary/efl_ui_popup_part_backwall.eo
@@ -1,26 +1,31 @@
1class @beta Efl.Ui.Popup_Part_Backwall extends Efl.Ui.Layout_Part implements Efl.File 1class @beta Efl.Ui.Popup_Part_Backwall extends Efl.Ui.Layout_Part implements Efl.File
2{ 2{
3 [[Efl UI Popup internal part backwall class]] 3 [[A Popup backwall is the background object for an @Efl.Ui.Popup widget. It can be returned
4 from a given Popup widget by using the @Efl.Part API to fetch the "backwall" part.
5
6 This object provides functionality for determining the look and interaction methods
7 of a Popup's background.
8
9 If a Popup should allow input events to reach the objects behind the Popup,
10 @.repeat_events can be enabled.
11
12 To set an image to be used as a background for the Popup, the @Efl.File API can
13 be used directly on the backwall object.
14 ]]
4 data: null; 15 data: null;
5 methods { 16 methods {
6 @property repeat_events { 17 @property repeat_events {
7 set { 18 [[If this property is set to $true, input events will be able to reach objects
8 [[Set whether backwall is to repeat events. 19 below the Popup. This allows for e.g., a click to activate a widget below the Popup
9 20 while the Popup is active.
10 If $repeat is $true, it will make events on $obj to also be 21 ]]
11 repeated for the next lower object in the objects' stack (see
12 @Efl.Gfx.Stack.below).
13 22
14 If $repeat is $false, events occurring on $obj will be 23 set {
15 processed only on it.
16 ]]
17 } 24 }
18 get { 25 get {
19 [[Determine whether backwall is set to repeat events.]]
20 } 26 }
21 values { 27 values {
22 repeat: bool; [[Whether $obj is to repeat events ($true) or 28 repeat: bool; [[Whether to repeat events to objects below the Popup. The default is $false.]]
23 not ($false).]]
24 } 29 }
25 } 30 }
26 } 31 }