kimcinoo
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: efl_ui: fill gaps in efl_ui eo file documentation

This commit is contained in:
Stefan Schmidt 2016-11-17 12:52:44 +01:00
parent 67f03b7d04
commit d603ea1de0
18 changed files with 35 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/lib/elementary/efl_ui_box.eo
View File

@ -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;

2
src/lib/elementary/efl_ui_box_flow.eo
View File

@ -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 {

1
src/lib/elementary/efl_ui_clock.eo
View File

@ -257,5 +257,4 @@ class Efl.Ui.Clock (Elm.Layout)
events {
changed; [[Called when clock changed]]
}
}

1
src/lib/elementary/efl_ui_flip.eo
View File

@ -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 {

3
src/lib/elementary/efl_ui_flip_internal_part.eo
View File

@ -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;
}
}
}

3
src/lib/elementary/efl_ui_frame.eo
View File

@ -64,7 +64,4 @@ class Efl.Ui.Frame (Elm.Layout, Efl.Ui.Clickable)
Elm.Layout.text_aliases.get;
Elm.Layout.content_aliases.get;
}
events {
}
}

1
src/lib/elementary/efl_ui_grid.eo
View File

@ -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;

1
src/lib/elementary/efl_ui_grid_static.eo
View File

@ -1,5 +1,6 @@
class Efl.Ui.Grid.Static (Efl.Ui.Grid)
{
[[Efl UI grid static class]]
data: null;
implements {
Efl.Object.constructor;

8
src/lib/elementary/efl_ui_image.eo
View File

@ -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 */
}
}

5
src/lib/elementary/efl_ui_layout_internal_box.eo
View File

@ -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]]
}
}
}

5
src/lib/elementary/efl_ui_layout_internal_table.eo
View File

@ -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]]
}
}
}

15
src/lib/elementary/efl_ui_nstate.eo
View File

@ -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]]
}
}

4
src/lib/elementary/efl_ui_text.eo
View File

@ -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;
}
}

1
src/lib/elementary/efl_ui_text_editable.eo
View File

@ -1,5 +1,6 @@
class Efl.Ui.Text.Editable (Efl.Ui.Text)
{
[[Efl UI text editable class]]
data: null;
implements {
Efl.Object.constructor;

4
src/lib/elementary/efl_ui_text_interactive.eo
View File

@ -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 {

7
src/lib/elementary/efl_ui_video.eo
View File

@ -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 {

4
src/lib/elementary/efl_ui_win.eo
View File

@ -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;

1
src/lib/elementary/efl_ui_win_standard.eo
View File

@ -1,5 +1,6 @@
class Efl.Ui.Win.Standard (Efl.Ui.Win)
{
[[Efl UI standard window class]]
data: null;
implements {
Efl.Object.finalize;