From 252e677ba7a86a46595e35cb2b8eccfc6da6a101 Mon Sep 17 00:00:00 2001 From: Paul Liverman III Date: Tue, 21 Jun 2016 00:58:22 -0700 Subject: [PATCH] actually documented the last bit --- docs/index.html | 2 +- docs/modules/pop.html | 242 +++++++++++++++++++++++++++++++++++++++-- docs/modules/util.html | 2 +- 3 files changed, 237 insertions(+), 9 deletions(-) diff --git a/docs/index.html b/docs/index.html index fa5a30e..ee2940c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -58,7 +58,7 @@
generated by LDoc 1.4.3 -Last updated 2016-06-20 22:28:27 +Last updated 2016-06-21 00:58:10
diff --git a/docs/modules/pop.html b/docs/modules/pop.html index 3297647..6f7a1f3 100644 --- a/docs/modules/pop.html +++ b/docs/modules/pop.html @@ -73,15 +73,39 @@ update (dt, element) - Event handler for love.update() events. + Event handler for love.update(). draw (element) - Event handler for love.draw() events. + Event handler for love.draw(). mousemoved (x, y, dx, dy) - Event handler for love.mousemoved() events. + Event handler for love.mousemoved(). + + + mousepressed (x, y, button, element) + Event handler for love.mousepressed(). + + + mousereleased (x, y, button, element) + Event handler for love.mousereleased(). + + + keypressed (key) + Event handler for love.keypressed(). + + + keyreleased (key) + Event handler for love.keyreleased(). + + + textinput (text) + Event handler for love.textinput(). + + + skin (element, skin, depth) + Applies skins to elements.

Tables

@@ -108,6 +132,15 @@ mousemoved-todo3 Implement a way for an element to attach itself to love.mousemoved() events? + + mousereleased-todo4 + Figure out how to bring a focused element to the front of view (aka the first element in its parent's children). + (If I do it right here, the for loop above may break! I need to test/figure this out.) +NOTE this might cause an error in the above for loop! + basically, move focused element to front of its parent's child +element.parent\focusChild element +table.insert element.parent, element.parent\removeChild(element), +
@@ -168,7 +201,7 @@ update (dt, element)
- Event handler for love.update() events. + Event handler for love.update().

Parameters:

@@ -191,7 +224,7 @@ draw (element)
- Event handler for love.draw() events. + Event handler for love.draw().

Parameters:

@@ -211,7 +244,7 @@ mousemoved (x, y, dx, dy)
- Event handler for love.mousemoved() events. (*LÖVE >= 0.10.0*) + Event handler for love.mousemoved(). (*LÖVE >= 0.10.0*)

Parameters:

@@ -230,6 +263,182 @@ +

Returns:

+
    + + true / false: Was the event handled? +
+ + + + +
+
+ + mousepressed (x, y, button, element) +
+
+ Event handler for love.mousepressed(). + + +

Parameters:

+ + +

Returns:

+
    + + true / false: Was the event handled? +
+ + + + +
+
+ + mousereleased (x, y, button, element) +
+
+ Event handler for love.mousereleased(). + + +

Parameters:

+ + +

Returns:

+
    +
  1. + true / false: Was a click handled?
    2. +
  2. + true / false: Was a mouse release handled?
    3. +
+ + + + +
+
+ + keypressed (key) +
+
+ Event handler for love.keypressed(). + + +

Parameters:

+ + +

Returns:

+
    + + true / false: Was the event handled? +
+ + + + +
+
+ + keyreleased (key) +
+
+ Event handler for love.keyreleased(). + + +

Parameters:

+ + +

Returns:

+
    + + true / false: Was the event handled? +
+ + + + +
+
+ + textinput (text) +
+
+ Event handler for love.textinput(). + + +

Parameters:

+ + +

Returns:

+
    + + true / false: Was the text input handled? +
+ + + + +
+
+ + skin (element, skin, depth) +
+
+ Applies skins to elements. (*NOTE^: This function will be rewritten and change at some point...) + + +

Parameters:

+ + @@ -320,6 +529,25 @@ +
+
+ + mousereleased-todo4 +
+
+ Figure out how to bring a focused element to the front of view (aka the first element in its parent's children). + (If I do it right here, the for loop above may break! I need to test/figure this out.) +NOTE this might cause an error in the above for loop! + basically, move focused element to front of its parent's child +element.parent\focusChild element +table.insert element.parent, element.parent\removeChild(element), + + + + + + +
@@ -328,7 +556,7 @@
generated by LDoc 1.4.3 -Last updated 2016-06-20 22:28:27 +Last updated 2016-06-21 00:58:10
diff --git a/docs/modules/util.html b/docs/modules/util.html index ab1c953..3ef27ed 100644 --- a/docs/modules/util.html +++ b/docs/modules/util.html @@ -112,7 +112,7 @@
generated by LDoc 1.4.3 -Last updated 2016-06-20 22:28:27 +Last updated 2016-06-21 00:58:10