Skip to content

Commit 04b3e9c

Browse files
oschosch
committed
extending generated documentation
1 parent 65177f8 commit 04b3e9c

72 files changed

Lines changed: 3402 additions & 247 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎doc/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,5 @@
1111

1212
## Reference
1313
* [Module Index](./gen/modules.md) - list of all lwtk modules
14+
* [Style Parameter Index](./gen/styleparams.md) - all style parameters with their default rules and using classes
1415

‎doc/Style.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ objects of type [lwtk.Style].
77

88
*Style* objects contain rule sets for determining the values of named parameters
99
for a widget according to the widget's class name and the widget's state.
10+
All known style parameters are listed in the
11+
[Style Parameter Index](./gen/styleparams.md) with their default rules and
12+
using classes.
1013

1114
<!-- ---------------------------------------------------------------------------------------- -->
1215
## Contents

‎doc/gen/lwtk/Actionable.md‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
## Contents
55

66
* [Inheritance](#inheritance)
7+
* [Constructor](#constructor)
78
* [Methods](#methods)
89
* [handleRemainingInitParams()](#.handleRemainingInitParams)
910
* [hasActionMethod()](#.hasActionMethod)
@@ -12,10 +13,15 @@
1213
* [Subclasses](#subclasses)
1314

1415

15-
## Inheritance
16+
## <a id="inheritance"></a>Inheritance
1617
* / **[Object](../lwtk/Object.md#inheritance)** / _`Actionable`_
1718

18-
## Methods
19+
## <a id="constructor"></a>Constructor
20+
* <span id=".new">**`Actionable:new(initParams)`**</span>
21+
22+
23+
24+
## <a id="methods"></a>Methods
1925
* <span id=".handleRemainingInitParams">**`Actionable:handleRemainingInitParams(initParams)`**</span>
2026

2127

@@ -29,7 +35,7 @@
2935

3036

3137

32-
## Subclasses
38+
## <a id="subclasses"></a>Subclasses
3339
* / **[Object](../lwtk/Object.md#subclasses)** / _`Actionable`_ /
3440
* **[FocusHandler](../lwtk/FocusHandler.md#inheritance)**
3541
* [Node](../lwtk/Node.md#subclasses) / [Drawable](../lwtk/Drawable.md#subclasses) /

‎doc/gen/lwtk/Animatable.md‎

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
## Contents
55

66
* [Inheritance](#inheritance)
7+
* [Constructor](#constructor)
8+
* [Attributes](#attributes)
9+
* [_animationUpdated](#._animationUpdated)
710
* [Methods](#methods)
811
* [animateFrame()](#.animateFrame)
912
* [getStyle()](#.getStyle)
@@ -16,13 +19,23 @@
1619
* [updateAnimation()](#.updateAnimation)
1720
* [_setApp()](#._setApp)
1821
* [_setStyleFromParent()](#._setStyleFromParent)
22+
* [Used Style Parameters](#used-style-parameters)
1923
* [Subclasses](#subclasses)
2024

2125

22-
## Inheritance
26+
## <a id="inheritance"></a>Inheritance
2327
* / **[Object](../lwtk/Object.md#inheritance)** / [Actionable](../lwtk/Actionable.md#inheritance) / [Node](../lwtk/Node.md#inheritance) / [Drawable](../lwtk/Drawable.md#inheritance) / **[Component](../lwtk/Component.md#inheritance)** / [Styleable](../lwtk/Styleable.md#inheritance) / _`Animatable`_
2428

25-
## Methods
29+
## <a id="constructor"></a>Constructor
30+
* <span id=".new">**`Animatable:new(initParams)`**</span>
31+
32+
33+
34+
## <a id="attributes"></a>Attributes
35+
* <span id="._animationUpdated">**`_animationUpdated`**</span> : `boolean`
36+
37+
38+
## <a id="methods"></a>Methods
2639
* <span id=".animateFrame">**`Animatable:animateFrame(newX, newY, newW, newH, isLayoutTransition)`**</span>
2740

2841

@@ -57,7 +70,20 @@
5770

5871

5972

60-
## Subclasses
73+
## <a id="used-style-parameters"></a>Used Style Parameters
74+
75+
See also [lwtk.Style](../lwtk/Style.md), [lwtk.DefaultStyle](../lwtk/DefaultStyle.md) and [lwtk.BuiltinStyleTypes](../lwtk/BuiltinStyleTypes.md) for more information about style parameters.
76+
The [Style Parameter Index](../styleparams.md) lists all style parameters.
77+
78+
The implementation uses the following style parameters:
79+
80+
* `FrameTransitionSeconds`
81+
82+
Style parameters used in super classes:
83+
84+
* **[Component](../lwtk/Component.md#used-style-parameters)**: `Opacity`
85+
86+
## <a id="subclasses"></a>Subclasses
6187
* / **[Object](../lwtk/Object.md#subclasses)** / [Actionable](../lwtk/Actionable.md#subclasses) / [Node](../lwtk/Node.md#subclasses) / [Drawable](../lwtk/Drawable.md#subclasses) / **[Component](../lwtk/Component.md#subclasses)** / [Styleable](../lwtk/Styleable.md#subclasses) / _`Animatable`_ / **[Widget](../lwtk/Widget.md#subclasses)** / [Compound](../lwtk/Compound.md#subclasses) /
6288
* [LayoutFrame](../lwtk/LayoutFrame.md#subclasses) / [Control](../lwtk/Control.md#subclasses) /
6389
* [Focusable](../lwtk/Focusable.md#subclasses) / **[TextInput](../lwtk/TextInput.md#inheritance)**

‎doc/gen/lwtk/Animations.md‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,29 @@
55

66
* [Inheritance](#inheritance)
77
* [Constructor](#constructor)
8+
* [Attributes](#attributes)
9+
* [timer](#.timer)
810
* [Methods](#methods)
911
* [addAnimation()](#.addAnimation)
1012
* [hasActive()](#.hasActive)
1113
* [removeAnimation()](#.removeAnimation)
1214
* [Inherited Methods](#inherited-methods)
15+
* [Inherited Static Members](#inherited-static-members)
1316

1417

15-
## Inheritance
18+
## <a id="inheritance"></a>Inheritance
1619
* / **[Object](../lwtk/Object.md#inheritance)** / _**`Animations`**_
1720

18-
## Constructor
21+
## <a id="constructor"></a>Constructor
1922
* <span id=".new">**`Animations(app)`**</span>
2023

2124

2225

23-
## Methods
26+
## <a id="attributes"></a>Attributes
27+
* <span id=".timer">**`timer`**</span> : [lwtk.Timer](../lwtk/Timer.md)
28+
29+
30+
## <a id="methods"></a>Methods
2431
* <span id=".addAnimation">**`Animations:addAnimation(animatable)`**</span>
2532

2633

@@ -31,6 +38,10 @@
3138

3239

3340

34-
## Inherited Methods
41+
## <a id="inherited-methods"></a>Inherited Methods
3542
* **[Object](../lwtk/Object.md)**:
3643
* [getClass()](../lwtk/Object.md#.getClass), [getClassPath()](../lwtk/Object.md#.getClassPath), [getMember()](../lwtk/Object.md#.getMember), [getReverseClassPath()](../lwtk/Object.md#.getReverseClassPath), [getSuperClass()](../lwtk/Object.md#.getSuperClass), [isInstanceOf()](../lwtk/Object.md#.isInstanceOf), [setAttributes()](../lwtk/Object.md#.setAttributes)
44+
45+
## <a id="inherited-static-members"></a>Inherited Static Members
46+
* **[Object](../lwtk/Object.md)**:
47+
* [declare()](../lwtk/Object.md#.declare), [getMixinBase()](../lwtk/Object.md#.getMixinBase), [newSubClass()](../lwtk/Object.md#.newSubClass)

‎doc/gen/lwtk/Application.md‎

Lines changed: 65 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,26 @@ running within the [LÖVE](https://love2d.org/) 2D game engine.
99

1010
* [Inheritance](#inheritance)
1111
* [Constructor](#constructor)
12+
* [Init Parameters](#init-parameters)
13+
* [Attributes](#attributes)
14+
* [animationTimer](#.animationTimer)
15+
* [appName](#.appName)
16+
* [driver](#.driver)
17+
* [postprocessNeeded](#.postprocessNeeded)
18+
* [scale()](#.scale) - Multiplies the arguments with the *screenScale* factor.
19+
* [timers](#.timers) - list of timers
20+
* [_animations](#._animations)
21+
* [_eventFunc()](#._eventFunc)
22+
* [_hasChanges](#._hasChanges)
23+
* [_processingDeferredChanges](#._processingDeferredChanges)
1224
* [Methods](#methods)
1325
* [addStyle()](#.addStyle)
1426
* [close()](#.close)
1527
* [deferChanges()](#.deferChanges)
1628
* [getCurrentTime()](#.getCurrentTime)
1729
* [getFontInfo()](#.getFontInfo)
1830
* [getLayoutContext()](#.getLayoutContext)
19-
* [getScreenScale()](#.getScreenScale)
31+
* [getScreenScale()](#.getScreenScale) - Returns the *screenScale* factor.
2032
* [hasWindows()](#.hasWindows)
2133
* [newWindow()](#.newWindow)
2234
* [runEventLoop()](#.runEventLoop) - Update by processing events from the window system.
@@ -29,18 +41,60 @@ running within the [LÖVE](https://love2d.org/) 2D game engine.
2941
* [_processAllChanges()](#._processAllChanges)
3042
* [_removeWindow()](#._removeWindow)
3143
* [Inherited Methods](#inherited-methods)
44+
* [Inherited Static Members](#inherited-static-members)
3245
* [Subclasses](#subclasses)
3346

3447

35-
## Inheritance
48+
## <a id="inheritance"></a>Inheritance
3649
* / **[Object](../lwtk/Object.md#inheritance)** / _**`Application`**_
3750

38-
## Constructor
51+
## <a id="constructor"></a>Constructor
3952
* <span id=".new">**`Application(arg1, arg2)`**</span>
4053

4154

4255

43-
## Methods
56+
## <a id="init-parameters"></a>Init Parameters
57+
58+
The following parameters can be given to the constructor; each parameter
59+
is handled by the corresponding setter method:
60+
61+
* `errorFunc` - [setErrorFunc()](#.setErrorFunc)
62+
* `extensions` - [setExtensions()](#.setExtensions)
63+
* `style` - [setStyle()](#.setStyle)
64+
* `timer` - [setTimer()](#.setTimer)
65+
66+
## <a id="attributes"></a>Attributes
67+
* <span id=".animationTimer">**`animationTimer`**</span>
68+
69+
* <span id=".appName">**`appName`**</span>
70+
71+
* <span id=".driver">**`driver`**</span>
72+
73+
* <span id=".postprocessNeeded">**`postprocessNeeded`**</span> : `table`
74+
75+
* <span id=".scale">**`scale(a, a2, a3, a4)`**</span>
76+
77+
Multiplies the arguments with the *screenScale* factor.
78+
79+
Possible invocations:
80+
81+
* *scale(x, y)* - returns the multiplied values
82+
* *scale(x, y, w, h)* - returns the multiplied values
83+
* *scale({x, y})* - multiplies the values in the given table and returns table
84+
* *scale({x, y, w, y})* - multiplies the values in the given table and returns table
85+
* <span id=".timers">**`timers`**</span>
86+
87+
list of timers
88+
* <span id="._animations">**`_animations`**</span> : [lwtk.Animations](../lwtk/Animations.md)
89+
90+
* <span id="._eventFunc">**`_eventFunc(window, view, event, ...)`**</span>
91+
92+
* <span id="._hasChanges">**`_hasChanges`**</span> : `boolean`
93+
94+
* <span id="._processingDeferredChanges">**`_processingDeferredChanges`**</span> : `boolean`
95+
96+
97+
## <a id="methods"></a>Methods
4498
* <span id=".addStyle">**`Application:addStyle(additionalStyle)`**</span>
4599

46100

@@ -61,6 +115,7 @@ running within the [LÖVE](https://love2d.org/) 2D game engine.
61115

62116
* <span id=".getScreenScale">**`Application:getScreenScale()`**</span>
63117

118+
Returns the *screenScale* factor.
64119

65120
* <span id=".hasWindows">**`Application:hasWindows()`**</span>
66121

@@ -118,10 +173,14 @@ running within the [LÖVE](https://love2d.org/) 2D game engine.
118173

119174

120175

121-
## Inherited Methods
176+
## <a id="inherited-methods"></a>Inherited Methods
122177
* **[Object](../lwtk/Object.md)**:
123178
* [getClass()](../lwtk/Object.md#.getClass), [getClassPath()](../lwtk/Object.md#.getClassPath), [getMember()](../lwtk/Object.md#.getMember), [getReverseClassPath()](../lwtk/Object.md#.getReverseClassPath), [getSuperClass()](../lwtk/Object.md#.getSuperClass), [isInstanceOf()](../lwtk/Object.md#.isInstanceOf), [setAttributes()](../lwtk/Object.md#.setAttributes)
124179

125-
## Subclasses
180+
## <a id="inherited-static-members"></a>Inherited Static Members
181+
* **[Object](../lwtk/Object.md)**:
182+
* [declare()](../lwtk/Object.md#.declare), [getMixinBase()](../lwtk/Object.md#.getMixinBase), [newSubClass()](../lwtk/Object.md#.newSubClass)
183+
184+
## <a id="subclasses"></a>Subclasses
126185
* / **[Object](../lwtk/Object.md#subclasses)** / _**`Application`**_ / [Node](../lwtk/Node.md#subclasses) / [MouseDispatcher](../lwtk/MouseDispatcher.md#subclasses) / **[love.Application](../lwtk/love/Application.md#inheritance)**
127186

‎doc/gen/lwtk/Area.md‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ A list of rectangle coordinates forming an area.
66

77
* [Inheritance](#inheritance)
88
* [Constructor](#constructor)
9+
* [Attributes](#attributes)
10+
* [count](#.count) - number of rectangles in the area
911
* [Methods](#methods)
1012
* [addRect()](#.addRect) - Adds the rectangle coordinates to the area.
1113
* [clear()](#.clear) - Clears all rectangle coordinates.
@@ -15,18 +17,24 @@ A list of rectangle coordinates forming an area.
1517
* [isWithin()](#.isWithin) - Returns *true* if the given rectangle coordinates are within the area.
1618
* [iteration()](#.iteration) - Iterate through all rectangle coordinates.
1719
* [Inherited Methods](#inherited-methods)
20+
* [Inherited Static Members](#inherited-static-members)
1821

1922

20-
## Inheritance
23+
## <a id="inheritance"></a>Inheritance
2124
* / **[Object](../lwtk/Object.md#inheritance)** / _**`Area`**_
2225

23-
## Constructor
26+
## <a id="constructor"></a>Constructor
2427
* <span id=".new">**`Area()`**</span>
2528

2629
Creates an empty area object.
2730

2831

29-
## Methods
32+
## <a id="attributes"></a>Attributes
33+
* <span id=".count">**`count`**</span> : `number`
34+
35+
number of rectangles in the area
36+
37+
## <a id="methods"></a>Methods
3038
* <span id=".addRect">**`Area:addRect(x, y, w, h)`**</span>
3139

3240
Adds the rectangle coordinates to the area.
@@ -68,6 +76,10 @@ A list of rectangle coordinates forming an area.
6876
will iterate over all rectangle indices and coordinates.
6977

7078

71-
## Inherited Methods
79+
## <a id="inherited-methods"></a>Inherited Methods
7280
* **[Object](../lwtk/Object.md)**:
7381
* [getClass()](../lwtk/Object.md#.getClass), [getClassPath()](../lwtk/Object.md#.getClassPath), [getMember()](../lwtk/Object.md#.getMember), [getReverseClassPath()](../lwtk/Object.md#.getReverseClassPath), [getSuperClass()](../lwtk/Object.md#.getSuperClass), [isInstanceOf()](../lwtk/Object.md#.isInstanceOf), [setAttributes()](../lwtk/Object.md#.setAttributes)
82+
83+
## <a id="inherited-static-members"></a>Inherited Static Members
84+
* **[Object](../lwtk/Object.md)**:
85+
* [declare()](../lwtk/Object.md#.declare), [getMixinBase()](../lwtk/Object.md#.getMixinBase), [newSubClass()](../lwtk/Object.md#.newSubClass)

0 commit comments

Comments
 (0)