summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorDavid Walter Seikel <onefang@gmail.com>2013-01-06 15:36:44 +0000
committerDavid Walter Seikel <onefang@gmail.com>2013-01-06 15:36:44 +0000
commit6a804bb4e1665c45da7991b2de1baa60ab1afad0 (patch)
treef1028aa8e1288f4af7be7a5cb3bd2be01cc51909 /src
parent0b12a76c5aaef672734bd72d433866173793081b (diff)
Clean up the Lua docs. Much less clean up than I thought would be needed.
And my work for the year is done. B-) SVN revision: 82306
Diffstat (limited to 'src')
-rw-r--r--src/lib/edje/edje_lua2.c70
1 files changed, 35 insertions, 35 deletions
diff --git a/src/lib/edje/edje_lua2.c b/src/lib/edje/edje_lua2.c
index 2515850ff1..ec5d48a8f9 100644
--- a/src/lib/edje/edje_lua2.c
+++ b/src/lib/edje/edje_lua2.c
@@ -683,7 +683,7 @@ static const struct luaL_Reg _elua_edje_funcs [] =
683 683
684/** 684/**
685@page luaref 685@page luaref
686@subsubsection edje_echo edje:echo(text) 686@subsubsection edje_echo edje.echo(text)
687 687
688Make lua a bit shelly. Prints a string to the console 688Make lua a bit shelly. Prints a string to the console
689 689
@@ -700,7 +700,7 @@ _elua_echo(lua_State *L) // Stack usage [-0, +0, v]
700//------------- 700//-------------
701/** 701/**
702@page luaref 702@page luaref
703@subsubsection edje_date edje:date() 703@subsubsection edje_date edje.date()
704 704
705Retrieves the current time and date. 705Retrieves the current time and date.
706 706
@@ -753,15 +753,15 @@ _elua_date(lua_State *L) // Stack usage [-16, +17, em]
753 753
754/** 754/**
755@page luaref 755@page luaref
756@subsubsection edje_looptime edje:looptime() 756@subsubsection edje_looptime edje.looptime()
757 757
758Retrieves the time at which the last loop stopped waiting for timeouts or events. 758Retrieves the time at which the last loop stopped waiting for timeouts or events.
759 759
760This gets the time that the main loop ceased waiting for timouts and/or events 760This gets the time that the main loop ceased waiting for timouts and/or events
761to come in or for signals or any other interrupt source. This should be 761to come in or for signals or any other interrupt source. This should be
762considered a reference point for all time based activity that should calculate 762considered a reference point for all time based activity that should calculate
763its timepoint from the return of edje:looptime(). Use this UNLESS you absolutely 763its timepoint from the return of edje.looptime(). Use this UNLESS you absolutely
764must get the current actual timepoint - then use edje:seconds(). Note that this 764must get the current actual timepoint - then use edje.seconds(). Note that this
765time is meant to be used as relative to other times obtained on this run. 765time is meant to be used as relative to other times obtained on this run.
766 766
767Wraps ecore_loop_time_get(). 767Wraps ecore_loop_time_get().
@@ -778,7 +778,7 @@ _elua_looptime(lua_State *L) // Stack usage [-0, +1, -]
778 778
779/** 779/**
780@page luaref 780@page luaref
781@subsubsection edje_seconds edje:seconds() 781@subsubsection edje_seconds edje.seconds()
782 782
783Retrieves the current system time as a floating point value in seconds. 783Retrieves the current system time as a floating point value in seconds.
784 784
@@ -800,7 +800,7 @@ _elua_seconds(lua_State *L) // Stack usage [-0, +1, -]
800 800
801/** 801/**
802@page luaref 802@page luaref
803@subsubsection edje_version edje:version() 803@subsubsection edje_version edje.version()
804 804
805Retrieves the current edje version number. 805Retrieves the current edje version number.
806 806
@@ -820,7 +820,7 @@ _elua_version(lua_State *L) // St
820//------------- 820//-------------
821/** 821/**
822@page luaref 822@page luaref
823@subsubsection edje_geom edje:geom() 823@subsubsection edje_geom edje.geom()
824 824
825Retrieves the position and size of the edje object that this lua group is in. 825Retrieves the position and size of the edje object that this lua group is in.
826 826
@@ -840,7 +840,7 @@ _elua_objgeom(lua_State *L) // Stack usage [-10
840 840
841/** 841/**
842@page luaref 842@page luaref
843@subsubsection edje_pos edje:pos() 843@subsubsection edje_pos edje.pos()
844 844
845 845
846Retrieves the position of the edje object that this lua group is in. 846Retrieves the position of the edje object that this lua group is in.
@@ -859,7 +859,7 @@ _elua_objpos(lua_State *L) // Stack usage [-6,
859 859
860/** 860/**
861@page luaref 861@page luaref
862@subsubsection edje_size edje:size() 862@subsubsection edje_size edje.size()
863 863
864 864
865Retrieves the size of the edje object that this lua group is in. 865Retrieves the size of the edje object that this lua group is in.
@@ -879,7 +879,7 @@ _elua_objsize(lua_State *L) // Stack usage [-6,
879//------------- 879//-------------
880/** 880/**
881@page luaref 881@page luaref
882@subsubsection edje_emit edje:emit(signal, source) 882@subsubsection edje_emit edje.emit(signal, source)
883 883
884Emit a signal. 884Emit a signal.
885 885
@@ -912,7 +912,7 @@ _elua_emit(lua_State *L) // Stack usage [-2,
912 912
913/** 913/**
914@page luaref 914@page luaref
915@subsubsection edje_message_send edje:messagesend(id, type, ...) 915@subsubsection edje_message_send edje.messagesend(id, type, ...)
916 916
917Send a message to this edje, and all it's child objects. 917Send a message to this edje, and all it's child objects.
918 918
@@ -1164,7 +1164,7 @@ _elua_animator_free(void *obj) // Stack usage [-0,
1164 1164
1165/** 1165/**
1166@page luaref 1166@page luaref
1167@subsubsection edje_animator edje:animator(func) 1167@subsubsection edje_animator edje.animator(func)
1168 1168
1169This function adds an animator and returns its handle on success and NULL on 1169This function adds an animator and returns its handle on success and NULL on
1170failure. The function func will be called every frame tick. Note that setting 1170failure. The function func will be called every frame tick. Note that setting
@@ -1251,7 +1251,7 @@ _elua_timer_free(void *obj) // Stack usage [-0,
1251 1251
1252/** 1252/**
1253@page luaref 1253@page luaref
1254@subsubsection edje_timer edje:timer(tick, func) 1254@subsubsection edje_timer edje.timer(tick, func)
1255 1255
1256This function adds a timer and returns its handle on success and NULL on failure. 1256This function adds a timer and returns its handle on success and NULL on failure.
1257The function func will be called every tick seconds. 1257The function func will be called every tick seconds.
@@ -1343,9 +1343,9 @@ _elua_transition_free(void *obj) // Stack usage [-0,
1343 1343
1344/** 1344/**
1345@page luaref 1345@page luaref
1346@subsubsection edje_transition edje:transition(div, func) 1346@subsubsection edje_transition edje.transition(div, func)
1347 1347
1348Just like edje:animator(), except that the callback function gets called with an 1348Just like edje.animator(), except that the callback function gets called with an
1349argument. The argument is the amount of time since the transition was created, 1349argument. The argument is the amount of time since the transition was created,
1350divided by the div parameter. 1350divided by the div parameter.
1351 1351
@@ -1380,7 +1380,7 @@ _elua_transition(lua_State *L) // Stack usage [-8,
1380//------------- 1380//-------------
1381/** 1381/**
1382@page luaref 1382@page luaref
1383@subsubsection edje_colour_class edje:color_class(class, r, g, b, a) 1383@subsubsection edje_colour_class edje.color_class(class, r, g, b, a)
1384 1384
1385Gets, (and optionally sets) the colours for a color class. 1385Gets, (and optionally sets) the colours for a color class.
1386 1386
@@ -1436,7 +1436,7 @@ _elua_color_class(lua_State *L) // Stack usage [-(1
1436 1436
1437/** 1437/**
1438@page luaref 1438@page luaref
1439@subsubsection edje_text_class edje:text_class(class, font, size) 1439@subsubsection edje_text_class edje.text_class(class, font, size)
1440 1440
1441Gets, (and optionally sets) the details for a text class. 1441Gets, (and optionally sets) the details for a text class.
1442 1442
@@ -1514,7 +1514,7 @@ _elua_polish_evas_object(Edje *ed, Edje_Lua_Evas_Object *elo)
1514 1514
1515/** 1515/**
1516@page luaref 1516@page luaref
1517@subsubsection edje_edje edje:edje() 1517@subsubsection edje_edje edje.edje()
1518 1518
1519Create an edje object, and add it to the edje. 1519Create an edje object, and add it to the edje.
1520 1520
@@ -1537,7 +1537,7 @@ _elua_edje(lua_State *L) // Stack usage [-7,
1537 1537
1538/** 1538/**
1539@page luaref 1539@page luaref
1540@subsubsection edje_image edje:image() 1540@subsubsection edje_image edje.image()
1541 1541
1542Create an evas image, and add it to the edje. 1542Create an evas image, and add it to the edje.
1543 1543
@@ -1559,7 +1559,7 @@ _elua_image(lua_State *L) // Stack usage [-7,
1559 1559
1560/** 1560/**
1561@page luaref 1561@page luaref
1562@subsubsection edje_line edje:line() 1562@subsubsection edje_line edje.line()
1563 1563
1564Create an evas line, and add it to the edje. 1564Create an evas line, and add it to the edje.
1565 1565
@@ -1590,7 +1590,7 @@ _elua_map_free(void *obj)
1590 1590
1591/** 1591/**
1592@page luaref 1592@page luaref
1593@subsubsection edje_map edje:map() 1593@subsubsection edje_map edje.map()
1594 1594
1595Create an evas map. 1595Create an evas map.
1596 1596
@@ -1611,7 +1611,7 @@ _elua_map(lua_State *L) // Stack usage [-7,
1611 1611
1612/** 1612/**
1613@page luaref 1613@page luaref
1614@subsubsection edje_polygon edje:polygon() 1614@subsubsection edje_polygon edje.polygon()
1615 1615
1616Create an evas polygon, and add it to the edje. 1616Create an evas polygon, and add it to the edje.
1617 1617
@@ -1633,7 +1633,7 @@ _elua_polygon(lua_State *L) // Stack usage [-7,
1633 1633
1634/** 1634/**
1635@page luaref 1635@page luaref
1636@subsubsection edje_rect edje:rect() 1636@subsubsection edje_rect edje.rect()
1637 1637
1638Create an evas rectangle, and add it to the edje. 1638Create an evas rectangle, and add it to the edje.
1639 1639
@@ -1653,7 +1653,7 @@ _elua_rect(lua_State *L) // Stack usage [-7,
1653 1653
1654/** 1654/**
1655@page luaref 1655@page luaref
1656@subsubsection edje_text edje:text() 1656@subsubsection edje_text edje.text()
1657 1657
1658Create an evas text object, and add it to the edje. 1658Create an evas text object, and add it to the edje.
1659 1659
@@ -1692,7 +1692,7 @@ _elua_textblock(lua_State *L) // Stack usage [-7,
1692@subsection evas Evas class. 1692@subsection evas Evas class.
1693 1693
1694The lua evas class includes functions for dealing with evas objects. The evas 1694The lua evas class includes functions for dealing with evas objects. The evas
1695objects must have been previously created by lua using one of the lua ezas 1695objects must have been previously created by lua using one of the lua evas
1696object creation functions from the lua edje class. 1696object creation functions from the lua edje class.
1697 1697
1698In the following, "evas_object" is a place holder for any lua variable that 1698In the following, "evas_object" is a place holder for any lua variable that
@@ -2518,7 +2518,7 @@ _elua_obj_map_enable(lua_State *L) // Stack usage [
2518 2518
2519The lua ecore animator class includes functions for dealing with ecore animator objects. 2519The lua ecore animator class includes functions for dealing with ecore animator objects.
2520The ecore animator objects must have been previously created by lua using the lua 2520The ecore animator objects must have been previously created by lua using the lua
2521edje object creation function edje:animator() or edje:transition(). 2521edje object creation function edje.animator() or edje.transition().
2522 2522
2523In the following, "animator_object" is a place holder for any lua variable that 2523In the following, "animator_object" is a place holder for any lua variable that
2524holds a reference to an ecore animator object. 2524holds a reference to an ecore animator object.
@@ -2537,7 +2537,7 @@ static const struct luaL_Reg _elua_ecore_animator_funcs [] =
2537 2537
2538The lua ecore timer class includes functions for dealing with ecore timer objects. 2538The lua ecore timer class includes functions for dealing with ecore timer objects.
2539The ecore timer objects must have been previously created by lua using the lua 2539The ecore timer objects must have been previously created by lua using the lua
2540edje object creation function edje:timer(). 2540edje object creation function edje.timer().
2541 2541
2542In the following, "timer_object" is a place holder for any lua variable that 2542In the following, "timer_object" is a place holder for any lua variable that
2543holds a reference to an ecore timer object. 2543holds a reference to an ecore timer object.
@@ -2557,7 +2557,7 @@ static const struct luaL_Reg _elua_ecore_timer_funcs [] =
2557 2557
2558The lua evas edje class includes functions for dealing with evas edje objects. 2558The lua evas edje class includes functions for dealing with evas edje objects.
2559The evas edje objects must have been previously created by lua using the lua 2559The evas edje objects must have been previously created by lua using the lua
2560edje object creation function edje:edje(). 2560edje object creation function edje.edje().
2561 2561
2562In the following, "edje_object" is a place holder for any lua variable that 2562In the following, "edje_object" is a place holder for any lua variable that
2563holds a reference to an evas edje object. NOT the edje class specified earlier 2563holds a reference to an evas edje object. NOT the edje class specified earlier
@@ -2655,7 +2655,7 @@ _elua_edje_file(lua_State *L) // Stack usage [
2655 2655
2656The lua evas image class includes functions for dealing with evas image objects. 2656The lua evas image class includes functions for dealing with evas image objects.
2657The evas image objects must have been previously created by lua using the lua 2657The evas image objects must have been previously created by lua using the lua
2658image object creation function edje:image(). 2658image object creation function edje.image().
2659 2659
2660In the following, "image_object" is a place holder for any lua variable that 2660In the following, "image_object" is a place holder for any lua variable that
2661holds a reference to an evas image object. 2661holds a reference to an evas image object.
@@ -2859,7 +2859,7 @@ _elua_image_image(lua_State *L) // Stack usage [
2859 2859
2860The lua evas line class includes functions for dealing with evas line objects. 2860The lua evas line class includes functions for dealing with evas line objects.
2861The evas line objects must have been previously created by lua using the lua 2861The evas line objects must have been previously created by lua using the lua
2862line object creation function edje:line(). 2862line object creation function edje.line().
2863 2863
2864In the following, "line_object" is a place holder for any lua variable that 2864In the following, "line_object" is a place holder for any lua variable that
2865holds a reference to an evas line object. 2865holds a reference to an evas line object.
@@ -2929,7 +2929,7 @@ static int _elua_line_xy(lua_State *L) // Stack usage [
2929 2929
2930The lua evas map class includes functions for dealing with evas map objects. 2930The lua evas map class includes functions for dealing with evas map objects.
2931The evas map objects must have been previously created by lua using the lua 2931The evas map objects must have been previously created by lua using the lua
2932map object creation function edje:map(). The evas map system is complex, rather 2932map object creation function edje.map(). The evas map system is complex, rather
2933than repeat the copious documentation here, please refer to the evas map 2933than repeat the copious documentation here, please refer to the evas map
2934documentation. It has pictures and everything. B-) 2934documentation. It has pictures and everything. B-)
2935 2935
@@ -3503,7 +3503,7 @@ _elua_map_zoom(lua_State *L) // Stack usage [
3503 3503
3504The lua evas polygon class includes functions for dealing with evas polygon objects. 3504The lua evas polygon class includes functions for dealing with evas polygon objects.
3505The evas polygon objects must have been previously created by lua using the lua 3505The evas polygon objects must have been previously created by lua using the lua
3506polygon object creation function edje:polygon(). 3506polygon object creation function edje.polygon().
3507 3507
3508In the following, "polygon_object" is a place holder for any lua variable that 3508In the following, "polygon_object" is a place holder for any lua variable that
3509holds a reference to an evas polygon object. 3509holds a reference to an evas polygon object.
@@ -3583,7 +3583,7 @@ _elua_polygon_point(lua_State *L) // Stack usage [
3583 3583
3584The lua evas text class includes functions for dealing with evas text objects. 3584The lua evas text class includes functions for dealing with evas text objects.
3585The evas text objects must have been previously created by lua using the lua 3585The evas text objects must have been previously created by lua using the lua
3586text object creation function edje:text(). 3586text object creation function edje.text().
3587 3587
3588In the following, "text_object" is a place holder for any lua variable that 3588In the following, "text_object" is a place holder for any lua variable that
3589holds a reference to an evas text object. 3589holds a reference to an evas text object.
@@ -4229,7 +4229,7 @@ _edje_lua2_script_func_resize(Edje *ed) // Stack usage [-3, +3, e] or [-1, +1,
4229 4229
4230If a function called "message" exists in a lua edje group, then it is called when 4230If a function called "message" exists in a lua edje group, then it is called when
4231that edje gets gets a message sent to it, with the message details passed to it. 4231that edje gets gets a message sent to it, with the message details passed to it.
4232See edje:messagesend() for details of what each type means. The arrays are 4232See edje.messagesend() for details of what each type means. The arrays are
4233passed as a table. 4233passed as a table.
4234*/ 4234*/
4235void 4235void