stefan pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=d603ea1de02e79ed397901a97bf745855e07b599
commit d603ea1de02e79ed397901a97bf745855e07b599 Author: Stefan Schmidt <[email protected]> Date: Thu Nov 17 12:52:44 2016 +0100 docs: efl_ui: fill gaps in efl_ui eo file documentation --- src/lib/elementary/efl_ui_box.eo | 1 + src/lib/elementary/efl_ui_box_flow.eo | 2 ++ src/lib/elementary/efl_ui_clock.eo | 1 - src/lib/elementary/efl_ui_flip.eo | 1 + src/lib/elementary/efl_ui_flip_internal_part.eo | 3 ++- src/lib/elementary/efl_ui_frame.eo | 3 --- src/lib/elementary/efl_ui_grid.eo | 1 + src/lib/elementary/efl_ui_grid_static.eo | 1 + src/lib/elementary/efl_ui_image.eo | 8 ++++---- src/lib/elementary/efl_ui_layout_internal_box.eo | 5 +++-- src/lib/elementary/efl_ui_layout_internal_table.eo | 5 +++-- src/lib/elementary/efl_ui_nstate.eo | 15 ++++++--------- src/lib/elementary/efl_ui_text.eo | 4 ++-- src/lib/elementary/efl_ui_text_editable.eo | 1 + src/lib/elementary/efl_ui_text_interactive.eo | 4 ++-- src/lib/elementary/efl_ui_video.eo | 7 ++++--- src/lib/elementary/efl_ui_win.eo | 4 +--- src/lib/elementary/efl_ui_win_standard.eo | 1 + 18 files changed, 35 insertions(+), 32 deletions(-) diff --git a/src/lib/elementary/efl_ui_box.eo b/src/lib/elementary/efl_ui_box.eo index 74476a7..fb04ca2 100644 --- a/src/lib/elementary/efl_ui_box.eo +++ b/src/lib/elementary/efl_ui_box.eo @@ -1,6 +1,7 @@ class Efl.Ui.Box (Elm.Widget, Efl.Pack.Linear, Efl.Pack.Layout, Efl.Orientation) { + [[Efl UI box class]] implements { Efl.Object.constructor; Efl.Canvas.Group.group_add; diff --git a/src/lib/elementary/efl_ui_box_flow.eo b/src/lib/elementary/efl_ui_box_flow.eo index 7ea9f43..011c24e 100644 --- a/src/lib/elementary/efl_ui_box_flow.eo +++ b/src/lib/elementary/efl_ui_box_flow.eo @@ -9,6 +9,7 @@ class Efl.Ui.Box.Flow (Efl.Ui.Box, Efl.Pack.Layout) [[A custom layout engine for @Efl.Ui.Box.]] methods { @property box_flow_homogenous { + [[Box flow homogenous property]] set {} get {} values { @@ -16,6 +17,7 @@ class Efl.Ui.Box.Flow (Efl.Ui.Box, Efl.Pack.Layout) } } @property box_flow_max_size { + [[Box flow maximum size property]] set {} get {} values { diff --git a/src/lib/elementary/efl_ui_clock.eo b/src/lib/elementary/efl_ui_clock.eo index 54dd8b6..ed7d609 100644 --- a/src/lib/elementary/efl_ui_clock.eo +++ b/src/lib/elementary/efl_ui_clock.eo @@ -257,5 +257,4 @@ class Efl.Ui.Clock (Elm.Layout) events { changed; [[Called when clock changed]] } - } diff --git a/src/lib/elementary/efl_ui_flip.eo b/src/lib/elementary/efl_ui_flip.eo index 78f9aca..c035081 100644 --- a/src/lib/elementary/efl_ui_flip.eo +++ b/src/lib/elementary/efl_ui_flip.eo @@ -28,6 +28,7 @@ enum Efl.Ui.Flip.Interaction class Efl.Ui.Flip (Elm.Widget, Efl.Pack.Linear, Efl.Part) { + [[Efl UI flip class]] legacy_prefix: elm_flip; methods { @property interaction { diff --git a/src/lib/elementary/efl_ui_flip_internal_part.eo b/src/lib/elementary/efl_ui_flip_internal_part.eo index 1e0373e..78e41a2 100644 --- a/src/lib/elementary/efl_ui_flip_internal_part.eo +++ b/src/lib/elementary/efl_ui_flip_internal_part.eo @@ -1,5 +1,6 @@ class Efl.Ui.Flip.Internal.Part (Efl.Object, Efl.Container) { + [[Efl UI flip internal class]] data: Elm_Part_Data; implements { Efl.Object.destructor; @@ -7,4 +8,4 @@ class Efl.Ui.Flip.Internal.Part (Efl.Object, Efl.Container) Efl.Container.content.get; Efl.Container.content_unset; } -} \ No newline at end of file +} diff --git a/src/lib/elementary/efl_ui_frame.eo b/src/lib/elementary/efl_ui_frame.eo index 9b8ee09..af717c1 100644 --- a/src/lib/elementary/efl_ui_frame.eo +++ b/src/lib/elementary/efl_ui_frame.eo @@ -64,7 +64,4 @@ class Efl.Ui.Frame (Elm.Layout, Efl.Ui.Clickable) Elm.Layout.text_aliases.get; Elm.Layout.content_aliases.get; } - events { - } - } diff --git a/src/lib/elementary/efl_ui_grid.eo b/src/lib/elementary/efl_ui_grid.eo index 25dd207..0840495 100644 --- a/src/lib/elementary/efl_ui_grid.eo +++ b/src/lib/elementary/efl_ui_grid.eo @@ -1,6 +1,7 @@ class Efl.Ui.Grid (Elm.Widget, Efl.Pack.Grid, Efl.Pack.Layout, Efl.Orientation) { + [[Efl UI grid class]] implements { Efl.Object.constructor; Efl.Canvas.Group.group_add; diff --git a/src/lib/elementary/efl_ui_grid_static.eo b/src/lib/elementary/efl_ui_grid_static.eo index e2fdd7e..6b5dff7 100644 --- a/src/lib/elementary/efl_ui_grid_static.eo +++ b/src/lib/elementary/efl_ui_grid_static.eo @@ -1,5 +1,6 @@ class Efl.Ui.Grid.Static (Efl.Ui.Grid) { + [[Efl UI grid static class]] data: null; implements { Efl.Object.constructor; diff --git a/src/lib/elementary/efl_ui_image.eo b/src/lib/elementary/efl_ui_image.eo index ac52194..3321331 100644 --- a/src/lib/elementary/efl_ui_image.eo +++ b/src/lib/elementary/efl_ui_image.eo @@ -47,6 +47,7 @@ class Efl.Ui.Image (Elm.Widget, Efl.Ui.Clickable, Efl.Ui.Draggable, Elm.Interface.Atspi_Image, Elm.Interface.Atspi_Widget_Action, Edje.Object, Efl.Orientation, Efl.Flipable) { + [[ Efl UI image class]] event_prefix: efl_ui_image; methods { @property scale_type { @@ -54,7 +55,7 @@ class Efl.Ui.Image (Elm.Widget, Efl.Ui.Clickable, Efl.Ui.Draggable, @since 1.18]] values { - scale_type: Efl.Ui.Image.Scale_Type; + scale_type: Efl.Ui.Image.Scale_Type; [[Image scale type]] } } @property scalable { @@ -102,7 +103,7 @@ class Efl.Ui.Image (Elm.Widget, Efl.Ui.Clickable, Efl.Ui.Draggable, See also @.icon.get. ]] - return: bool; [[true on success, false on error]] + return: bool; [[$true on success, $false on error]] } get { [[Get the icon name of image set by icon standard names. @@ -155,7 +156,6 @@ class Efl.Ui.Image (Elm.Widget, Efl.Ui.Clickable, Efl.Ui.Draggable, Elm.Interface.Atspi_Widget_Action.elm_actions.get; } events { - drop; /* FIXME - Belongs to DnD interface */ + drop; [[Called when drop from drag and drop happened]] /* FIXME - Belongs to DnD interface */ } - } diff --git a/src/lib/elementary/efl_ui_layout_internal_box.eo b/src/lib/elementary/efl_ui_layout_internal_box.eo index a83f695..b73d6b1 100644 --- a/src/lib/elementary/efl_ui_layout_internal_box.eo +++ b/src/lib/elementary/efl_ui_layout_internal_box.eo @@ -9,10 +9,11 @@ class Efl.Ui.Layout_Internal.Box (Efl.Object, Efl.Pack.Linear, data: Efl_Ui_Layout_Table_Data; methods { @property real_part @protected { + [[Real part property]] set {} values { - layout: Efl.Object; - part: string; + layout: Efl.Object; [[Real part object]] + part: string; [[Real part name]] } } } diff --git a/src/lib/elementary/efl_ui_layout_internal_table.eo b/src/lib/elementary/efl_ui_layout_internal_table.eo index df2ebf8..7883975 100644 --- a/src/lib/elementary/efl_ui_layout_internal_table.eo +++ b/src/lib/elementary/efl_ui_layout_internal_table.eo @@ -8,10 +8,11 @@ class Efl.Ui.Layout_Internal.Table (Efl.Object, Efl.Pack.Grid) data: Efl_Ui_Layout_Table_Data; methods { @property real_part @protected { + [[Real part property]] set {} values { - layout: Efl.Object; - part: string; + layout: Efl.Object; [[Real part object]] + part: string; [[Real part name]] } } } diff --git a/src/lib/elementary/efl_ui_nstate.eo b/src/lib/elementary/efl_ui_nstate.eo index ceb2940..c830072 100644 --- a/src/lib/elementary/efl_ui_nstate.eo +++ b/src/lib/elementary/efl_ui_nstate.eo @@ -1,16 +1,15 @@ class Efl.Ui.Nstate(Elm.Button) { + [[Efl UI nstate class]] methods { activate @protected { + [[Activate widget]] } @property count { + [[Maximum number of states]] set { - [[Set the maximum number of states. - ]] } get { - [[Get the max number of states. - ]] } values { nstate: int; [[The number of states.]] @@ -18,12 +17,10 @@ class Efl.Ui.Nstate(Elm.Button) } @property value { set { - [[Set the particular state given in (0...nstate}. - ]] + [[Set the particular state given in (0...nstate}.]] } get { - [[Get the state value. - ]] + [[Get the state value.]] } values { state: int; [[The state.]] @@ -39,6 +36,6 @@ class Efl.Ui.Nstate(Elm.Button) Elm.Widget.event; } events { - state,changed; + state,changed; [[Called when nstate widget changed]] } } diff --git a/src/lib/elementary/efl_ui_text.eo b/src/lib/elementary/efl_ui_text.eo index 0c92144..97660fd 100644 --- a/src/lib/elementary/efl_ui_text.eo +++ b/src/lib/elementary/efl_ui_text.eo @@ -55,6 +55,7 @@ class Efl.Ui.Text (Elm.Layout, Elm.Interface_Scrollable, Efl.Ui.Clickable, Elm.Interface.Atspi.Text, Elm.Interface.Atspi.Text.Editable, Efl.File, Efl.Ui.Selectable, Efl.Ui.Scrollable, Efl.Ui.Text.Interactive) { + [[Efl UI text class]] methods { @property scrollable { set { @@ -476,7 +477,7 @@ class Efl.Ui.Text (Elm.Layout, Elm.Interface_Scrollable, Efl.Ui.Clickable, events { activated; changed; - changed,user; + changed,user; [[Called when object changed due to user interaction]] validate; context,open; anchor,clicked; @@ -496,5 +497,4 @@ class Efl.Ui.Text (Elm.Layout, Elm.Interface_Scrollable, Efl.Ui.Clickable, cursor,changed; cursor,changed,manual; } - } diff --git a/src/lib/elementary/efl_ui_text_editable.eo b/src/lib/elementary/efl_ui_text_editable.eo index e801b1b..0092aee 100644 --- a/src/lib/elementary/efl_ui_text_editable.eo +++ b/src/lib/elementary/efl_ui_text_editable.eo @@ -1,5 +1,6 @@ class Efl.Ui.Text.Editable (Efl.Ui.Text) { + [[Efl UI text editable class]] data: null; implements { Efl.Object.constructor; diff --git a/src/lib/elementary/efl_ui_text_interactive.eo b/src/lib/elementary/efl_ui_text_interactive.eo index 96fd66b..19873e4 100644 --- a/src/lib/elementary/efl_ui_text_interactive.eo +++ b/src/lib/elementary/efl_ui_text_interactive.eo @@ -19,7 +19,7 @@ interface Efl.Ui.Text.Interactive () set {} get {} values { - allowed: bool; [[$true if enabled]] + allowed: bool; [[$true if enabled, $false otherwise]] } } @property selection_cursors { @@ -42,7 +42,7 @@ interface Efl.Ui.Text.Interactive () set {} get {} values { - enabled: bool; [[$true if enabled]] + enabled: bool; [[$true if enabled, $false otherwise]] } } @property editable { diff --git a/src/lib/elementary/efl_ui_video.eo b/src/lib/elementary/efl_ui_video.eo index d0ffab4..78ec70d 100644 --- a/src/lib/elementary/efl_ui_video.eo +++ b/src/lib/elementary/efl_ui_video.eo @@ -1,6 +1,7 @@ class Efl.Ui.Video (Elm.Layout, Efl.File, Efl.Player, Elm.Interface.Atspi_Widget_Action) { + [[Efl UI video class]] legacy_prefix: elm_video; methods { @property remember_position { @@ -19,7 +20,7 @@ class Efl.Ui.Video (Elm.Layout, Efl.File, ]] } values { - remember: bool; [[The value.]] + remember: bool; [[$true when the object can remember the last position, $false otherwise]] } } @property is_playing { @@ -29,13 +30,13 @@ class Efl.Ui.Video (Elm.Layout, Efl.File, You should consider watching event on the object instead of polling the object state. ]] - return: bool; + return: bool; [[$true if the video is playing, $false otherwise]] } } @property emotion { get { [[Get the underlying Emotion object.]] - return: Efl.Canvas.Object; [[the underlying Emotion object.]] + return: Efl.Canvas.Object; [[The underlying Emotion object.]] } } @property title { diff --git a/src/lib/elementary/efl_ui_win.eo b/src/lib/elementary/efl_ui_win.eo index d7f12d6..727422d 100644 --- a/src/lib/elementary/efl_ui_win.eo +++ b/src/lib/elementary/efl_ui_win.eo @@ -1,4 +1,3 @@ - enum Efl.Ui.Win.Type { [[Defines the types of window that can be created @@ -104,8 +103,6 @@ enum Efl.Ui.Win.Indicator_Type If user flicks the upper side of window, the incator is shown temporarily.]] } -/** - */ enum Efl.Ui.Win.Keygrab_Mode { [[Define the keygrab modes of window. A window may send commands to the @@ -148,6 +145,7 @@ class Efl.Ui.Win (Elm.Widget, Efl.Canvas, Elm.Interface.Atspi.Window, Efl.Input.State, Efl.Input.Interface, Efl.Screen, Efl.Gfx.Size.Hint, Efl.Text, Efl.Config.Global) { + [[Efl UI window class]] legacy_prefix: elm_win; eo_prefix: efl_ui_win; event_prefix: efl_ui_win; diff --git a/src/lib/elementary/efl_ui_win_standard.eo b/src/lib/elementary/efl_ui_win_standard.eo index 916c5fb..ef4d790 100644 --- a/src/lib/elementary/efl_ui_win_standard.eo +++ b/src/lib/elementary/efl_ui_win_standard.eo @@ -1,5 +1,6 @@ class Efl.Ui.Win.Standard (Efl.Ui.Win) { + [[Efl UI standard window class]] data: null; implements { Efl.Object.finalize; --
