Updated docs
There is still stuff to do
This commit is contained in:
28
docs/objects/Menubar/addItem.md
Normal file
28
docs/objects/Menubar/addItem.md
Normal file
@@ -0,0 +1,28 @@
|
||||
## addItem
|
||||
Adds a item into the list
|
||||
|
||||
#### Parameters:
|
||||
1. `string` The entry name
|
||||
2. `number|color` unique default background color - optional
|
||||
3. `number|color` unique default text color - optional
|
||||
4. `any` any value - you could access this later in a :onChange() event (you need to use :getValue()) - optional
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Creates a default menubar with 3 entries
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aMenubar = mainFrame:addMenubar()
|
||||
:addItem("1. Entry")
|
||||
:addItem("2. Entry",colors.yellow)
|
||||
:addItem("3. Entry",colors.yellow,colors.green)
|
||||
```
|
||||
```xml
|
||||
<menubar>
|
||||
<item><text>1. Entry</text></item>
|
||||
<item><text>2. Entry</text><bg>yellow</bg></item>
|
||||
<item><text>3. Entry</text><bg>yellow</bg><fg>green</fg></item>
|
||||
</menubar>
|
||||
```
|
||||
16
docs/objects/Menubar/clear.md
Normal file
16
docs/objects/Menubar/clear.md
Normal file
@@ -0,0 +1,16 @@
|
||||
## clear
|
||||
Removes all items.
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Creates a default menubar with 3 entries and removes them immediatley. Which makes no sense.
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aMenubar = mainFrame:addMenubar()
|
||||
:addItem("1. Entry")
|
||||
:addItem("2. Entry",colors.yellow)
|
||||
:addItem("3. Entry",colors.yellow,colors.green)
|
||||
aMenubar:clear()
|
||||
```
|
||||
23
docs/objects/Menubar/editItem.md
Normal file
23
docs/objects/Menubar/editItem.md
Normal file
@@ -0,0 +1,23 @@
|
||||
## editItem
|
||||
Edits a item from the menubar
|
||||
|
||||
#### Parameters:
|
||||
1. `number` The index which should be edited
|
||||
2. `string` The new item name
|
||||
3. `number` the new item background color - optional
|
||||
4. `number` The new item text color - optional
|
||||
5. `any` New additional information - optional
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Creates a default menubar with 3 entries and edits the second one.
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aMenubar = mainFrame:addMenubar()
|
||||
:addItem("1. Entry")
|
||||
:addItem("2. Entry",colors.yellow)
|
||||
:addItem("3. Entry",colors.yellow,colors.green)
|
||||
aMenubar:editItem(2, "Still 2. Entry", colors.red)
|
||||
```
|
||||
16
docs/objects/Menubar/getAll.md
Normal file
16
docs/objects/Menubar/getAll.md
Normal file
@@ -0,0 +1,16 @@
|
||||
## getAll
|
||||
Returns all items as table
|
||||
|
||||
#### Returns:
|
||||
1. `table` All items
|
||||
|
||||
#### Usage:
|
||||
* Creates a default menubar with 3 entries and prints a table.
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aMenubar = mainFrame:addMenubar()
|
||||
:addItem("1. Entry")
|
||||
:addItem("2. Entry",colors.yellow)
|
||||
:addItem("3. Entry",colors.yellow,colors.green)
|
||||
basalt.debug(aMenubar:getAll())
|
||||
```
|
||||
19
docs/objects/Menubar/getItem.md
Normal file
19
docs/objects/Menubar/getItem.md
Normal file
@@ -0,0 +1,19 @@
|
||||
## getItem
|
||||
Returns a item by index
|
||||
|
||||
#### Parameters:
|
||||
1. `number` The index which should be returned
|
||||
|
||||
#### Returns:
|
||||
1. `table` The item table example: {text="1. Entry", bgCol=colors.black, fgCol=colors.white}
|
||||
|
||||
#### Usage:
|
||||
* Creates a default menubar with 3 entries and edits the second one.
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aMenubar = mainFrame:addMeubar()
|
||||
:addItem("1. Entry")
|
||||
:addItem("2. Entry",colors.yellow)
|
||||
:addItem("3. Entry",colors.yellow,colors.green)
|
||||
basalt.debug(aMenubar:getItem(2).text)
|
||||
```
|
||||
16
docs/objects/Menubar/getItemCount.md
Normal file
16
docs/objects/Menubar/getItemCount.md
Normal file
@@ -0,0 +1,16 @@
|
||||
## getItemCount
|
||||
Returns the current item count
|
||||
|
||||
#### Returns:
|
||||
1. `number` The item list count
|
||||
|
||||
#### Usage:
|
||||
* Creates a default menubar with 3 entries and prints the current item count.
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aMenubar = mainFrame:addMenubar()
|
||||
:addItem("1. Entry")
|
||||
:addItem("2. Entry",colors.yellow)
|
||||
:addItem("3. Entry",colors.yellow,colors.green)
|
||||
basalt.debug(aMenubar:getItemCount())
|
||||
```
|
||||
17
docs/objects/Menubar/getItemIndex.md
Normal file
17
docs/objects/Menubar/getItemIndex.md
Normal file
@@ -0,0 +1,17 @@
|
||||
## getItemIndex
|
||||
returns the item index of the currently selected item
|
||||
|
||||
#### Returns:
|
||||
1. `number` The current index
|
||||
|
||||
#### Usage:
|
||||
* Creates a default menubar with 3 entries selects the second entry and prints the currently selected index.
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aMenubar = mainFrame:addMenubar()
|
||||
:addItem("1. Entry")
|
||||
:addItem("2. Entry",colors.yellow)
|
||||
:addItem("3. Entry",colors.yellow,colors.green)
|
||||
:selectItem(2)
|
||||
basalt.debug(aMenubar:getItemIndex())
|
||||
```
|
||||
22
docs/objects/Menubar/getOffset.md
Normal file
22
docs/objects/Menubar/getOffset.md
Normal file
@@ -0,0 +1,22 @@
|
||||
## getOffset
|
||||
Returns the current index offset
|
||||
|
||||
#### Returns:
|
||||
1. `number` offset value
|
||||
|
||||
#### Usage:
|
||||
* Creates a default menubar with 6 entries and sets the offset to 3, also prints the current offset.
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aMenubar = mainFrame:addMenubar()
|
||||
:addItem("1. Entry")
|
||||
:addItem("2. Entry")
|
||||
:addItem("3. Entry")
|
||||
:addItem("4. Entry")
|
||||
:addItem("5. Entry")
|
||||
:addItem("6. Entry")
|
||||
:addItem("7. Entry")
|
||||
:addItem("8. Entry")
|
||||
:setOffset(3)
|
||||
basalt.debug(aMenubar:getOffset())
|
||||
```
|
||||
19
docs/objects/Menubar/removeItem.md
Normal file
19
docs/objects/Menubar/removeItem.md
Normal file
@@ -0,0 +1,19 @@
|
||||
## removeItem
|
||||
Removes a item from the menubar
|
||||
|
||||
#### Parameters:
|
||||
1. `number` The index which should get removed
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Creates a default menubar with 3 entries and removes the second one.
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aMenubar = mainFrame:addMenubar()
|
||||
:addItem("1. Entry")
|
||||
:addItem("2. Entry",colors.yellow)
|
||||
:addItem("3. Entry",colors.yellow,colors.green)
|
||||
:removeItem(2)
|
||||
```
|
||||
19
docs/objects/Menubar/selectItem.md
Normal file
19
docs/objects/Menubar/selectItem.md
Normal file
@@ -0,0 +1,19 @@
|
||||
## selectItem
|
||||
selects a item in the menubar (same as a player would click on a item)
|
||||
|
||||
#### Parameters:
|
||||
1. `number` The index which should get selected
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Creates a default menubar with 3 entries and selects the second entry.
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aMenubar = mainFrame:addMenubar()
|
||||
:addItem("1. Entry")
|
||||
:addItem("2. Entry",colors.yellow)
|
||||
:addItem("3. Entry",colors.yellow,colors.green)
|
||||
:selectItem(2)
|
||||
```
|
||||
32
docs/objects/Menubar/setOffset.md
Normal file
32
docs/objects/Menubar/setOffset.md
Normal file
@@ -0,0 +1,32 @@
|
||||
## setOffset
|
||||
Sets the offset of the menubar (the same as you would scroll) - default is 0
|
||||
|
||||
#### Parameters:
|
||||
1. `number` The offset value
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Creates a default menubar with 6 entries and sets the offset to 3.
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aMenubar = mainFrame:addMenubar()
|
||||
:addItem("1. Entry")
|
||||
:addItem("2. Entry")
|
||||
:addItem("3. Entry")
|
||||
:addItem("4. Entry")
|
||||
:addItem("5. Entry")
|
||||
:addItem("6. Entry")
|
||||
:setOffset(3)
|
||||
```
|
||||
```xml
|
||||
<menubar offset="3">
|
||||
<item><text>1. Entry</text></item>
|
||||
<item><text>2. Entry</text></item>
|
||||
<item><text>3. Entry</text></item>
|
||||
<item><text>4. Entry</text></item>
|
||||
<item><text>5. Entry</text></item>
|
||||
<item><text>6. Entry</text></item>
|
||||
</menubar>
|
||||
```
|
||||
38
docs/objects/Menubar/setScrollable.md
Normal file
38
docs/objects/Menubar/setScrollable.md
Normal file
@@ -0,0 +1,38 @@
|
||||
## setScrollable
|
||||
Makes it possible to scroll while the mouse is over the menubar
|
||||
|
||||
#### Parameters:
|
||||
1. `boolean` If the menubar should be scrollable or not
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Creates a new menubar and makes it scrollable
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aMenubar = mainFrame:addMenubar():setScrollable(true)
|
||||
:addItem("1. Entry")
|
||||
:addItem("2. Entry")
|
||||
:addItem("3. Entry")
|
||||
:addItem("4. Entry")
|
||||
:addItem("5. Entry")
|
||||
:addItem("6. Entry")
|
||||
:addItem("7. Entry")
|
||||
:addItem("8. Entry")
|
||||
:addItem("9. Entry")
|
||||
|
||||
```
|
||||
```xml
|
||||
<menubar scrollable="true">
|
||||
<item><text>1. Entry</text></item>
|
||||
<item><text>2. Entry</text></item>
|
||||
<item><text>3. Entry</text></item>
|
||||
<item><text>4. Entry</text></item>
|
||||
<item><text>5. Entry</text></item>
|
||||
<item><text>6. Entry</text></item>
|
||||
<item><text>7. Entry</text></item>
|
||||
<item><text>8. Entry</text></item>
|
||||
<item><text>9. Entry</text></item>
|
||||
</menubar>
|
||||
```
|
||||
28
docs/objects/Menubar/setSelectedItem.md
Normal file
28
docs/objects/Menubar/setSelectedItem.md
Normal file
@@ -0,0 +1,28 @@
|
||||
## setSelectedItem
|
||||
Sets the background and the foreground of the item which is currently selected
|
||||
|
||||
#### Parameters:
|
||||
1. `number|color` The background color which should be used
|
||||
2. `number|color` The text color which should be used
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Creates a default menubar with 4 entries and sets the selection background color to green.
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aMenubar = mainFrame:addMenubar()
|
||||
:addItem("1. Entry")
|
||||
:addItem("2. Entry",colors.yellow)
|
||||
:addItem("3. Entry",colors.yellow,colors.green)
|
||||
:addItem("4. Entry")
|
||||
:setSelectedItem(colors.green, colors.red)
|
||||
```
|
||||
```xml
|
||||
<menubar selectionBG="green" selectionFG="red">
|
||||
<item><text>1. Entry</text></item>
|
||||
<item><text>2. Entry</text><bg>yellow</bg></item>
|
||||
<item><text>2. Entry</text><bg>yellow</bg><fg>green</fg></item>
|
||||
</menubar>
|
||||
```
|
||||
Reference in New Issue
Block a user