LineEdit (hwx.gui)

A LineEdit Widget that can display/edit a string.

A line edit allows the user to enter and edit a single line of plain text with a useful collection of editing functions, including undo and redo, cut and paste, and drag and drop.

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)

validate (self, widget)

Property Details

property alignment

Alignment of text (left, center or, right).

property readonly

Returns and sets whether text/value can be edited.

property text

Alias for value property.

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)

Internal method called from constructors.

show(self)

Shows the widget.

validate(self, widget)

Validates the value of the widget.