ButtonBase (hwx.gui)¶
Abstract base class for all buttons.
- Inherits:
Properties¶
Public Methods¶
addChildren (self, children)
destroy (self)
enableGlobalActions (self, enable)
getMousePosition (self)
getRelativeMousePosition (self)
hide (self)
saveAsPng (self, fname)
setF1HelpTopic (self, helptopic)
setProperties (self, kwds)
show (self)
Property Details¶
- property accel¶
Keyboard accelerator to execute the command (ie ‘Ctrl-r’).
- property autoRepeat¶
Returns and sets if button will auto-repeat if the user holds it down.
- property checkable¶
Returns and sets if button can be toggled/checked (depending on rendering)
- property checked¶
Returns and sets if button has been toggled/checked. Only works if it is checkable.
- property dialog¶
(type[ActionDialog]) Dialog toggled by button.
The dialog is accessed/created through its cls.get() classmethod.
- property flat¶
Returns and sets if button has a flat borderless appearance.
- property icon¶
Icon file name.
- property text¶
Text to display.
Method Details¶
- addChildren(self, children)¶
Add child widgets/layouts into this widget.
Widget children get layed out using a VBoxLayout.
Typically, you’ll pass the parent/children into the constructor instead of calling this function directly.
- param children
- type children
list[Widget] | Layout
- destroy(self)¶
Deletes this and all its children.
- enableGlobalActions(self, enable)¶
Sets the state of Global Actions.
Disable the global actions to get key events.
- param enable
Determines whether to enable or disable global actions.
- type enable
bool
- getMousePosition(self)¶
Returns the mouse position.
- getRelativeMousePosition(self)¶
Returns the mouse position relative to this widget.
- hide(self)¶
Hides the widget.
- saveAsPng(self, fname)¶
Saves the widget as a .png file.
- param fname
The file name for the .png
- type fname
str
- returns
True if it was saved succesfully, False otherwise.
- rtype
bool
- setF1HelpTopic(self, helptopic)¶
Popup web-browser helps when the user hits F1 when over this.
- param helptopic
Topic name user needs help in.
- type helptopic
str
- setProperties(self, kwds)¶
Ensure proper order of setting properties.
- param kwds
A dict so the order of the properties are set is unpredictable checkable must be set before checked, or checked will not take effect.
- show(self)¶
Shows the widget.