gui.integer_edit.IntegerEdit Class Reference

Widget for editing signed and unsigned integer values up to 64-bits in a spinbox. More...

Inheritance diagram for gui.integer_edit.IntegerEdit:

Public Member Functions
	__init__ (self, parent=None, *args, **kwargs)
	Initialise the IntegerEdit widget.
	stepBy (self, int step)
	Increments/decrements the value being edited by the step amount.
	stepEnabled (self)
	Returns the flags indicating if the up and down spin buttons should be enabled.
	validate (self, str input, int pos)
	Check that the input string conforms to a valid or plausible integer value.
	fixup (self, str input)
	Adjusts the input string to the nearest likely valid integer value.
	get_value (self)
	Getter for the value property will return the edited integer value.
	set_value (self, int value)
	Setter for the value property.
	get_minimum (self)
	Getter returns the minimum (inclusive) integer value allowed.
	set_minimum (self, int value)
	Setter for the minimum (inclusive) integer value allowed.
	get_maximum (self)
	Getter returns the maximum (inclusive) integer value allowed.
	set_maximum (self, int value)
	Setter for the maximum (inclusive) integer value allowed.
	set_range (self, int minimum=None, int maximum=None, type=None)
	Set the minimum and maximum range allowed for the integer value.

Public Attributes
	text = text

Static Public Attributes
	value_changed = Signal()
	This signal is emitted whenever the value property changes.
	commit_data = Signal(QWidget)
	This signal is emitted whenever the user has made modifications to the data using this edit widget that should be committed.
	value
	minimum
	maximum

Protected Member Functions
	_editing_finished (self)
	_editor_text_changed (self, text)

Protected Attributes
	_validator = IntegerValidator(parent=self)
	_editing_finished
	_editor_text_changed

Detailed Description

Widget for editing signed and unsigned integer values up to 64-bits in a spinbox.

Constructor & Destructor Documentation

__init__()

gui.integer_edit.IntegerEdit.__init__	(		self,
			parent = None,
		*	args,
		**	kwargs )

Initialise the IntegerEdit widget.

Parameters

parent	The optional parent Qt widget object.
args	Additional positional arguments passed onto the base class.
kwargs	Additional keyword arguments passed onto the base class.

Member Function Documentation

_editing_finished()

gui.integer_edit.IntegerEdit._editing_finished ( self )

protected

_editor_text_changed()

gui.integer_edit.IntegerEdit._editor_text_changed ( self, text )

protected

fixup()

gui.integer_edit.IntegerEdit.fixup	(		self,
		str	input )

Adjusts the input string to the nearest likely valid integer value.

Parameters

input

The input string to adjust.

Returns

Corrected valid value as a string or the original if it was already valid.

get_maximum()

gui.integer_edit.IntegerEdit.get_maximum

(

self

)

Getter returns the maximum (inclusive) integer value allowed.

get_minimum()

gui.integer_edit.IntegerEdit.get_minimum

(

self

)

Getter returns the minimum (inclusive) integer value allowed.

get_value()

gui.integer_edit.IntegerEdit.get_value

(

self

)

Getter for the value property will return the edited integer value.

set_maximum()

gui.integer_edit.IntegerEdit.set_maximum	(		self,
		int	value )

Setter for the maximum (inclusive) integer value allowed.

Parameters

value

The new maximum value allowed.

set_minimum()

gui.integer_edit.IntegerEdit.set_minimum	(		self,
		int	value )

Setter for the minimum (inclusive) integer value allowed.

Parameters

value

The new minimum value allowed.

set_range()

gui.integer_edit.IntegerEdit.set_range	(		self,
		int	minimum = None,
		int	maximum = None,
			type = None )

Set the minimum and maximum range allowed for the integer value.

The range as [minimum, maximum] should either be provided explicitly as arguments, or the type argument should be provided instead, from which the range will be derived. The allowed types are: RtcInt8, RtcInt16, RtcInt32, RtcInt64, RtcUInt8, RtcUInt16, RtcUInt32 or RtcUInt64.

Parameters

minimum	The minimum (inclusive) value allowed.
maximum	The maximum (inclusive) value allowed.
type	Alternative type from which to derive the minimum/maximum.

set_value()

gui.integer_edit.IntegerEdit.set_value	(		self,
		int	value )

Setter for the value property.

Parameters

value

The new value to be edited by this widget.

stepBy()

gui.integer_edit.IntegerEdit.stepBy	(		self,
		int	step )

Increments/decrements the value being edited by the step amount.

Parameters

step	Integer amount to add to the value (can be negative).

stepEnabled()

gui.integer_edit.IntegerEdit.stepEnabled

(

self

)

Returns the flags indicating if the up and down spin buttons should be enabled.

These are enabled if the value is within the range minimum < value < maximum.

validate()

gui.integer_edit.IntegerEdit.validate	(		self,
		str	input,
		int	pos )

Check that the input string conforms to a valid or plausible integer value.

See IntegerValidator.validate for additional details.

Parameters

input	The input string to check.
pos	The position of the cursor within the input string.

Returns

Tuple containing the validity flag, the input and pos arguments.

Member Data Documentation

_editing_finished

gui.integer_edit.IntegerEdit._editing_finished

protected

_editor_text_changed

gui.integer_edit.IntegerEdit._editor_text_changed

protected

_validator

gui.integer_edit.IntegerEdit._validator = IntegerValidator(parent=self)

protected

commit_data

gui.integer_edit.IntegerEdit.commit_data = Signal(QWidget)

static

This signal is emitted whenever the user has made modifications to the data using this edit widget that should be committed.

maximum

gui.integer_edit.IntegerEdit.maximum

static

Initial value:

=  Property(
        type=int,
        fget=get_maximum,
        fset=set_maximum,
        doc="The maximum value allowed for the spinbox.",
    )

minimum

gui.integer_edit.IntegerEdit.minimum

static

Initial value:

=  Property(
        type=int,
        fget=get_minimum,
        fset=set_minimum,
        doc="The minimum value allowed for the spinbox.",
    )

text

gui.integer_edit.IntegerEdit.text = text

value

gui.integer_edit.IntegerEdit.value

static

Initial value:

=  Property(
        type=int,
        fget=get_value,
        fset=set_value,
        user=True,
        notify=value_changed,
        doc="The integer value being edited by this spinbox.",
    )

value_changed

gui.integer_edit.IntegerEdit.value_changed = Signal()

static

This signal is emitted whenever the value property changes.

---

The documentation for this class was generated from the following file:

• clients/configTool/src/rtctk/configtool/gui/integer_edit.py