docs: elm_interface: fill gaps in elm interfaces eo file documentation
This commit is contained in:
Stefan Schmidt
parent
17cf8dd846
commit
a1b46e872d
|
|
@ -29,6 +29,7 @@ enum Elm.Fileselector.Sort
|
|||
|
||||
interface Elm.Interface.Fileselector ()
|
||||
{
|
||||
[[Elementary fileselector interface]]
|
||||
eo_prefix: elm_interface_fileselector;
|
||||
methods {
|
||||
@property folder_only {
|
||||
|
|
@ -39,7 +40,7 @@ interface Elm.Interface.Fileselector ()
|
|||
[[Get whether folder-only view is set for a given file selector]]
|
||||
}
|
||||
values {
|
||||
only: bool;
|
||||
only: bool; [[$true if folder view is set, $false otherwise]]
|
||||
}
|
||||
}
|
||||
@property thumbnail_size {
|
||||
|
|
@ -50,8 +51,8 @@ interface Elm.Interface.Fileselector ()
|
|||
[[Get the size for the thumbnail of a given file selector widget]]
|
||||
}
|
||||
values {
|
||||
w: Evas.Coord;
|
||||
h: Evas.Coord;
|
||||
w: Evas.Coord; [[Width]]
|
||||
h: Evas.Coord; [[Height]]
|
||||
}
|
||||
}
|
||||
@property hidden_visible {
|
||||
|
|
@ -62,7 +63,8 @@ interface Elm.Interface.Fileselector ()
|
|||
[[Get if hiden files/directories in the file selector are visible or not.]]
|
||||
}
|
||||
values {
|
||||
multi: bool;
|
||||
multi: bool; [[$true if hidden files are visible, $false otherwise]]
|
||||
/* FIXME needs a better value name */
|
||||
}
|
||||
}
|
||||
@property sort_method {
|
||||
|
|
@ -73,7 +75,7 @@ interface Elm.Interface.Fileselector ()
|
|||
[[Get the sort method of the file selector widget.]]
|
||||
}
|
||||
values {
|
||||
sort: Elm.Fileselector.Sort;
|
||||
sort: Elm.Fileselector.Sort; [[Sort method]]
|
||||
}
|
||||
}
|
||||
@property multi_select {
|
||||
|
|
@ -84,7 +86,7 @@ interface Elm.Interface.Fileselector ()
|
|||
[[Gets if multi-selection in fileselector is enabled or disabled.]]
|
||||
}
|
||||
values {
|
||||
multi: bool;
|
||||
multi: bool; [[$true if multiselection is enabled, $false otherwise]]
|
||||
}
|
||||
}
|
||||
@property expandable {
|
||||
|
|
@ -95,7 +97,7 @@ interface Elm.Interface.Fileselector ()
|
|||
[[Get whether tree view is enabled for the given file selector]]
|
||||
}
|
||||
values {
|
||||
expand: bool;
|
||||
expand: bool; [[$true if tree view is expanded, $false otherwise]]
|
||||
}
|
||||
}
|
||||
@property model {
|
||||
|
|
@ -106,7 +108,7 @@ interface Elm.Interface.Fileselector ()
|
|||
[[Get the directory's model that a given file selector selector widget display contents from]]
|
||||
}
|
||||
values {
|
||||
model: Efl.Model;
|
||||
model: Efl.Model; [[Directory model]]
|
||||
}
|
||||
}
|
||||
@property mode {
|
||||
|
|
@ -117,7 +119,7 @@ interface Elm.Interface.Fileselector ()
|
|||
[[Get the mode in which a given file selector widget is displaying]]
|
||||
}
|
||||
values {
|
||||
mode: Elm.Fileselector.Mode;
|
||||
mode: Elm.Fileselector.Mode; [[Fileselector mode]]
|
||||
}
|
||||
}
|
||||
@property is_save {
|
||||
|
|
@ -128,7 +130,7 @@ interface Elm.Interface.Fileselector ()
|
|||
[[Get whether the given file selector is in "saving dialog" mode]]
|
||||
}
|
||||
values {
|
||||
is_save: bool;
|
||||
is_save: bool; [[$true if in saving mode, $false otherwise]]
|
||||
}
|
||||
}
|
||||
@property selected_models {
|
||||
|
|
@ -136,16 +138,17 @@ interface Elm.Interface.Fileselector ()
|
|||
[[Get a list of models selected in the fileselector.]]
|
||||
}
|
||||
values {
|
||||
ret: const(list<Efl.Model>);
|
||||
ret: const(list<Efl.Model>); [[List of selected models]]
|
||||
}
|
||||
}
|
||||
@property current_name {
|
||||
[[ Current name property]]
|
||||
set {
|
||||
}
|
||||
get {
|
||||
}
|
||||
values {
|
||||
name: string;
|
||||
name: string; [[Name]]
|
||||
}
|
||||
}
|
||||
selected_model_set {
|
||||
|
|
@ -157,16 +160,16 @@ interface Elm.Interface.Fileselector ()
|
|||
}
|
||||
selected_model_get {
|
||||
[[Get the currently selected item's model, in the given file the given file selector widget]]
|
||||
return: Efl.Model;
|
||||
return: Efl.Model; [[Selected model]]
|
||||
}
|
||||
custom_filter_append {
|
||||
[[Append custom filter into filter list]]
|
||||
params {
|
||||
@in func: Elm_Fileselector_Filter_Func; [[function]]
|
||||
@in data: void_ptr;
|
||||
@in filter_name: string;
|
||||
@in func: Elm_Fileselector_Filter_Func; [[Filter function]]
|
||||
@in data: void_ptr; [[Data pointer]]
|
||||
@in filter_name: string; [[Filter name]]
|
||||
}
|
||||
return: bool;
|
||||
return: bool; [[$true on success, $false otherwise]]
|
||||
}
|
||||
filters_clear {
|
||||
[[Clear all filters registered]]
|
||||
|
|
@ -174,10 +177,10 @@ interface Elm.Interface.Fileselector ()
|
|||
mime_types_filter_append {
|
||||
[[Append mime type based filter into filter list]]
|
||||
params {
|
||||
@in mime_types: string;
|
||||
@in filter_name: string;
|
||||
@in mime_types: string; [[Mime types]]
|
||||
@in filter_name: string; [[Filter name]]
|
||||
}
|
||||
return: bool;
|
||||
return: bool; [[$true on success, $false otherwise]]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -96,7 +96,7 @@ mixin Elm.Interface_Scrollable(Efl.Ui.Scrollable, Efl.Canvas.Group)
|
|||
get {
|
||||
}
|
||||
values {
|
||||
disabled: bool;
|
||||
disabled: bool; [[$true if wheel is disabled, $false otherwise]]
|
||||
}
|
||||
}
|
||||
@property movement_block {
|
||||
|
|
@ -123,12 +123,13 @@ mixin Elm.Interface_Scrollable(Efl.Ui.Scrollable, Efl.Canvas.Group)
|
|||
}
|
||||
}
|
||||
@property momentum_animator_disabled {
|
||||
[[Momentum animator]]
|
||||
set {
|
||||
}
|
||||
get {
|
||||
}
|
||||
values {
|
||||
disabled: bool;
|
||||
disabled: bool; [[$true if disabled, $false otherwise]]
|
||||
}
|
||||
}
|
||||
@property policy {
|
||||
|
|
@ -177,7 +178,7 @@ mixin Elm.Interface_Scrollable(Efl.Ui.Scrollable, Efl.Canvas.Group)
|
|||
get {
|
||||
}
|
||||
values {
|
||||
repeat_events: bool;
|
||||
repeat_events: bool; [[$true if events are propagated, $false otherwise]]
|
||||
}
|
||||
}
|
||||
@property page_size {
|
||||
|
|
@ -203,22 +204,24 @@ mixin Elm.Interface_Scrollable(Efl.Ui.Scrollable, Efl.Canvas.Group)
|
|||
}
|
||||
}
|
||||
@property bounce_animator_disabled {
|
||||
[[Bounce animator]]
|
||||
set {
|
||||
}
|
||||
get {
|
||||
}
|
||||
values {
|
||||
disabled: bool;
|
||||
disabled: bool; [[$true if bounce animation is disabled, $false otherwise]]
|
||||
}
|
||||
}
|
||||
@property page_scroll_limit {
|
||||
[[Page scroll limit]]
|
||||
set {
|
||||
}
|
||||
get {
|
||||
}
|
||||
values {
|
||||
page_limit_h: int;
|
||||
page_limit_v: int;
|
||||
page_limit_h: int; [[Page limit horizontal]]
|
||||
page_limit_v: int; [[Page limit vertical]]
|
||||
}
|
||||
}
|
||||
@property page_snap_allow {
|
||||
|
|
@ -245,15 +248,16 @@ mixin Elm.Interface_Scrollable(Efl.Ui.Scrollable, Efl.Canvas.Group)
|
|||
}
|
||||
}
|
||||
@property paging {
|
||||
[[Pagin property]]
|
||||
set {
|
||||
}
|
||||
get {
|
||||
}
|
||||
values {
|
||||
pagerel_h: double;
|
||||
pagerel_v: double;
|
||||
pagesize_h: Evas.Coord;
|
||||
pagesize_v: Evas.Coord;
|
||||
pagerel_h: double; [[Page relation horizontal]]
|
||||
pagerel_v: double; [[Page relation vertical]]
|
||||
pagesize_h: Evas.Coord; [[Page size horizontal]]
|
||||
pagesize_v: Evas.Coord; [[Page size vertical]]
|
||||
}
|
||||
}
|
||||
@property single_direction {
|
||||
|
|
@ -278,13 +282,14 @@ mixin Elm.Interface_Scrollable(Efl.Ui.Scrollable, Efl.Canvas.Group)
|
|||
}
|
||||
}
|
||||
@property step_size {
|
||||
[[Step size]]
|
||||
set {
|
||||
}
|
||||
get {
|
||||
}
|
||||
values {
|
||||
x: Evas.Coord;
|
||||
y: Evas.Coord;
|
||||
x: Evas.Coord; [[X coordinate]]
|
||||
y: Evas.Coord; [[Y coordinate]]
|
||||
}
|
||||
}
|
||||
@property loop {
|
||||
|
|
@ -325,10 +330,11 @@ mixin Elm.Interface_Scrollable(Efl.Ui.Scrollable, Efl.Canvas.Group)
|
|||
}
|
||||
}
|
||||
@property freeze {
|
||||
[[Freeze property]]
|
||||
set {
|
||||
}
|
||||
values {
|
||||
freeze: bool;
|
||||
freeze: bool; [[$true if freeze, $false otherwise]]
|
||||
}
|
||||
}
|
||||
@property content_viewport_resize_cb {
|
||||
|
|
@ -336,7 +342,7 @@ mixin Elm.Interface_Scrollable(Efl.Ui.Scrollable, Efl.Canvas.Group)
|
|||
[[When the viewport is resized, the callback is called.]]
|
||||
}
|
||||
values {
|
||||
viewport_resize_cb: Elm_Interface_Scrollable_Resize_Cb @nullable;
|
||||
viewport_resize_cb: Elm_Interface_Scrollable_Resize_Cb @nullable; [[The callback]]
|
||||
}
|
||||
}
|
||||
@property scroll_left_cb {
|
||||
|
|
@ -380,10 +386,11 @@ mixin Elm.Interface_Scrollable(Efl.Ui.Scrollable, Efl.Canvas.Group)
|
|||
}
|
||||
}
|
||||
@property extern_pan {
|
||||
[[Extern pan]]
|
||||
set {
|
||||
}
|
||||
values {
|
||||
pan: Efl.Canvas.Object @nullable;
|
||||
pan: Efl.Canvas.Object @nullable; [[Pan object]]
|
||||
}
|
||||
}
|
||||
@property page_change_cb {
|
||||
|
|
@ -395,10 +402,11 @@ mixin Elm.Interface_Scrollable(Efl.Ui.Scrollable, Efl.Canvas.Group)
|
|||
}
|
||||
}
|
||||
@property hold {
|
||||
[[Hold property]]
|
||||
set {
|
||||
}
|
||||
values {
|
||||
hold: bool;
|
||||
hold: bool; [[$true if hold, $false otherwise]]
|
||||
}
|
||||
}
|
||||
@property animate_start_cb {
|
||||
|
|
@ -422,8 +430,8 @@ mixin Elm.Interface_Scrollable(Efl.Ui.Scrollable, Efl.Canvas.Group)
|
|||
[[Set scroll page size relative to viewport size.]]
|
||||
}
|
||||
values {
|
||||
h_pagerel: double;
|
||||
v_pagerel: double;
|
||||
h_pagerel: double; [[Page relation horizontal]]
|
||||
v_pagerel: double; [[Page relation vertical]]
|
||||
}
|
||||
}
|
||||
@property scroll_cb {
|
||||
|
|
@ -443,17 +451,19 @@ mixin Elm.Interface_Scrollable(Efl.Ui.Scrollable, Efl.Canvas.Group)
|
|||
}
|
||||
}
|
||||
@property mirrored {
|
||||
[[Mirroed property]]
|
||||
set {
|
||||
}
|
||||
values {
|
||||
mirrored: bool;
|
||||
mirrored: bool; [[$true if mirrored, $false otherwise]]
|
||||
}
|
||||
}
|
||||
@property content_min_limit_cb {
|
||||
[[set the callback to run on minimal limit content]]
|
||||
set {
|
||||
}
|
||||
values {
|
||||
min_limit_cb: Elm_Interface_Scrollable_Min_Limit_Cb @nullable;
|
||||
min_limit_cb: Elm_Interface_Scrollable_Min_Limit_Cb @nullable; [[The callback]]
|
||||
}
|
||||
}
|
||||
@property scroll_right_cb {
|
||||
|
|
@ -465,10 +475,11 @@ mixin Elm.Interface_Scrollable(Efl.Ui.Scrollable, Efl.Canvas.Group)
|
|||
}
|
||||
}
|
||||
@property content {
|
||||
[[Content property]]
|
||||
set {
|
||||
}
|
||||
values {
|
||||
content: Efl.Canvas.Object @nullable;
|
||||
content: Efl.Canvas.Object @nullable; [[Content object]]
|
||||
}
|
||||
}
|
||||
@property edge_left_cb {
|
||||
|
|
@ -520,11 +531,12 @@ mixin Elm.Interface_Scrollable(Efl.Ui.Scrollable, Efl.Canvas.Group)
|
|||
}
|
||||
}
|
||||
@property objects {
|
||||
[[Object property]]
|
||||
set {
|
||||
}
|
||||
values {
|
||||
edje_object: Efl.Canvas.Object;
|
||||
hit_rectangle: Efl.Canvas.Object;
|
||||
edje_object: Efl.Canvas.Object; [[Edje object]]
|
||||
hit_rectangle: Efl.Canvas.Object; [[Evas object]]
|
||||
}
|
||||
}
|
||||
@property last_page {
|
||||
|
|
@ -558,13 +570,14 @@ mixin Elm.Interface_Scrollable(Efl.Ui.Scrollable, Efl.Canvas.Group)
|
|||
}
|
||||
}
|
||||
@property content_viewport_geometry {
|
||||
[[Content viewport geometry]]
|
||||
get {
|
||||
}
|
||||
values {
|
||||
x: Evas.Coord;
|
||||
y: Evas.Coord;
|
||||
w: Evas.Coord;
|
||||
h: Evas.Coord;
|
||||
x: Evas.Coord; [[X coordinate]]
|
||||
y: Evas.Coord; [[Y coordinate]]
|
||||
w: Evas.Coord; [[Width]]
|
||||
h: Evas.Coord; [[Height]]
|
||||
}
|
||||
}
|
||||
@property content_size {
|
||||
|
|
@ -580,16 +593,18 @@ mixin Elm.Interface_Scrollable(Efl.Ui.Scrollable, Efl.Canvas.Group)
|
|||
}
|
||||
}
|
||||
content_pos_set {
|
||||
[[Set the content position]]
|
||||
params {
|
||||
@in x: Evas.Coord;
|
||||
@in y: Evas.Coord;
|
||||
@in sig: bool;
|
||||
@in x: Evas.Coord; [[X coordinate]]
|
||||
@in y: Evas.Coord; [[Y coordinate]]
|
||||
@in sig: bool; [[FIXME: what does sig stand for here?]]
|
||||
}
|
||||
}
|
||||
content_pos_get {
|
||||
[[Get content position]]
|
||||
params {
|
||||
@out x: Evas.Coord;
|
||||
@out y: Evas.Coord;
|
||||
@out x: Evas.Coord; [[X coordinate]]
|
||||
@out y: Evas.Coord; [[Y coordinate]]
|
||||
}
|
||||
}
|
||||
page_show {
|
||||
|
|
@ -656,8 +671,8 @@ mixin Elm.Interface_Scrollable(Efl.Ui.Scrollable, Efl.Canvas.Group)
|
|||
right size horizontally and/or vertically to perfectly fit its content in
|
||||
that direction.]]
|
||||
params {
|
||||
@in w: bool; [[whether to limit the minimum horizontal size]]
|
||||
@in h: bool; [[whether to limit the minimum vertical size]]
|
||||
@in w: bool; [[Whether to limit the minimum horizontal size]]
|
||||
@in h: bool; [[Whether to limit the minimum vertical size]]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -667,6 +682,6 @@ mixin Elm.Interface_Scrollable(Efl.Ui.Scrollable, Efl.Canvas.Group)
|
|||
Efl.Canvas.Group.group_del;
|
||||
}
|
||||
events {
|
||||
changed;
|
||||
changed; [[Called when content changed]]
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue