DoubleEdit (hwx.gui)

A widget that can display/edit a double.

Inherits:

Public Methods

addChildren (self, children)

destroy (self)

enableGlobalActions (self, enable)

get (self)

getMousePosition (self)

getRelativeMousePosition (self)

hide (self)

saveAsPng (self, fname)

set (self, value)

setF1HelpTopic (self, helptopic)

setProperties (self, kwds)

show (self)

validate (self, widget)

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

get(self)

Gets the value converted to base units.

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

set(self, value)

Sets the value converted to user units with the units label.

param value

A float value or a string with the units.

type value

str, float

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)

Internal method called from constructors.

show(self)

Shows the widget.

validate(self, widget)

Validates whether the value entered is a double and convert to base units.

param widget

Widget where the value is entered.

type widget

Widget

returns

True if the widget value entered is an int, otherwise False.

rtype

bool