Toolbox Documentation¶
Toolbox class¶
- class pygameyagui.Toolbox(interface, title)¶
This class creates a toolbox object.
- Parameters:
interface (
pygameyagui.Interface) – The interface created.title (str) – Toolbox title.
Toolbox methods¶
- Toolbox.minimize()¶
Use this to programatically minimize a toolbox.
The toolbox will collapse such that only its title bar is visible. It is called internally when the user clicks in the minimize icon of an expanded toolbox at the left end of the title bar.
- Return type:
NoneType
- Toolbox.restore()¶
Use this to programatically restore/expand a toolbox.
The toolbox will restore such that its body is visible. It is called internally when the user clicks in the minimize icon of a minimized/collapsed toolbox at the right end of the title bar.
- Return type:
NoneType
- Toolbox.enable()¶
Use this to enable the toolbox.
All toolboxes are enabled by default at instantiation.
The effect is that any enabled widget in the toolbox will be enabled. It does not affect the behaviour of disabled widgets.
This can only be achieved programatically.
See also:
pygameyagui.Toolbox.disable()- Return type:
NoneType
- Toolbox.disable()¶
Use this to disable the toolbox.
The effect is that all widgets in the toolbox will be disabled independently of the widget being enabled or disabled.
This can only be achieved programatically.
See also:
pygameyagui.Toolbox.enable()- Return type:
NoneType
- Toolbox.open()¶
Use this to open a closed toolbox.
It is equivalent to use the toolbox menu at the controls.
See also:
pygameyagui.Toolbox.close()- Return type:
NoneType
- Toolbox.close()¶
Use this to close a opened toolbox.
It is equivalent to use the close icon at the right end of the toolbox title bar or to use the toolbox menu at the controls.
Closing a toolbox benefits performance and it does not alter the values of its widgets. You can still get or set the value of any widget when it is closed.
See also:
pygameyagui.Toolbox.open()- Return type:
NoneType
Toolbox properties¶
- property Toolbox.enabled¶
Get whether or not a toolbox is enabled (bool).
See also:
pygameyagui.Toolbox.enable()andpygameyagui.Toolbox.disable().
- property Toolbox.opened¶
Get whether or not a toolbox is opened (bool).
See also:
pygameyagui.Toolbox.open()andpygameyagui.Toolbox.close().