forked from enlightenment/efl
docs: elm: fill gaps in glview, pan, panes, photo and plug eo file documentation
This commit is contained in:
parent
e27a728079
commit
144ba2480e
|
@ -82,6 +82,7 @@ enum Elm.GLView.Render.Policy
|
|||
|
||||
class Elm.Glview (Elm.Widget, Efl.Gfx.View)
|
||||
{
|
||||
[[Elementary GL view class]]
|
||||
legacy_prefix: elm_glview;
|
||||
eo_prefix: elm_obj_glview;
|
||||
event_prefix: elm_glview;
|
||||
|
@ -90,7 +91,7 @@ class Elm.Glview (Elm.Widget, Efl.Gfx.View)
|
|||
[[Constructor with context version number.]]
|
||||
legacy: null;
|
||||
params {
|
||||
@in version: Evas_GL_Context_Version;
|
||||
@in version: Evas_GL_Context_Version; [[GL context version]]
|
||||
}
|
||||
}
|
||||
@property resize_policy {
|
||||
|
@ -104,7 +105,7 @@ class Elm.Glview (Elm.Widget, Efl.Gfx.View)
|
|||
#ELM_GLVIEW_RESIZE_POLICY_SCALE, however, glview only
|
||||
scales the image object and not the underlying GL Surface.
|
||||
]]
|
||||
return: bool;
|
||||
return: bool; [[$true on success, $false otherwise]]
|
||||
}
|
||||
values {
|
||||
policy: Elm.GLView.Resize.Policy; [[The scaling policy.]]
|
||||
|
@ -122,7 +123,7 @@ class Elm.Glview (Elm.Widget, Efl.Gfx.View)
|
|||
redraws regardless of whether it is visible or needs
|
||||
redrawing.
|
||||
]]
|
||||
return: bool;
|
||||
return: bool; [[$true on success, $false otherwise]]
|
||||
}
|
||||
values {
|
||||
policy: Elm.GLView.Render.Policy; [[The render policy.]]
|
||||
|
@ -137,7 +138,7 @@ class Elm.Glview (Elm.Widget, Efl.Gfx.View)
|
|||
it falls back to rendering to an offscreen buffer before it
|
||||
gets composited to the window.
|
||||
]]
|
||||
return: bool;
|
||||
return: bool; [[$true on success, $false otherwise]]
|
||||
}
|
||||
values {
|
||||
mode: Elm.GLView.Mode; [[The mode Options OR'ed enabling Alpha, Depth, Stencil, Direct.]]
|
||||
|
@ -146,7 +147,7 @@ class Elm.Glview (Elm.Widget, Efl.Gfx.View)
|
|||
@property gl_api {
|
||||
get {
|
||||
[[Get the gl api struct for gl rendering.]]
|
||||
return: ptr(Evas_GL_API);
|
||||
return: ptr(Evas_GL_API); [[GL API]]
|
||||
}
|
||||
}
|
||||
@property evas_gl {
|
||||
|
@ -159,7 +160,7 @@ class Elm.Glview (Elm.Widget, Efl.Gfx.View)
|
|||
|
||||
@since 1.12
|
||||
]]
|
||||
return: ptr(Evas_GL);
|
||||
return: ptr(Evas_GL); [[Evas GL]]
|
||||
}
|
||||
}
|
||||
@property rotation {
|
||||
|
|
|
@ -1,42 +1,47 @@
|
|||
class Elm.Pan (Efl.Canvas.Group.Clipped)
|
||||
{
|
||||
[[Elementary pan class]]
|
||||
legacy_prefix: elm_pan;
|
||||
eo_prefix: elm_obj_pan;
|
||||
event_prefix: elm_pan;
|
||||
data: Elm_Pan_Smart_Data;
|
||||
methods {
|
||||
@property pos {
|
||||
[[Position]]
|
||||
set {
|
||||
}
|
||||
get {
|
||||
}
|
||||
values {
|
||||
x: Evas.Coord;
|
||||
y: Evas.Coord;
|
||||
x: Evas.Coord; [[X coordinate]]
|
||||
y: Evas.Coord; [[Y coordinate]]
|
||||
}
|
||||
}
|
||||
@property content_size {
|
||||
[[Content size]]
|
||||
get {
|
||||
}
|
||||
values {
|
||||
w: Evas.Coord;
|
||||
h: Evas.Coord;
|
||||
w: Evas.Coord; [[Width]]
|
||||
h: Evas.Coord; [[Height]]
|
||||
}
|
||||
}
|
||||
@property pos_min {
|
||||
[[Minimal position]]
|
||||
get {
|
||||
}
|
||||
values {
|
||||
x: Evas.Coord;
|
||||
y: Evas.Coord;
|
||||
x: Evas.Coord; [[X coordinate]]
|
||||
y: Evas.Coord; [[Y coordinate]]
|
||||
}
|
||||
}
|
||||
@property pos_max {
|
||||
[[Maximal position]]
|
||||
get {
|
||||
}
|
||||
values {
|
||||
x: Evas.Coord;
|
||||
y: Evas.Coord;
|
||||
x: Evas.Coord; [[X coordinate]]
|
||||
y: Evas.Coord; [[Y coordinate]]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -50,7 +55,6 @@ class Elm.Pan (Efl.Canvas.Group.Clipped)
|
|||
Efl.Canvas.Group.group_del;
|
||||
}
|
||||
events {
|
||||
changed;
|
||||
changed; [[Called when pan object changed]]
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
@ -1,6 +1,7 @@
|
|||
class Elm.Panes (Elm.Layout, Efl.Orientation,
|
||||
Efl.Ui.Clickable)
|
||||
{
|
||||
[[Elementary panes class]]
|
||||
legacy_prefix: elm_panes;
|
||||
eo_prefix: elm_obj_panes;
|
||||
event_prefix: elm_panes;
|
||||
|
@ -74,7 +75,7 @@ class Elm.Panes (Elm.Layout, Efl.Orientation,
|
|||
get {
|
||||
}
|
||||
values {
|
||||
size: double; [[value between 0.0 and 1.0 representing size proportion of minimum size of left side.]]
|
||||
size: double; [[Value between 0.0 and 1.0 representing size proportion of minimum size of left side.]]
|
||||
}
|
||||
}
|
||||
@property content_right_min_relative_size {
|
||||
|
@ -86,7 +87,7 @@ class Elm.Panes (Elm.Layout, Efl.Orientation,
|
|||
get {
|
||||
}
|
||||
values {
|
||||
size: double; [[value between 0.0 and 1.0 representing size proportion of minimum size of right side.]]
|
||||
size: double; [[Value between 0.0 and 1.0 representing size proportion of minimum size of right side.]]
|
||||
}
|
||||
}
|
||||
@property content_left_min_size {
|
||||
|
@ -98,7 +99,7 @@ class Elm.Panes (Elm.Layout, Efl.Orientation,
|
|||
get {
|
||||
}
|
||||
values {
|
||||
size: Evas.Coord; [[value representing minimum size of left side in pixels.]]
|
||||
size: Evas.Coord; [[Value representing minimum size of left side in pixels.]]
|
||||
}
|
||||
}
|
||||
@property content_right_min_size {
|
||||
|
@ -110,7 +111,7 @@ class Elm.Panes (Elm.Layout, Efl.Orientation,
|
|||
get {
|
||||
}
|
||||
values {
|
||||
size: Evas.Coord; [[value representing minimum size of right side in pixels.]]
|
||||
size: Evas.Coord; [[Value representing minimum size of right side in pixels.]]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -125,8 +126,7 @@ class Elm.Panes (Elm.Layout, Efl.Orientation,
|
|||
Efl.Orientation.orientation;
|
||||
}
|
||||
events {
|
||||
press;
|
||||
unpress;
|
||||
press; [[Called when panes got pressed]]
|
||||
unpress; [[Called when panes are no longer pressed]]
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
class Elm.Photo (Elm.Widget, Efl.File, Efl.Ui.Clickable, Efl.Ui.Draggable)
|
||||
{
|
||||
[[Elementary photo class]]
|
||||
legacy_prefix: elm_photo;
|
||||
eo_prefix: elm_obj_photo;
|
||||
implements {
|
||||
|
@ -10,5 +11,4 @@ class Elm.Photo (Elm.Widget, Efl.File, Efl.Ui.Clickable, Efl.Ui.Draggable)
|
|||
Efl.Canvas.Group.group_del;
|
||||
Elm.Widget.theme_apply;
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
class Elm.Plug (Elm.Widget, Efl.Ui.Clickable)
|
||||
{
|
||||
[[Elementary plug class]]
|
||||
legacy_prefix: elm_plug;
|
||||
eo_prefix: elm_obj_plug;
|
||||
event_prefix: elm_plug;
|
||||
|
@ -37,8 +38,7 @@ class Elm.Plug (Elm.Widget, Efl.Ui.Clickable)
|
|||
Elm.Widget.on_focus;
|
||||
}
|
||||
events {
|
||||
image,deleted;
|
||||
image,resized; [[ii]]
|
||||
image,deleted; [[Called when image was deleted]]
|
||||
image,resized; [[Called when image was resized]]
|
||||
}
|
||||
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue