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

docs: elm_layout: fill gaps in elm_labl eo file documentation

This commit is contained in:
Stefan Schmidt 2016-11-21 17:54:12 +01:00
parent 243eb40d88
commit 22eb105499
2 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/lib/elementary/elm_layout.eo
View File

@ -19,6 +19,7 @@ struct Elm.Layout_Part_Alias_Description
class Elm.Layout (Elm.Widget, Efl.Part, Efl.Container, Efl.File) class Elm.Layout (Elm.Widget, Efl.Part, Efl.Container, Efl.File)
{ {
[[Elementary layout class]]
legacy_prefix: elm_layout; legacy_prefix: elm_layout;
eo_prefix: elm_obj_layout; eo_prefix: elm_obj_layout;
event_prefix: elm_layout; event_prefix: elm_layout;
@ -55,7 +56,7 @@ class Elm.Layout (Elm.Widget, Efl.Part, Efl.Container, Efl.File)
Note that $style will be the new style of $obj too, as in an Note that $style will be the new style of $obj too, as in an
\@ref elm_object_style_set call. \@ref elm_object_style_set call.
]] ]]
return: bool; return: bool; [[$true on success, $false otherwise]]
} }
values { values {
klass: string; [[The class of the group.]] klass: string; [[The class of the group.]]
@ -64,19 +65,21 @@ class Elm.Layout (Elm.Widget, Efl.Part, Efl.Container, Efl.File)
} }
} }
@property text_aliases @protected { @property text_aliases @protected {
[[Text aliases property]]
get { get {
legacy: null; legacy: null;
} }
values { values {
aliases: ptr(const(Elm.Layout_Part_Alias_Description)); aliases: ptr(const(Elm.Layout_Part_Alias_Description)); [[Text aliases]]
} }
} }
@property content_aliases @protected { @property content_aliases @protected {
[[Content aliases property]]
get { get {
legacy: null; legacy: null;
} }
values { values {
aliases: ptr(const(Elm.Layout_Part_Alias_Description)); aliases: ptr(const(Elm.Layout_Part_Alias_Description)); [[Content aliases]]
} }
} }
@property edje { @property edje {
@ -134,8 +137,9 @@ class Elm.Layout (Elm.Widget, Efl.Part, Efl.Container, Efl.File)
return: int; [[The frozen state or 0 on error.]] return: int; [[The frozen state or 0 on error.]]
} }
theme_enable { theme_enable {
[[Enable theme]]
legacy: null; legacy: null;
return: bool; return: bool; [[$true on success, $false otherwise]]
} }
sizing_eval { sizing_eval {
[[Eval sizing. [[Eval sizing.
@ -174,7 +178,7 @@ class Elm.Layout (Elm.Widget, Efl.Part, Efl.Container, Efl.File)
} }
part_cursor_style_set { part_cursor_style_set {
[[Sets a specific cursor style for an edje part.]] [[Sets a specific cursor style for an edje part.]]
return: bool; [[True on success or false on failure, that may be return: bool; [[$true on success or $false on failure, that may be
part not exists or it did not had a cursor set.]] part not exists or it did not had a cursor set.]]
params { params {
@in part_name: string; [[A part from loaded edje group.]] @in part_name: string; [[A part from loaded edje group.]]
@ -194,7 +198,7 @@ class Elm.Layout (Elm.Widget, Efl.Part, Efl.Container, Efl.File)
@property text { @property text {
set { set {
[[Set the text of the given part.]] [[Set the text of the given part.]]
return: bool; return: bool; [[$true on success, $false otherwise]]
} }
get { get {
[[Get the text set in the given part.]] [[Get the text set in the given part.]]
@ -234,14 +238,15 @@ class Elm.Layout (Elm.Widget, Efl.Part, Efl.Container, Efl.File)
} }
part_cursor_get @const { part_cursor_get @const {
[[Get the cursor to be shown when mouse is over an edje part.]] [[Get the cursor to be shown when mouse is over an edje part.]]
return: string; return: string; [[Cursor name]]
params { params {
@in part_name: string; [[A part from loaded edje group.]] @in part_name: string; [[A part from loaded edje group.]]
} }
} }
sub_object_add_enable { sub_object_add_enable {
[[Enable sub object add]]
legacy: null; legacy: null;
return: bool; return: bool; [[$true on success, $false otherwise]]
} }
data_get @const { data_get @const {
[[Get the edje data from the given layout. [[Get the edje data from the given layout.
@ -317,7 +322,7 @@ class Elm.Layout (Elm.Widget, Efl.Part, Efl.Container, Efl.File)
} }
part_cursor_unset { part_cursor_unset {
[[Unsets a cursor previously set with @.part_cursor_set.]] [[Unsets a cursor previously set with @.part_cursor_set.]]
return: bool; return: bool; [[$true on success, $false otherwise]]
params { params {
@in part_name: string; [[A part from loaded edje group, @in part_name: string; [[A part from loaded edje group,
that had a cursor set wit that had a cursor set wit
@ -355,7 +360,6 @@ class Elm.Layout (Elm.Widget, Efl.Part, Efl.Container, Efl.File)
Efl.Part.part; Efl.Part.part;
} }
events { events {
theme,changed; theme,changed; [[Called when theme changed]]
} }
} }

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

@ -1,5 +1,6 @@
class Elm.Layout.Internal.Part (Efl.Object, Efl.Container) class Elm.Layout.Internal.Part (Efl.Object, Efl.Container)
{ {
[[Elementary layout internal part class]]
data: Elm_Part_Data; data: Elm_Part_Data;
implements { implements {
Efl.Object.destructor; Efl.Object.destructor;