summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Blumenkrantz <zmike@samsung.com>2019-09-10 17:08:44 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2019-09-10 17:10:29 +0200
commit6d49eb7cc272492394782d7fa935f8d4b256f55b (patch)
tree9de53c16ad74bae034b581440cdaa7d2dbcf06a1
parent96d8b9bc3e5b14e2a8ad004debffa220ff28e36d (diff)
efl_ui/alert_popup: improve docs
Summary: class and property docs ref T7717 Reviewers: segfaultxavi Reviewed By: segfaultxavi Subscribers: cedric, #reviewers, #committers Tags: #efl_docs Maniphest Tasks: T7717 Differential Revision: https://phab.enlightenment.org/D9883
-rw-r--r--src/lib/elementary/efl_ui_alert_popup.eo29
1 files changed, 22 insertions, 7 deletions
diff --git a/src/lib/elementary/efl_ui_alert_popup.eo b/src/lib/elementary/efl_ui_alert_popup.eo
index 48e6bbae51..253de74cf7 100644
--- a/src/lib/elementary/efl_ui_alert_popup.eo
+++ b/src/lib/elementary/efl_ui_alert_popup.eo
@@ -6,24 +6,39 @@ enum @beta Efl.Ui.Alert_Popup_Button {
6} 6}
7 7
8struct @beta Efl.Ui.Alert_Popup_Button_Clicked_Event { 8struct @beta Efl.Ui.Alert_Popup_Button_Clicked_Event {
9 [[Information of clicked event]] 9 [[Information for @[Efl.Ui.Alert_Popup.button,clicked] event.]]
10 button_type: Efl.Ui.Alert_Popup_Button; [[Clicked button type]] 10 button_type: Efl.Ui.Alert_Popup_Button; [[Clicked button type]]
11} 11}
12 12
13class @beta Efl.Ui.Alert_Popup extends Efl.Ui.Popup 13class @beta Efl.Ui.Alert_Popup extends Efl.Ui.Popup
14{ 14{
15 [[EFL UI Alert Popup class]] 15 [[A variant of @Efl.Ui.Popup which uses a layout containing a content object and
16 a variable number of buttons (up to 3 total).
17
18 An Alert_Popup is a popup which can be used when an application requires user interaction. It provides
19 functionality for easily creating button objects on the popup and passing information about
20 which button has been pressed to the button event callback.
21 ]]
16 methods { 22 methods {
17 @property button { 23 @property button {
24 [[This property changes the text and icon for the specified button object.
25
26 When set, the Alert_Popup will create a button for the specified type if it does not yet
27 exist. The button's content and text will be set using the passed values.
28
29 Exactly one button may exist for each @Efl.Ui.Alert_Popup_Button type. Repeated calls to
30 set values for the same button type will overwrite previous values.
31
32 By default, no buttons are created.
33 ]]
18 set { 34 set {
19 [[Set popup buttons.]]
20 } 35 }
21 keys { 36 keys {
22 type: Efl.Ui.Alert_Popup_Button; [[Alert popup button type]] 37 type: Efl.Ui.Alert_Popup_Button; [[Alert_Popup button type]]
23 } 38 }
24 values { 39 values {
25 text: string; [[Alert string on button]] 40 text: string; [[Text of the specified button type.]]
26 icon: Efl.Object; [[Alert icon on button]] 41 icon: Efl.Canvas.Object; [[Visual to use as an icon for the specified button type.]]
27 } 42 }
28 } 43 }
29 } 44 }
@@ -33,6 +48,6 @@ class @beta Efl.Ui.Alert_Popup extends Efl.Ui.Popup
33 Efl.Part.part_get; 48 Efl.Part.part_get;
34 } 49 }
35 events { 50 events {
36 button,clicked: Efl.Ui.Alert_Popup_Button_Clicked_Event; [[Called when alert popup was clicked]] 51 button,clicked: Efl.Ui.Alert_Popup_Button_Clicked_Event; [[Called when an Alert_Popup button was clicked.]]
37 } 52 }
38} 53}