Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Line Edits Example#

The Line Edits example demonstrates the many ways that QLineEdit can be used, and shows the effects of various properties and validators on the input and output supplied by the user.

../_images/lineedits-example.png

The example consists of a single Window class, containing a selection of line edits with different input constraints and display properties that can be changed by selecting items from comboboxes. Presenting these together helps developers choose suitable properties to use with line edits, and makes it easy to compare the effects of each validator on user input.

Window Class Definition#

The Window class inherits QWidget and contains a constructor and several slots:

class Window(QWidget):

    Q_OBJECT
# public
    Window(QWidget parent = None)
# public slots
    def echoChanged(int):
    def validatorChanged(int):
    def alignmentChanged(int):
    def inputMaskChanged(int):
    def accessChanged(int):
# private
    echoLineEdit = QLineEdit()
    validatorLineEdit = QLineEdit()
    alignmentLineEdit = QLineEdit()
    inputMaskLineEdit = QLineEdit()
    accessLineEdit = QLineEdit()

The slots are used to update the type of validator used for a given line edit when a new validator has been selected in the associated combobox. The line edits are stored in the window for use in these slots.

Window Class Implementation#

The Window constructor is used to set up the line edits, validators, and comboboxes, connect signals from the comboboxes to slots in the Window class, and arrange the child widgets in layouts.

We begin by constructing a group box to hold a label, combobox, and line edit so that we can demonstrate the echoMode property:

def __init__(self, parent):
    super().__init__(parent)

    echoGroup = QGroupBox(tr("Echo"))
    echoLabel = QLabel(tr("Mode:"))
    echoComboBox = QComboBox()
    echoComboBox.addItem(tr("Normal"))
    echoComboBox.addItem(tr("Password"))
    echoComboBox.addItem(tr("PasswordEchoOnEdit"))
    echoComboBox.addItem(tr("No Echo"))
    echoLineEdit = QLineEdit()
    echoLineEdit.setPlaceholderText("Placeholder Text")
    echoLineEdit.setFocus()

At this point, none of these widgets have been arranged in layouts. Eventually, the echoLabel, echoComboBox, and echoLineEdit will be placed in a vertical layout inside the echoGroup group box.

Similarly, we construct group boxes and collections of widgets to show the effects of QIntValidator and QDoubleValidator on a line edit’s contents:

validatorGroup = QGroupBox(tr("Validator"))
validatorLabel = QLabel(tr("Type:"))
validatorComboBox = QComboBox()
validatorComboBox.addItem(tr("No validator"))
validatorComboBox.addItem(tr("Integer validator"))
validatorComboBox.addItem(tr("Double validator"))
validatorLineEdit = QLineEdit()
validatorLineEdit.setPlaceholderText("Placeholder Text")

Text alignment is demonstrated by another group of widgets:

alignmentGroup = QGroupBox(tr("Alignment"))
alignmentLabel = QLabel(tr("Type:"))
alignmentComboBox = QComboBox()
alignmentComboBox.addItem(tr("Left"))
alignmentComboBox.addItem(tr("Centered"))
alignmentComboBox.addItem(tr("Right"))
alignmentLineEdit = QLineEdit()
alignmentLineEdit.setPlaceholderText("Placeholder Text")

QLineEdit supports the use of input masks . These only allow the user to type characters into the line edit that follow a simple specification. We construct a group of widgets to demonstrate a selection of predefined masks:

inputMaskGroup = QGroupBox(tr("Input mask"))
inputMaskLabel = QLabel(tr("Type:"))
inputMaskComboBox = QComboBox()
inputMaskComboBox.addItem(tr("No mask"))
inputMaskComboBox.addItem(tr("Phone number"))
inputMaskComboBox.addItem(tr("ISO date"))
inputMaskComboBox.addItem(tr("License key"))
inputMaskLineEdit = QLineEdit()
inputMaskLineEdit.setPlaceholderText("Placeholder Text")

Another useful feature of QLineEdit is its ability to make its contents read-only. This property is used to control access to a line edit in the following group of widgets:

accessGroup = QGroupBox(tr("Access"))
accessLabel = QLabel(tr("Read-only:"))
accessComboBox = QComboBox()
accessComboBox.addItem(tr("False"))
accessComboBox.addItem(tr("True"))
accessLineEdit = QLineEdit()
accessLineEdit.setPlaceholderText("Placeholder Text")

Now that all the child widgets have been constructed, we connect signals from the comboboxes to slots in the Window object:

echoComboBox.activated.connect(
        self.echoChanged)
validatorComboBox.activated.connect(
        self.validatorChanged)
alignmentComboBox.activated.connect(
        self.alignmentChanged)
inputMaskComboBox.activated.connect(
        self.inputMaskChanged)
accessComboBox.activated.connect(
        self.accessChanged)

Each of these connections use the activated() signal that supplies an integer to the slot. This will be used to efficiently make changes to the appropriate line edit in each slot.

We place each combobox, line edit, and label in a layout for each group box, beginning with the layout for the echoGroup group box:

echoLayout = QGridLayout()
echoLayout.addWidget(echoLabel, 0, 0)
echoLayout.addWidget(echoComboBox, 0, 1)
echoLayout.addWidget(echoLineEdit, 1, 0, 1, 2)
echoGroup.setLayout(echoLayout)

The other layouts are constructed in the same way:

validatorLayout = QGridLayout()
validatorLayout.addWidget(validatorLabel, 0, 0)
validatorLayout.addWidget(validatorComboBox, 0, 1)
validatorLayout.addWidget(validatorLineEdit, 1, 0, 1, 2)
validatorGroup.setLayout(validatorLayout)
alignmentLayout = QGridLayout()
alignmentLayout.addWidget(alignmentLabel, 0, 0)
alignmentLayout.addWidget(alignmentComboBox, 0, 1)
alignmentLayout.addWidget(alignmentLineEdit, 1, 0, 1, 2)
alignmentGroup. setLayout(alignmentLayout)
inputMaskLayout = QGridLayout()
inputMaskLayout.addWidget(inputMaskLabel, 0, 0)
inputMaskLayout.addWidget(inputMaskComboBox, 0, 1)
inputMaskLayout.addWidget(inputMaskLineEdit, 1, 0, 1, 2)
inputMaskGroup.setLayout(inputMaskLayout)
accessLayout = QGridLayout()
accessLayout.addWidget(accessLabel, 0, 0)
accessLayout.addWidget(accessComboBox, 0, 1)
accessLayout.addWidget(accessLineEdit, 1, 0, 1, 2)
accessGroup.setLayout(accessLayout)

Finally, we place each group box in a grid layout for the Window object and set the window title:

layout = QGridLayout()
layout.addWidget(echoGroup, 0, 0)
layout.addWidget(validatorGroup, 1, 0)
layout.addWidget(alignmentGroup, 2, 0)
layout.addWidget(inputMaskGroup, 0, 1)
layout.addWidget(accessGroup, 1, 1)
setLayout(layout)
setWindowTitle(tr("Line Edits"))

The slots respond to signals emitted when the comboboxes are changed by the user.

When the combobox for the Echo group box is changed, the echoChanged() slot is called:

def echoChanged(self, index):


    if index == 0:
        echoLineEdit.setEchoMode(QLineEdit.Normal)
        break
    elif index == 1:
        echoLineEdit.setEchoMode(QLineEdit.Password)
        break
    elif index == 2:
        echoLineEdit.setEchoMode(QLineEdit.PasswordEchoOnEdit)
        break
    elif index == 3:
        echoLineEdit.setEchoMode(QLineEdit.NoEcho)
        break

The slot updates the line edit in the same group box to use an echo mode that corresponds to the entry described in the combobox.

When the combobox for the Validator group box is changed, the validatorChanged() slot is called:

def validatorChanged(self, index):


    if index == 0:
        validatorLineEdit.setValidator(None)
        break
    elif index == 1:
        validatorLineEdit.setValidator(QIntValidator(
            validatorLineEdit))
        break
    elif index == 2:
        validatorLineEdit.setValidator(QDoubleValidator(-999.0,
            999.0, 2, validatorLineEdit))
        break

    validatorLineEdit.clear()

The slot either creates a new validator for the line edit to use, or it removes the validator in use by calling setValidator() with a zero pointer. We clear the line edit in this case to ensure that the new validator is initially given valid input to work with.

When the combobox for the Alignment group box is changed, the alignmentChanged() slot is called:

def alignmentChanged(self, index):


    if index == 0:
        alignmentLineEdit.setAlignment(Qt.AlignLeft)
        break
    elif index == 1:
        alignmentLineEdit.setAlignment(Qt.AlignCenter)
        break
    elif index == 2:
        alignmentLineEdit.setAlignment(Qt.AlignRight)
        break

This changes the way that text is displayed in the line edit to correspond with the description selected in the combobox.

The inputMaskChanged() slot handles changes to the combobox in the Input Mask group box:

def inputMaskChanged(self, index):


    if index == 0:
        inputMaskLineEdit.setInputMask("")
        break
    elif index == 1:
        inputMaskLineEdit.setInputMask("+99 99 99 99 99;_")
        break
    elif index == 2:
        inputMaskLineEdit.setInputMask("0000-00-00")
        inputMaskLineEdit.setText("00000000")
        inputMaskLineEdit.setCursorPosition(0)
        break
    elif index == 3:
        inputMaskLineEdit.setInputMask(">AAAAA-AAAAA-AAAAA-AAAAA-AAAAA;#")
        break

Each entry in the relevant combobox is associated with an input mask. We set a new mask by calling the setInputMask() function with a suitable string; the mask is disabled if an empty string is used.

The accessChanged() slot handles changes to the combobox in the Access group box:

def accessChanged(self, index):


    if index == 0:
        accessLineEdit.setReadOnly(False)
        break
    elif index == 1:
        accessLineEdit.setReadOnly(True)
        break

Here, we simply associate the False and True entries in the combobox with false and true values to be passed to setReadOnly() . This allows the user to enable and disable input to the line edit.

Example project @ code.qt.io