mirror of
https://github.com/keharriso/love-nuklear.git
synced 2025-09-10 16:17:47 -04:00
Updated Documentation (markdown)
Kevin Harrison
parent
23906d3b21
commit
e19350880e
1 changed files with 446 additions and 32 deletions
478
Documentation.md
478
Documentation.md
|
|
@ -283,8 +283,8 @@ Return `true` if the context menu is open, and `false` otherwise.
|
|||
|
||||
#### activated = nk.contextual_item(text)
|
||||
#### activated = nk.contextual_item(text, symbol/image)
|
||||
#### activated = nk.contextual_item(text, symbol/image, align)
|
||||
Add an item to a context menu. Optionally specify a symbol type, image, and/or alignment.
|
||||
#### activated = nk.contextual_item(text, symbol/image, [align](#alignment))
|
||||
Add an item to a context menu. Optionally specify a symbol type, image, and/or [alignment](#alignment).
|
||||
|
||||
Return `true` if the item is activated, and `false` otherwise.
|
||||
|
||||
|
|
@ -320,8 +320,8 @@ Start a menu bar. Menu bars stay at the top of a window even when scrolling. Cal
|
|||
Ends a menu bar. Always call this at the end of a menu bar started with `nk.menubar_begin`.
|
||||
|
||||
#### open = nk.menu_begin(title, symbol/image, width, height)
|
||||
#### open = nk.menu_begin(title, symbol/image, width, height, align)
|
||||
Start a menu of the given title and size. Optionally specify a symbol, image, and/or alignment.
|
||||
#### open = nk.menu_begin(title, symbol/image, width, height, [align](#alignment))
|
||||
Start a menu of the given title and size. Optionally specify a symbol, image, and/or [alignment](#alignment).
|
||||
|
||||
Return `true` if the menu is open, and `false` otherwise.
|
||||
|
||||
|
|
@ -329,8 +329,8 @@ Be sure to call `nk.menu_end` when ending open menus.
|
|||
|
||||
#### activated = nk.menu_item(title)
|
||||
#### activated = nk.menu_item(title, symbol/image)
|
||||
#### activated = nk.menu_item(title, symbol/image, align)
|
||||
Add a menu item to the current menu. Optionally specify a symbol, image, and/or alignment.
|
||||
#### activated = nk.menu_item(title, symbol/image, [align](#alignment))
|
||||
Add a menu item to the current menu. Optionally specify a symbol, image, and/or [alignment](#alignment).
|
||||
|
||||
Return `true` if the menu item is activated, and `false` otherwise.
|
||||
|
||||
|
|
@ -343,9 +343,9 @@ End the current menu. Always call this at the end of any open menu.
|
|||
### General
|
||||
|
||||
#### nk.label(text)
|
||||
#### nk.label(text, align/'wrap')
|
||||
#### nk.label(text, align/'wrap', [color](#colors))
|
||||
Show a text string. Optionally specify an alignment and/or [color](#colors).
|
||||
#### nk.label(text, [align](#alignment)/'wrap')
|
||||
#### nk.label(text, [align](#alignment)/'wrap', [color](#colors))
|
||||
Show a text string. Optionally specify an [alignment](#alignment) and/or [color](#colors).
|
||||
|
||||
#### nk.image(img)
|
||||
Show an image.
|
||||
|
|
@ -381,11 +381,11 @@ If called with a string `selection`, the function returns the new `selection`, w
|
|||
|
||||
#### selected = nk.selectable(text, selected)
|
||||
#### selected = nk.selectable(text, image, selected)
|
||||
#### selected = nk.selectable(text, image, align, selected)
|
||||
#### selected = nk.selectable(text, image, [align](#alignment), selected)
|
||||
#### changed = nk.selectable(text, value_table)
|
||||
#### changed = nk.selectable(text, image, value_table)
|
||||
#### changed = nk.selectable(text, image, align, value_table)
|
||||
Add a selectable item with the given text and/or image and alignment.
|
||||
#### changed = nk.selectable(text, image, [align](#alignment), value_table)
|
||||
Add a selectable item with the given text and/or image and [alignment](#alignment).
|
||||
|
||||
If given a boolean `selected`, return the new state of `selected`. If given a table with a boolean field named `value` instead, the field gets updated and the function returns `true` on a change and `false` otherwise.
|
||||
|
||||
|
|
@ -440,10 +440,10 @@ Start a combobox widget. This form gives complete control over the drop-down lis
|
|||
|
||||
Remember to call `nk.combobox_end` if the combobox is open.
|
||||
|
||||
#### activated = nk.combobox_item(text, symbol/image, align)
|
||||
#### activated = nk.combobox_item(text, symbol/image, [align](#alignment))
|
||||
#### activated = nk.combobox_item(text, symbol/image)
|
||||
#### activated = nk.combobox_item(text)
|
||||
Add a combobox item, optionally specifying a symbol, image, and/or alignment.
|
||||
Add a combobox item, optionally specifying a symbol, image, and/or [alignment](#alignment).
|
||||
|
||||
Return `true` if the item is activated, and `false` otherwise.
|
||||
|
||||
|
|
@ -624,57 +624,471 @@ local style = {
|
|||
['text normal'] = color,
|
||||
['text hover'] = color,
|
||||
['text active'] = color,
|
||||
['text alignment'] = color,
|
||||
['text alignment'] = align,
|
||||
['border'] = number,
|
||||
['rounding'] = number,
|
||||
['padding'] = {x = number, y = number},
|
||||
['image padding'] = {x = number, y = number},
|
||||
['touch padding'] = {x = number, y = number}
|
||||
['touch padding'] = {x = number, y = number}
|
||||
},
|
||||
['contextual button'] = {
|
||||
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['border color'] = color,
|
||||
['text background'] = color,
|
||||
['text normal'] = color,
|
||||
['text hover'] = color,
|
||||
['text active'] = color,
|
||||
['text alignment'] = align,
|
||||
['border'] = number,
|
||||
['rounding'] = number,
|
||||
['padding'] = {x = number, y = number},
|
||||
['image padding'] = {x = number, y = number},
|
||||
['touch padding'] = {x = number, y = number}
|
||||
},
|
||||
['menu button'] = {
|
||||
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['border color'] = color,
|
||||
['text background'] = color,
|
||||
['text normal'] = color,
|
||||
['text hover'] = color,
|
||||
['text active'] = color,
|
||||
['text alignment'] = align,
|
||||
['border'] = number,
|
||||
['rounding'] = number,
|
||||
['padding'] = {x = number, y = number},
|
||||
['image padding'] = {x = number, y = number},
|
||||
['touch padding'] = {x = number, y = number}
|
||||
},
|
||||
['option'] = {
|
||||
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['border color'] = color,
|
||||
['cursor normal'] = color or Image,
|
||||
['cursor hover'] = color or Image,
|
||||
['text normal'] = color,
|
||||
['text hover'] = color,
|
||||
['text active'] = color,
|
||||
['text background'] = color,
|
||||
['text alignment'] = align,
|
||||
['padding'] = {x = number, y = number},
|
||||
['touch padding'] = {x = number, y = number},
|
||||
['spacing'] = number,
|
||||
['border'] = number
|
||||
},
|
||||
['checkbox'] = {
|
||||
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['border color'] = color,
|
||||
['cursor normal'] = color or Image,
|
||||
['cursor hover'] = color or Image,
|
||||
['text normal'] = color,
|
||||
['text hover'] = color,
|
||||
['text active'] = color,
|
||||
['text background'] = color,
|
||||
['text alignment'] = align,
|
||||
['padding'] = {x = number, y = number},
|
||||
['touch padding'] = {x = number, y = number},
|
||||
['spacing'] = number,
|
||||
['border'] = number
|
||||
},
|
||||
['selectable'] = {
|
||||
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['pressed'] = color or Image,
|
||||
['normal active'] = color or Image,
|
||||
['hover active'] = color or Image,
|
||||
['pressed active'] = color or Image,
|
||||
['text normal'] = color,
|
||||
['text hover'] = color,
|
||||
['text pressed'] = color,
|
||||
['text normal active'] = color,
|
||||
['text hover active'] = color,
|
||||
['text pressed active'] = color,
|
||||
['text background'] = color,
|
||||
['text alignment'] = align,
|
||||
['rounding'] = number,
|
||||
['padding'] = {x = number, y = number},
|
||||
['touch padding'] = {x = number, y = number},
|
||||
['image padding'] = {x = number, y = number}
|
||||
},
|
||||
['slider'] = {
|
||||
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['border color'] = color,
|
||||
['bar normal'] = color,
|
||||
['bar active'] = color,
|
||||
['bar filled'] = color,
|
||||
['cursor normal'] = color or Image,
|
||||
['cursor hover'] = color or Image,
|
||||
['cursor active'] = color or Image,
|
||||
['border'] = number,
|
||||
['rounding'] = number,
|
||||
['bar height'] = number,
|
||||
['padding'] = {x = number, y = number},
|
||||
['spacing'] = {x = number, y = number},
|
||||
['cursor size'] = {x = number, y = number}
|
||||
},
|
||||
['progress'] = {
|
||||
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['border color'] = color,
|
||||
['cursor normal'] = color or Image,
|
||||
['cursor hover'] = color or Image,
|
||||
['cursor active'] = color or Image,
|
||||
['cursor border color'] = color,
|
||||
['rounding'] = number,
|
||||
['border'] = number,
|
||||
['cursor border'] = number,
|
||||
['cursor rounding'] = number,
|
||||
['padding'] = {x = number, y = number}
|
||||
},
|
||||
['property'] = {
|
||||
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['border color'] = color,
|
||||
['label normal'] = color,
|
||||
['label hover'] = color,
|
||||
['label active'] = color,
|
||||
['border'] = number,
|
||||
['rounding'] = number,
|
||||
['padding'] = {x = number, y = number},
|
||||
['edit'] = {
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['border color'] = color,
|
||||
['scrollbar'] = {
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['border color'] = color,
|
||||
['cursor normal'] = color or Image,
|
||||
['cursor hover'] = color or Image,
|
||||
['cursor active'] = color or Image,
|
||||
['cursor border color'] = color,
|
||||
['border'] = number,
|
||||
['rounding'] = number,
|
||||
['border cursor'] = number,
|
||||
['rounding cursor'] = number,
|
||||
['padding'] = {x = number, y = number}
|
||||
},
|
||||
['cursor normal'] = color,
|
||||
['cursor hover'] = color,
|
||||
['cursor text normal'] = color,
|
||||
['cursor text hover'] = color,
|
||||
['text normal'] = color,
|
||||
['text hover'] = color,
|
||||
['text active'] = color,
|
||||
['selected normal'] = color,
|
||||
['selected hover'] = color,
|
||||
['selected text normal'] = color,
|
||||
['selected text hover'] = color,
|
||||
['border'] = number,
|
||||
['rounding'] = number,
|
||||
['cursor size'] = number,
|
||||
['scrollbar size'] = {x = number, y = number},
|
||||
['padding'] = {x = number, y = number},
|
||||
['row padding'] = number
|
||||
},
|
||||
['inc button'] = {
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['border color'] = color,
|
||||
['text background'] = color,
|
||||
['text normal'] = color,
|
||||
['text hover'] = color,
|
||||
['text active'] = color,
|
||||
['text alignment'] = align,
|
||||
['border'] = number,
|
||||
['rounding'] = number,
|
||||
['padding'] = {x = number, y = number},
|
||||
['image padding'] = {x = number, y = number},
|
||||
['touch padding'] = {x = number, y = number}
|
||||
},
|
||||
['dec button'] = {
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['border color'] = color,
|
||||
['text background'] = color,
|
||||
['text normal'] = color,
|
||||
['text hover'] = color,
|
||||
['text active'] = color,
|
||||
['text alignment'] = align,
|
||||
['border'] = number,
|
||||
['rounding'] = number,
|
||||
['padding'] = {x = number, y = number},
|
||||
['image padding'] = {x = number, y = number},
|
||||
['touch padding'] = {x = number, y = number}
|
||||
}
|
||||
},
|
||||
['edit'] = {
|
||||
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['border color'] = color,
|
||||
['scrollbar'] = {
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['border color'] = color,
|
||||
['cursor normal'] = color or Image,
|
||||
['cursor hover'] = color or Image,
|
||||
['cursor active'] = color or Image,
|
||||
['cursor border color'] = color,
|
||||
['border'] = number,
|
||||
['rounding'] = number,
|
||||
['border cursor'] = number,
|
||||
['rounding cursor'] = number,
|
||||
['padding'] = {x = number, y = number}
|
||||
},
|
||||
['cursor normal'] = color,
|
||||
['cursor hover'] = color,
|
||||
['cursor text normal'] = color,
|
||||
['cursor text hover'] = color,
|
||||
['text normal'] = color,
|
||||
['text hover'] = color,
|
||||
['text active'] = color,
|
||||
['selected normal'] = color,
|
||||
['selected hover'] = color,
|
||||
['selected text normal'] = color,
|
||||
['selected text hover'] = color,
|
||||
['border'] = number,
|
||||
['rounding'] = number,
|
||||
['cursor size'] = number,
|
||||
['scrollbar size'] = {x = number, y = number},
|
||||
['padding'] = {x = number, y = number},
|
||||
['row padding'] = number
|
||||
},
|
||||
['chart'] = {
|
||||
|
||||
['background'] = color or Image,
|
||||
['border color'] = color,
|
||||
['selected color'] = color,
|
||||
['color'] = color,
|
||||
['border'] = number,
|
||||
['rounding'] = number,
|
||||
['padding'] = {x = number, y = number}
|
||||
},
|
||||
['scrollh'] = {
|
||||
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['border color'] = color,
|
||||
['cursor normal'] = color or Image,
|
||||
['cursor hover'] = color or Image,
|
||||
['cursor active'] = color or Image,
|
||||
['cursor border color'] = color,
|
||||
['border'] = number,
|
||||
['rounding'] = number,
|
||||
['border cursor'] = number,
|
||||
['rounding cursor'] = number,
|
||||
['padding'] = {x = number, y = number}
|
||||
},
|
||||
['scrollv'] = {
|
||||
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['border color'] = color,
|
||||
['cursor normal'] = color or Image,
|
||||
['cursor hover'] = color or Image,
|
||||
['cursor active'] = color or Image,
|
||||
['cursor border color'] = color,
|
||||
['border'] = number,
|
||||
['rounding'] = number,
|
||||
['border cursor'] = number,
|
||||
['rounding cursor'] = number,
|
||||
['padding'] = {x = number, y = number}
|
||||
},
|
||||
['tab'] = {
|
||||
|
||||
['background'] = color or Image,
|
||||
['border color'] = color,
|
||||
['text'] = color,
|
||||
['tab maximize button'] = {
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['border color'] = color,
|
||||
['text background'] = color,
|
||||
['text normal'] = color,
|
||||
['text hover'] = color,
|
||||
['text active'] = color,
|
||||
['text alignment'] = align,
|
||||
['border'] = number,
|
||||
['rounding'] = number,
|
||||
['padding'] = {x = number, y = number},
|
||||
['image padding'] = {x = number, y = number},
|
||||
['touch padding'] = {x = number, y = number}
|
||||
},
|
||||
['tab minimize button'] = {
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['border color'] = color,
|
||||
['text background'] = color,
|
||||
['text normal'] = color,
|
||||
['text hover'] = color,
|
||||
['text active'] = color,
|
||||
['text alignment'] = align,
|
||||
['border'] = number,
|
||||
['rounding'] = number,
|
||||
['padding'] = {x = number, y = number},
|
||||
['image padding'] = {x = number, y = number},
|
||||
['touch padding'] = {x = number, y = number}
|
||||
},
|
||||
['node maximize button'] = {
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['border color'] = color,
|
||||
['text background'] = color,
|
||||
['text normal'] = color,
|
||||
['text hover'] = color,
|
||||
['text active'] = color,
|
||||
['text alignment'] = align,
|
||||
['border'] = number,
|
||||
['rounding'] = number,
|
||||
['padding'] = {x = number, y = number},
|
||||
['image padding'] = {x = number, y = number},
|
||||
['touch padding'] = {x = number, y = number}
|
||||
},
|
||||
['node minimize button'] = {
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['border color'] = color,
|
||||
['text background'] = color,
|
||||
['text normal'] = color,
|
||||
['text hover'] = color,
|
||||
['text active'] = color,
|
||||
['text alignment'] = align,
|
||||
['border'] = number,
|
||||
['rounding'] = number,
|
||||
['padding'] = {x = number, y = number},
|
||||
['image padding'] = {x = number, y = number},
|
||||
['touch padding'] = {x = number, y = number}
|
||||
},
|
||||
['border'] = number,
|
||||
['rounding'] = number,
|
||||
['indent'] = number,
|
||||
['padding'] = {x = number, y = number},
|
||||
['spacing'] = {x = number, y = number}
|
||||
},
|
||||
['combo'] = {
|
||||
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['border color'] = color,
|
||||
['label normal'] = color,
|
||||
['label hover'] = color,
|
||||
['label active'] = color,
|
||||
['symbol normal'] = color,
|
||||
['symbol hover'] = color,
|
||||
['symbol active'] = color,
|
||||
['button'] = {
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['border color'] = color,
|
||||
['text background'] = color,
|
||||
['text normal'] = color,
|
||||
['text hover'] = color,
|
||||
['text active'] = color,
|
||||
['text alignment'] = align,
|
||||
['border'] = number,
|
||||
['rounding'] = number,
|
||||
['padding'] = {x = number, y = number},
|
||||
['image padding'] = {x = number, y = number},
|
||||
['touch padding'] = {x = number, y = number}
|
||||
},
|
||||
['border'] = number,
|
||||
['rounding'] = number,
|
||||
['content padding'] = {x = number, y = number},
|
||||
['button padding'] = {x = number, y = number}
|
||||
['spacing'] = {x = number, y = number}
|
||||
},
|
||||
['window'] = {
|
||||
|
||||
['header'] = {
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['close button'] = {
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['border color'] = color,
|
||||
['text background'] = color,
|
||||
['text normal'] = color,
|
||||
['text hover'] = color,
|
||||
['text active'] = color,
|
||||
['text alignment'] = align,
|
||||
['border'] = number,
|
||||
['rounding'] = number,
|
||||
['padding'] = {x = number, y = number},
|
||||
['image padding'] = {x = number, y = number},
|
||||
['touch padding'] = {x = number, y = number}
|
||||
},
|
||||
['minimize button'] = {
|
||||
['normal'] = color or Image,
|
||||
['hover'] = color or Image,
|
||||
['active'] = color or Image,
|
||||
['border color'] = color,
|
||||
['text background'] = color,
|
||||
['text normal'] = color,
|
||||
['text hover'] = color,
|
||||
['text active'] = color,
|
||||
['text alignment'] = align,
|
||||
['border'] = number,
|
||||
['rounding'] = number,
|
||||
['padding'] = {x = number, y = number},
|
||||
['image padding'] = {x = number, y = number},
|
||||
['touch padding'] = {x = number, y = number}
|
||||
},
|
||||
['label normal'] = color,
|
||||
['label hover'] = color,
|
||||
['label active'] = color,
|
||||
['padding'] = {x = number, y = number},
|
||||
['label padding'] = {x = number, y = number},
|
||||
['spacing'] = {x = number, y = number},
|
||||
|
||||
},
|
||||
['fixed background'] = color or Image,
|
||||
['background'] = color,
|
||||
['border color'] = color,
|
||||
['popup border color'] = color,
|
||||
['combo border color'] = color,
|
||||
['contextual border color'] = color,
|
||||
['menu border color'] = color,
|
||||
['group border color'] = color,
|
||||
['tooltip border color'] = color,
|
||||
['scaler'] = color or Image,
|
||||
['border'] = number,
|
||||
['combo border'] = number,
|
||||
['contextual border'] = number,
|
||||
['menu border'] = number,
|
||||
['group border'] = number,
|
||||
['tooltip border'] = number,
|
||||
['popup border'] = number,
|
||||
['rounding'] = number,
|
||||
['spacing'] = {x = number, y = number},
|
||||
['scrollbar size'] = {x = number, y = number},
|
||||
['min size'] = {x = number, y = number},
|
||||
['padding'] = {x = number, y = number},
|
||||
['group padding'] = {x = number, y = number},
|
||||
['popup padding'] = {x = number, y = number},
|
||||
['combo padding'] = {x = number, y = number},
|
||||
['contextual padding'] = {x = number, y = number},
|
||||
['menu padding'] = {x = number, y = number},
|
||||
['tooltip padding'] = {x = number, y = number}
|
||||
}
|
||||
}
|
||||
```
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue