docs: elm: document missing structs

This commit is contained in:
Stefan Schmidt 2016-10-27 16:45:19 +02:00
parent 72f456ee82
commit 89de3ddd77
6 changed files with 24 additions and 20 deletions

View File

@ -1,7 +1,7 @@
struct Efl.Ui.Box.Flow_Params { struct Efl.Ui.Box.Flow_Params {
[[Extra parameters for Box_Flow layout. Can be omitted.]] [[Extra parameters for Box_Flow layout. Can be omitted.]]
homogenous: bool; homogenous: bool; [[$true if the box flow layout is homogenous, $false otherwise]]
max_size: bool; max_size: bool; [[$true if the box flow layout has the maximal size, $false otherwise]]
} }
class Efl.Ui.Box.Flow (Efl.Ui.Box, Efl.Pack.Layout) class Efl.Ui.Box.Flow (Efl.Ui.Box, Efl.Pack.Layout)
@ -12,14 +12,14 @@ class Efl.Ui.Box.Flow (Efl.Ui.Box, Efl.Pack.Layout)
set {} set {}
get {} get {}
values { values {
val: bool; val: bool; [[$true if the box flow layout is homogenous, $false otherwise]]
} }
} }
@property box_flow_max_size { @property box_flow_max_size {
set {} set {}
get {} get {}
values { values {
val: bool; val: bool; [[$true if the box flow layout has the maximal size, $false otherwise]]
} }
} }
} }

View File

@ -28,8 +28,8 @@ struct Efl.Ui.Image.Progress
Structure associated with smart callback 'download,progress'. Structure associated with smart callback 'download,progress'.
@since 1.8 @since 1.8
]] ]]
now: double; now: double; [[Current percentage]]
total: double; total: double; [[Total percentage]]
} }
struct Efl.Ui.Image.Error struct Efl.Ui.Image.Error
@ -38,8 +38,8 @@ struct Efl.Ui.Image.Error
Structure associated with smart callback 'download,progress'. Structure associated with smart callback 'download,progress'.
@since 1.8 @since 1.8
]] ]]
status: int; status: int; [[Error status of the download]]
open_error: bool; open_error: bool; [[$true if the error happened when opening the file, $false otherwise]]
} }
class Efl.Ui.Image (Elm.Widget, Efl.Ui.Clickable, Efl.Ui.Draggable, class Efl.Ui.Image (Elm.Widget, Efl.Ui.Clickable, Efl.Ui.Draggable,

View File

@ -4,6 +4,7 @@ import elm_entry;
struct Efl.Ui.Text.Anchor_Info struct Efl.Ui.Text.Anchor_Info
{ {
[[EFL UI text anchor information]]
name: string; [[The name of the anchor, as stated in its href.]] name: string; [[The name of the anchor, as stated in its href.]]
button: int; [[The mouse button used to click on it.]] button: int; [[The mouse button used to click on it.]]
x: Evas.Coord; [[Anchor geometry, relative to canvas.]] x: Evas.Coord; [[Anchor geometry, relative to canvas.]]
@ -14,17 +15,19 @@ struct Efl.Ui.Text.Anchor_Info
struct Efl.Ui.Text.Hover_Parent struct Efl.Ui.Text.Hover_Parent
{ {
x: Evas.Coord; [[EFL text hover parent]]
y: Evas.Coord; x: Evas.Coord; [[Hover parent X coordinate]]
w: Evas.Coord; y: Evas.Coord; [[Hover parent Y coordinate]]
h: Evas.Coord; w: Evas.Coord; [[Hover parent width]]
h: Evas.Coord; [[Hover parent height]]
} }
struct Efl.Ui.Text.Anchor_Hover_Info struct Efl.Ui.Text.Anchor_Hover_Info
{ {
[[EFL text anchor hover information]]
anchor_info: const(Efl.Ui.Text.Anchor_Info)*; [[The actual anchor info.]] anchor_info: const(Efl.Ui.Text.Anchor_Info)*; [[The actual anchor info.]]
hover: Elm.Hover; [[The hover object to use for the popup.]] hover: Elm.Hover; [[The hover object to use for the popup.]]
hover_parent: Efl.Ui.Text.Hover_Parent; hover_parent: Efl.Ui.Text.Hover_Parent; [[Hover parent widget]]
hover_left : bool; [[Hint indicating if there's space hover_left : bool; [[Hint indicating if there's space
for content on the left side of for content on the left side of
the hover. Before calling the the hover. Before calling the

View File

@ -3,8 +3,8 @@ import edje_types;
import elm_interface_scrollable; import elm_interface_scrollable;
import elm_general; import elm_general;
struct @extern Elm_Code; /* The main interface currently defined in code */ struct @extern Elm_Code; [[Elementary code main data structure]] /* The main interface currently defined in code */
struct @extern Elm_Code_Line; /* Parts of the interface currently defined in code */ struct @extern Elm_Code_Line; [[Elementary code line data structure]] /* Parts of the interface currently defined in code */
class Elm.Code_Widget (Elm.Layout, Elm.Interface.Atspi.Text) class Elm.Code_Widget (Elm.Layout, Elm.Interface.Atspi.Text)
{ {

View File

@ -22,6 +22,7 @@ type Eina_Compare_Cb: __undefined_type;
/* FIXME: This shouldn't be here, we don't do functions in eolian!!! */ /* FIXME: This shouldn't be here, we don't do functions in eolian!!! */
struct Elm.Gen.Item.Class.Functions struct Elm.Gen.Item.Class.Functions
{ {
[[Elementary genlist/gengrid callback functions data structure]]
text_get: Elm_Gen_Item_Text_Get_Cb; [[ Text fetching class function for text_get: Elm_Gen_Item_Text_Get_Cb; [[ Text fetching class function for
genlist/gengrid item classes. ]] genlist/gengrid item classes. ]]
content_get: Elm_Gen_Item_Content_Get_Cb; [[ Content fetching class function content_get: Elm_Gen_Item_Content_Get_Cb; [[ Content fetching class function

View File

@ -16,11 +16,11 @@ struct Elm.Toolbar.Item.State
State of a Elm_Toolbar_Item. State of a Elm_Toolbar_Item.
Can be created with elm_toolbar_item_state_add() and removed with elm_toolbar_item_state_del(). Can be created with elm_toolbar_item_state_add() and removed with elm_toolbar_item_state_del().
]] ]]
label: string; label: string; [[Item label]]
icon_str: string; icon_str: string; [[Item icon string]]
icon: Efl.Canvas.Object; icon: Efl.Canvas.Object; [[Item icon]]
func: Evas_Smart_Cb ; func: Evas_Smart_Cb ; [[Item callback function]]
data: const(void_ptr); data: const(void_ptr); [[Item data]]
} }
class Elm.Toolbar.Item(Elm.Widget.Item) class Elm.Toolbar.Item(Elm.Widget.Item)