From 3044f8f97f11781ae9c7d1a2fff8590593081022 Mon Sep 17 00:00:00 2001 From: tourahi Date: Sun, 14 Jan 2024 01:21:15 +0100 Subject: [PATCH] Rem modules Docs. --- docs/modules/Button.html | 794 ------------------ docs/modules/Chrono.html | 79 -- docs/modules/Controls.Button.html | 503 ----------- docs/modules/Controls.CheckBox.html | 97 --- docs/modules/Controls.Label.html | 97 --- docs/modules/MeowUI.html | 101 --- docs/modules/Mutf8.html | 125 --- docs/modules/Utils.html | 80 -- docs/modules/ldtkLove.html | 84 -- docs/modules/src.Core.Mutf8.html | 88 -- .../src.ThirdParty.utf8.primitives.dummy.html | 106 --- .../src.ThirdParty.utf8.test.strict.html | 92 -- .../src.ThirdParty.utf8.test.test_pm.html | 108 --- 13 files changed, 2354 deletions(-) delete mode 100644 docs/modules/Button.html delete mode 100644 docs/modules/Chrono.html delete mode 100644 docs/modules/Controls.Button.html delete mode 100644 docs/modules/Controls.CheckBox.html delete mode 100644 docs/modules/Controls.Label.html delete mode 100644 docs/modules/MeowUI.html delete mode 100644 docs/modules/Mutf8.html delete mode 100644 docs/modules/Utils.html delete mode 100644 docs/modules/ldtkLove.html delete mode 100644 docs/modules/src.Core.Mutf8.html delete mode 100644 docs/modules/src.ThirdParty.utf8.primitives.dummy.html delete mode 100644 docs/modules/src.ThirdParty.utf8.test.strict.html delete mode 100644 docs/modules/src.ThirdParty.utf8.test.test_pm.html diff --git a/docs/modules/Button.html b/docs/modules/Button.html deleted file mode 100644 index 454d336..0000000 --- a/docs/modules/Button.html +++ /dev/null @@ -1,794 +0,0 @@ - - - - - MeowUI documentation - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module Button

-

A button class

-

- -

-

Usage:

-
    - 
    b = Button!
-
    -
- - -

Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
new (type)constructor.
onClick (cb)sets the onClick callback.
onHover (cb)sets the onHover callback.
onLeave (cb)sets the onLeave callback.
onAfterClick (cb)sets the onAfterClick callback.
setText (text)sets button text.
setDynamicPadding (p)sets dynamic padding.
setDynamicSize (bool)sets dynamic size (Grows with the text).
setUpColor (color)sets upColor.
setDownColor (color)sets downColor.
setHoverColor (color)sets hoverColor.
setDisableColor (color)sets DisableColor.
setStroke (s)sets the stroke (Border line width).
getStroke ()gets stroke
setFontColor (color)sets the text font color.
setFontSize (size)sets the text font size.
getFontSize ()gets the font size.
setImage (image, conform, bx, by)sets button image
setImageBorder (bx, by)sets the image border
setAlphaDown (a)sets alpha for when the button is down.
setAlphaHover (a)sets alpha for when the button is hovred.
setAlphaEnable (a)sets alpha for when the button is enabled.
setCorners (rx, ry)sets corners sharpness.
setScale (x, y)sets the scale.
setDepth (depth)sets the depth.
- -
-
- - -

Functions

- -
-
- - new (type) -
-
- constructor. - - -

Parameters:

-
    -
  • type - string - Bounding box type[Box, Circle, Polygon] -
    • -
- - - - - -
-
- - onClick (cb) -
-
- sets the onClick callback. - - -

Parameters:

-
    -
  • cb - function - - - -
    • -
- - - - - -
-
- - onHover (cb) -
-
- sets the onHover callback. - - -

Parameters:

-
    -
  • cb - function - - - -
    • -
- - - - - -
-
- - onLeave (cb) -
-
- sets the onLeave callback. - - -

Parameters:

-
    -
  • cb - function - - - -
    • -
- - - - - -
-
- - onAfterClick (cb) -
-
- sets the onAfterClick callback. - - -

Parameters:

-
    -
  • cb - function - - - -
    • -
- - - - - -
-
- - setText (text) -
-
- sets button text. - - -

Parameters:

- - - - - - -
-
- - setDynamicPadding (p) -
-
- sets dynamic padding. - - -

Parameters:

-
    -
  • p - number - - - -
    • -
- - - - - -
-
- - setDynamicSize (bool) -
-
- sets dynamic size (Grows with the text). - - -

Parameters:

-
    -
  • bool - boolean - - - -
    • -
- - - - - -
-
- - setUpColor (color) -
-
- sets upColor. - - -

Parameters:

-
    -
  • color - table - - - -
    • -
- - - - - -
-
- - setDownColor (color) -
-
- sets downColor. - - -

Parameters:

-
    -
  • color - table - - - -
    • -
- - - - - -
-
- - setHoverColor (color) -
-
- sets hoverColor. - - -

Parameters:

-
    -
  • color - table - - - -
    • -
- - - - - -
-
- - setDisableColor (color) -
-
- sets DisableColor. - - -

Parameters:

-
    -
  • color - table - - - -
    • -
- - - - - -
-
- - setStroke (s) -
-
- sets the stroke (Border line width). - - -

Parameters:

-
    -
  • s - - - -
    • -
- - - - - -
-
- - getStroke () -
-
- gets stroke - - - -

Returns:

-
    - - number - stroke -
- - - - -
-
- - setFontColor (color) -
-
- sets the text font color. - - -

Parameters:

-
    -
  • color - table - - - -
    • -
- - - - - -
-
- - setFontSize (size) -
-
- sets the text font size. - - -

Parameters:

-
    -
  • size - number - - - -
    • -
- - - - - -
-
- - getFontSize () -
-
- gets the font size. - - - -

Returns:

-
    - - number - fsize -
- - - - -
-
- - setImage (image, conform, bx, by) -
-
- sets button image - - -

Parameters:

-
    -
  • image - string - (path) -
    • -
  • conform - boolean - (Give the Bbox the same size as the image). -
    • -
  • bx - number - (Image border x) -
    • -
  • by - number - (Image border x) -
    • -
- - - - - -
-
- - setImageBorder (bx, by) -
-
- sets the image border - - -

Parameters:

-
    -
  • bx - number - - - -
    • -
  • by - number - - - -
    • -
- - - - - -
-
- - setAlphaDown (a) -
-
- sets alpha for when the button is down. - - -

Parameters:

-
    -
  • a - number - - - -
    • -
- - - - - -
-
- - setAlphaHover (a) -
-
- sets alpha for when the button is hovred. - - -

Parameters:

-
    -
  • a - number - - - -
    • -
- - - - - -
-
- - setAlphaEnable (a) -
-
- sets alpha for when the button is enabled. - - -

Parameters:

-
    -
  • a - number - - - -
    • -
- - - - - -
-
- - setCorners (rx, ry) -
-
- sets corners sharpness. - - -

Parameters:

-
    -
  • rx - number - - - -
    • -
  • ry - number - - - -
    • -
- - - - - -
-
- - setScale (x, y) -
-
- sets the scale. - - -

Parameters:

-
    -
  • x - number - - - -
    • -
  • y - number - - - -
    • -
- - - - - -
-
- - setDepth (depth) -
-
- sets the depth. - - -

Parameters:

-
    -
  • depth - number - - - -
    • -
- - - - - -
-
- - -
-
-
-generated by LDoc 1.4.6 -Last updated 2022-03-05 19:03:38 -
-
- - diff --git a/docs/modules/Chrono.html b/docs/modules/Chrono.html deleted file mode 100644 index 0e99473..0000000 --- a/docs/modules/Chrono.html +++ /dev/null @@ -1,79 +0,0 @@ - - - - - MeowUI documentation - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module Chrono

-

A Utils module

-

- -

- - - -
-
- - - - -
-
-
-generated by LDoc 1.4.6 -Last updated 2022-01-27 02:12:26 -
-
- - diff --git a/docs/modules/Controls.Button.html b/docs/modules/Controls.Button.html deleted file mode 100644 index f5ab74d..0000000 --- a/docs/modules/Controls.Button.html +++ /dev/null @@ -1,503 +0,0 @@ - - - - - MeowUI documentation - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module Controls.Button

-

A button class (An example that you can use or build on.)

-

- -

-

Usage:

-
    - 
    b = Button!
-
    -
- - -

Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
new (type)constructor.
setText (text)sets button text.
setDynamicPadding (p)sets dynamic padding.
setDynamicSize (bool)sets dynamic size (Grows with the text).
setStroke (s)sets the stroke (Border line width).
getStroke ()gets stroke
setFontSize (size)sets the text font size.
getFontSize ()gets the font size.
setImage (image, conform, bx, by)sets button image
setImageBorder (bx, by)sets the image border
setCorners (rx, ry)sets corners sharpness.
setScale (x, y)sets the scale.
setDepth (depth)sets the depth.
setBorderLineStyle (smooth)sets the borderLineStyle.
- -
-
- - -

Functions

- -
-
- - new (type) -
-
- constructor. - - -

Parameters:

-
    -
  • type - string - Bounding box type[Box, Circle, Polygon] -
    • -
- - - - - -
-
- - setText (text) -
-
- sets button text. - - -

Parameters:

- - - - - - -
-
- - setDynamicPadding (p) -
-
- sets dynamic padding. - - -

Parameters:

-
    -
  • p - number - - - -
    • -
- - - - - -
-
- - setDynamicSize (bool) -
-
- sets dynamic size (Grows with the text). - - -

Parameters:

-
    -
  • bool - boolean - - - -
    • -
- - - - - -
-
- - setStroke (s) -
-
- sets the stroke (Border line width). - - -

Parameters:

-
    -
  • s - - - -
    • -
- - - - - -
-
- - getStroke () -
-
- gets stroke - - - -

Returns:

-
    - - number - stroke -
- - - - -
-
- - setFontSize (size) -
-
- sets the text font size. - - -

Parameters:

-
    -
  • size - number - - - -
    • -
- - - - - -
-
- - getFontSize () -
-
- gets the font size. - - - -

Returns:

-
    - - number - fsize -
- - - - -
-
- - setImage (image, conform, bx, by) -
-
- sets button image - - -

Parameters:

-
    -
  • image - string - (path) -
    • -
  • conform - boolean - (Give the Bbox the same size as the image). -
    • -
  • bx - number - (Image border x) -
    • -
  • by - number - (Image border x) -
    • -
- - - - - -
-
- - setImageBorder (bx, by) -
-
- sets the image border - - -

Parameters:

-
    -
  • bx - number - - - -
    • -
  • by - number - - - -
    • -
- - - - - -
-
- - setCorners (rx, ry) -
-
- sets corners sharpness. - - -

Parameters:

-
    -
  • rx - number - - - -
    • -
  • ry - number - - - -
    • -
- - - - - -
-
- - setScale (x, y) -
-
- sets the scale. - - -

Parameters:

-
    -
  • x - number - - - -
    • -
  • y - number - - - -
    • -
- - - - - -
-
- - setDepth (depth) -
-
- sets the depth. - - -

Parameters:

-
    -
  • depth - number - - - -
    • -
- - - - - -
-
- - setBorderLineStyle (smooth) -
-
- sets the borderLineStyle. - - -

Parameters:

- - - - - - -
-
- - -
-
-
-generated by LDoc 1.5.0 -Last updated 2024-01-14 01:18:20 -
-
- - diff --git a/docs/modules/Controls.CheckBox.html b/docs/modules/Controls.CheckBox.html deleted file mode 100644 index 7e1ea90..0000000 --- a/docs/modules/Controls.CheckBox.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - MeowUI documentation - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module Controls.CheckBox

-

CheckBox class (An example that you can use or build on.)

-

- -

-

Usage:

-
    - 
    c = CheckBox!
-
    -
- - - -
-
- - - - -
-
-
-generated by LDoc 1.5.0 -Last updated 2024-01-14 01:18:20 -
-
- - diff --git a/docs/modules/Controls.Label.html b/docs/modules/Controls.Label.html deleted file mode 100644 index 2c1f724..0000000 --- a/docs/modules/Controls.Label.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - MeowUI documentation - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module Controls.Label

-

Label class

-

- -

-

Usage:

-
    - 
    l = Label!
-
    -
- - - -
-
- - - - -
-
-
-generated by LDoc 1.5.0 -Last updated 2024-01-14 01:18:20 -
-
- - diff --git a/docs/modules/MeowUI.html b/docs/modules/MeowUI.html deleted file mode 100644 index cf20b74..0000000 --- a/docs/modules/MeowUI.html +++ /dev/null @@ -1,101 +0,0 @@ - - - - - MeowUI documentation - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module MeowUI

-

A useful set of core classes that help you make an extensible set of UI controls.

-

- -

    -
  • This GUI framework is an improved version of catui (https://github.com/wilhantian/catui)
    • -
  • Credit : wilhantian (https://github.com/wilhantian)
    • -
-

-

Info:

-
    -
  • License: TODO
    • -
  • Author: Tourahi Amine (tourahi.amine@gmail.com)
    • -
- - - -
-
- - - - -
-
-
-generated by LDoc 1.5.0 -Last updated 2024-01-14 01:18:20 -
-
- - diff --git a/docs/modules/Mutf8.html b/docs/modules/Mutf8.html deleted file mode 100644 index f05aa72..0000000 --- a/docs/modules/Mutf8.html +++ /dev/null @@ -1,125 +0,0 @@ - - - - - MeowUI documentation - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module Mutf8

-

Adds UTF-8 functions to string lua table.

-

- -

- - -

Functions

- - - - - -
string ()refs - https://www.utf8-chartable.de/unicode-utf8-table.pl?number=1024&utf8=dec - https://en.wikipedia.org/wiki/UTF-8
- -
-
- - -

Functions

- -
-
- - string () -
-
- refs - https://www.utf8-chartable.de/unicode-utf8-table.pl?number=1024&utf8=dec - https://en.wikipedia.org/wiki/UTF-8 - - - - - - - -
-
- - -
-
-
-generated by LDoc 1.5.0 -Last updated 2024-01-14 01:18:20 -
-
- - diff --git a/docs/modules/Utils.html b/docs/modules/Utils.html deleted file mode 100644 index 52faaa2..0000000 --- a/docs/modules/Utils.html +++ /dev/null @@ -1,80 +0,0 @@ - - - - - MeowUI documentation - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module Utils

-

A Utils module

-

- -

- - - -
-
- - - - -
-
-
-generated by LDoc 1.4.6 -Last updated 2022-01-28 00:25:15 -
-
- - diff --git a/docs/modules/ldtkLove.html b/docs/modules/ldtkLove.html deleted file mode 100644 index ef2566c..0000000 --- a/docs/modules/ldtkLove.html +++ /dev/null @@ -1,84 +0,0 @@ - - - - - MeowUI documentation - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module ldtkLove

-

A useful set of core classes that help you make an extensible set of UI controls.

-

- -

    -
  • This GUI framework is an improved version of catui (https://github.com/wilhantian/catui)
    • -
  • Credit : wilhantian (https://github.com/wilhantian)
    • -
-

-

Info:

-
    -
  • License: TODO
    • -
  • Author: Tourahi Amine (tourahi.amine@gmail.com)
    • -
- - - -
-
- - - - -
-
-
-generated by LDoc 1.4.6 -Last updated 2022-01-26 15:51:17 -
-
- - diff --git a/docs/modules/src.Core.Mutf8.html b/docs/modules/src.Core.Mutf8.html deleted file mode 100644 index 56ea58d..0000000 --- a/docs/modules/src.Core.Mutf8.html +++ /dev/null @@ -1,88 +0,0 @@ - - - - - MeowUI documentation - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module src.Core.Mutf8

-

Adds UTF-8 functions to string - ref: https://datatracker.ietf.org/doc/html/draft-yergeau-rfc2279bis-05 - ref: https://www.utf8-chartable.de/unicode-utf8-table.pl?number=1024&utf8=dec - [[--

-

- -

- - - -
-
- - - - -
-
-
-generated by LDoc 1.4.6 -Last updated 2022-03-19 21:07:06 -
-
- - diff --git a/docs/modules/src.ThirdParty.utf8.primitives.dummy.html b/docs/modules/src.ThirdParty.utf8.primitives.dummy.html deleted file mode 100644 index 6ac4c6c..0000000 --- a/docs/modules/src.ThirdParty.utf8.primitives.dummy.html +++ /dev/null @@ -1,106 +0,0 @@ - - - - - MeowUI documentation - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module src.ThirdParty.utf8.primitives.dummy

-

differs from Lua 5.3 utf8.offset in accepting any byte positions (not only head byte) for all n values

-

h - head, c - continuation, t - tail -hhhccthccthccthcthhh

- -
-^ start byte pos
-
- -

searching current charracter head by moving backwards -hhhccthccthccthcthhh

- -
-^ head
-
- -

n == 0: current position -n > 0: n jumps forward -n < 0: n more scans backwards

- - - -
-
- - - - -
-
-
-generated by LDoc 1.5.0 -Last updated 2024-01-14 01:18:20 -
-
- - diff --git a/docs/modules/src.ThirdParty.utf8.test.strict.html b/docs/modules/src.ThirdParty.utf8.test.strict.html deleted file mode 100644 index f82ef45..0000000 --- a/docs/modules/src.ThirdParty.utf8.test.strict.html +++ /dev/null @@ -1,92 +0,0 @@ - - - - - MeowUI documentation - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module src.ThirdParty.utf8.test.strict

-

strict.lua from http://metalua.luaforge.net/src/lib/strict.lua.html

-

- -

- - - -
-
- - - - -
-
-
-generated by LDoc 1.5.0 -Last updated 2024-01-14 01:18:20 -
-
- - diff --git a/docs/modules/src.ThirdParty.utf8.test.test_pm.html b/docs/modules/src.ThirdParty.utf8.test.test_pm.html deleted file mode 100644 index 6c5d656..0000000 --- a/docs/modules/src.ThirdParty.utf8.test.test_pm.html +++ /dev/null @@ -1,108 +0,0 @@ - - - - - MeowUI documentation - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Module src.ThirdParty.utf8.test.test_pm

-

MIT License

- -

Copyright (c) 2018 Xavier Wang

- -

Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions:

- -

The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software.

-

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE.

- - - -
-
- - - - -
-
-
-generated by LDoc 1.5.0 -Last updated 2024-01-14 01:18:20 -
-
- -