QLineEdit¶

Synopsis¶

Functions¶

def alignment ()
def backspace ()
def completer ()
def createStandardContextMenu ()
def cursorBackward (mark[, steps=1])
def cursorForward (mark[, steps=1])
def cursorMoveStyle ()
def cursorPosition ()
def cursorPositionAt (pos)
def cursorRect ()
def cursorWordBackward (mark)
def cursorWordForward (mark)
def del_ ()
def deselect ()
def displayText ()
def dragEnabled ()
def echoMode ()
def end (mark)
def getTextMargins ()
def hasAcceptableInput ()
def hasFrame ()
def hasSelectedText ()
def home (mark)
def initStyleOption (option)
def inputMask ()
def insert (arg__1)
def isModified ()
def isReadOnly ()
def isRedoAvailable ()
def isUndoAvailable ()
def maxLength ()
def placeholderText ()
def selectedText ()
def selectionStart ()
def setAlignment (flag)
def setCompleter (completer)
def setCursorMoveStyle (style)
def setCursorPosition (arg__1)
def setDragEnabled (b)
def setEchoMode (arg__1)
def setFrame (arg__1)
def setInputMask (inputMask)
def setMaxLength (arg__1)
def setModified (arg__1)
def setPlaceholderText (arg__1)
def setReadOnly (arg__1)
def setSelection (arg__1, arg__2)
def setTextMargins (left, top, right, bottom)
def setTextMargins (margins)
def setValidator (arg__1)
def text ()
def textMargins ()
def validator ()

Slots¶

def clear ()
def copy ()
def cut ()
def paste ()
def redo ()
def selectAll ()
def setText (arg__1)
def undo ()

Signals¶

def cursorPositionChanged (arg__1, arg__2)
def editingFinished ()
def returnPressed ()
def selectionChanged ()
def textChanged (arg__1)
def textEdited (arg__1)

Detailed Description¶

The PySide.QtGui.QLineEdit widget is a one-line text editor.

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.

By changing the PySide.QtGui.QLineEdit.echoMode() of a line edit, it can also be used as a “write-only” field, for inputs such as passwords.

The length of the text can be constrained to PySide.QtGui.QLineEdit.maxLength() . The text can be arbitrarily constrained using a PySide.QtGui.QLineEdit.validator() or an PySide.QtGui.QLineEdit.inputMask() , or both. When switching between a validator and an input mask on the same line edit, it is best to clear the validator or input mask to prevent undefined behavior.

A related class is PySide.QtGui.QTextEdit which allows multi-line, rich text editing.

You can change the text with PySide.QtGui.QLineEdit.setText() or PySide.QtGui.QLineEdit.insert() . The text is retrieved with PySide.QtGui.QLineEdit.text() ; the displayed text (which may be different, see QLineEdit.EchoMode ) is retrieved with PySide.QtGui.QLineEdit.displayText() . Text can be selected with PySide.QtGui.QLineEdit.setSelection() or PySide.QtGui.QLineEdit.selectAll() , and the selection can be PySide.QtGui.QLineEdit.cut() , PySide.QtGui.QLineEdit.copy() ied and PySide.QtGui.QLineEdit.paste() d. The text can be aligned with PySide.QtGui.QLineEdit.setAlignment() .

When the text changes the PySide.QtGui.QLineEdit.textChanged() signal is emitted; when the text changes other than by calling PySide.QtGui.QLineEdit.setText() the PySide.QtGui.QLineEdit.textEdited() signal is emitted; when the cursor is moved the PySide.QtGui.QLineEdit.cursorPositionChanged() signal is emitted; and when the Return or Enter key is pressed the PySide.QtGui.QLineEdit.returnPressed() signal is emitted.

When editing is finished, either because the line edit lost focus or Return/Enter is pressed the PySide.QtGui.QLineEdit.editingFinished() signal is emitted.

Note that if there is a validator set on the line edit, the PySide.QtGui.QLineEdit.returnPressed() / PySide.QtGui.QLineEdit.editingFinished() signals will only be emitted if the validator returns QValidator.Acceptable .

By default, QLineEdits have a frame as specified by the Windows and Motif style guides; you can turn it off by calling setFrame(false).

The default key bindings are described below. The line edit also provides a context menu (usually invoked by a right mouse click) that presents some of these editing options.

Keypress Action

Left Arrow Moves the cursor one character to the left.

Shift+Left Arrow Moves and selects text one character to the left.

Right Arrow Moves the cursor one character to the right.

Shift+Right Arrow Moves and selects text one character to the right.

Home Moves the cursor to the beginning of the line.

End Moves the cursor to the end of the line.

Backspace Deletes the character to the left of the cursor.

Ctrl+Backspace Deletes the word to the left of the cursor.

Delete Deletes the character to the right of the cursor.

Ctrl+Delete Deletes the word to the right of the cursor.

Ctrl+A Select all.

Ctrl+C Copies the selected text to the clipboard.

Ctrl+Insert Copies the selected text to the clipboard.

Ctrl+K Deletes to the end of the line.

Ctrl+V Pastes the clipboard text into line edit.

Shift+Insert Pastes the clipboard text into line edit.

Ctrl+X Deletes the selected text and copies it to the clipboard.

Shift+Delete Deletes the selected text and copies it to the clipboard.

Ctrl+Z Undoes the last operation.

Ctrl+Y Redoes the last undone operation.

Any other key sequence that represents a valid character, will cause the character to be inserted into the line edit.

A line edit shown in the Macintosh widget style .

A line edit shown in the Windows XP widget style .

A line edit shown in the Plastique widget style .

See also

PySide.QtGui.QTextEdit PySide.QtGui.QLabel PySide.QtGui.QComboBox GUI Design Handbook: Field, Entry Line Edits Example

class PySide.QtGui.QLineEdit([parent=None])¶

class PySide.QtGui.QLineEdit(arg__1[, parent=None])

Parameters:	parent – `PySide.QtGui.QWidget` arg__1 – unicode

Constructs a line edit with no text.

The maximum text length is set to 32767 characters.

The parent argument is sent to the PySide.QtGui.QWidget constructor.

Constructs a line edit containing the text contents .

The cursor position is set to the end of the line and the maximum text length to 32767 characters.

The parent and argument is sent to the PySide.QtGui.QWidget constructor.

PySide.QtGui.QLineEdit.EchoMode¶

This enum type describes how a line edit should display its contents.

Constant	Description
QLineEdit.Normal	Display characters as they are entered. This is the default.
QLineEdit.NoEcho	Do not display anything. This may be appropriate for passwords where even the length of the password should be kept secret.
QLineEdit.Password	Display asterisks instead of the characters actually entered.
QLineEdit.PasswordEchoOnEdit	Display characters as they are entered while editing otherwise display asterisks.

PySide.QtGui.QLineEdit.alignment()¶

Return type:	`PySide.QtCore.Qt.Alignment`

This property holds the alignment of the line edit.

Both horizontal and vertical alignment is allowed here, Qt.AlignJustify will map to Qt.AlignLeft .

By default, this property contains a combination of Qt.AlignLeft and Qt.AlignVCenter .

See also

Qt.Alignment

PySide.QtGui.QLineEdit.backspace()¶: If no text is selected, deletes the character to the left of the text cursor and moves the cursor one position to the left. If any text is selected, the cursor is moved to the beginning of the selected text and the selected text is deleted.

See also

del()

PySide.QtGui.QLineEdit.clear()¶: Clears the contents of the line edit.

See also

PySide.QtGui.QLineEdit.setText() PySide.QtGui.QLineEdit.insert()

PySide.QtGui.QLineEdit.completer()¶

Return type:	`PySide.QtGui.QCompleter`

Returns the current PySide.QtGui.QCompleter that provides completions.

See also

PySide.QtGui.QLineEdit.setCompleter()

PySide.QtGui.QLineEdit.copy()¶: Copies the selected text to the clipboard, if there is any, and if PySide.QtGui.QLineEdit.echoMode() is Normal .

See also

PySide.QtGui.QLineEdit.cut() PySide.QtGui.QLineEdit.paste()

PySide.QtGui.QLineEdit.createStandardContextMenu()¶

Return type:	`PySide.QtGui.QMenu`

This function creates the standard context menu which is shown when the user clicks on the line edit with the right mouse button. It is called from the default PySide.QtGui.QLineEdit.contextMenuEvent() handler. The popup menu’s ownership is transferred to the caller.

PySide.QtGui.QLineEdit.cursorBackward(mark[, steps=1])¶

Parameters:	mark – `PySide.QtCore.bool` steps – `PySide.QtCore.int`

Moves the cursor back steps characters. If mark is true each character moved over is added to the selection; if mark is false the selection is cleared.

PySide.QtGui.QLineEdit.cursorForward(mark[, steps=1])¶

Parameters:	mark – `PySide.QtCore.bool` steps – `PySide.QtCore.int`

Moves the cursor forward steps characters. If mark is true each character moved over is added to the selection; if mark is false the selection is cleared.

PySide.QtGui.QLineEdit.cursorMoveStyle()¶

Return type:	`PySide.QtCore.Qt.CursorMoveStyle`

This property holds the movement style of cursor in this line edit.

When this property is set to Qt.VisualMoveStyle , the line edit will use visual movement style. Pressing the left arrow key will always cause the cursor to move left, regardless of the text’s writing direction. The same behavior applies to right arrow key.

When the property is Qt.LogicalMoveStyle (the default), within a LTR text block, increase cursor position when pressing left arrow key, decrease cursor position when pressing the right arrow key. If the text block is right to left, the opposite behavior applies.

PySide.QtGui.QLineEdit.cursorPosition()¶

Return type:	`PySide.QtCore.int`

This property holds the current cursor position for this line edit.

Setting the cursor position causes a repaint when appropriate.

By default, this property contains a value of 0.

PySide.QtGui.QLineEdit.cursorPositionAt(pos)¶

Parameters:	pos – `PySide.QtCore.QPoint`
Return type:	`PySide.QtCore.int`

Returns the cursor position under the point pos .

PySide.QtGui.QLineEdit.cursorPositionChanged(arg__1, arg__2)¶

Parameters:	arg__1 – `PySide.QtCore.int` arg__2 – `PySide.QtCore.int`

PySide.QtGui.QLineEdit.cursorRect()¶

Return type:	`PySide.QtCore.QRect`

Returns a rectangle that includes the lineedit cursor.

PySide.QtGui.QLineEdit.cursorWordBackward(mark)¶

Parameters:	mark – `PySide.QtCore.bool`

Moves the cursor one word backward. If mark is true, the word is also selected.

PySide.QtGui.QLineEdit.cursorWordForward(mark)¶

Parameters:	mark – `PySide.QtCore.bool`

Moves the cursor one word forward. If mark is true, the word is also selected.

PySide.QtGui.QLineEdit.cut()¶

Copies the selected text to the clipboard and deletes it, if there is any, and if PySide.QtGui.QLineEdit.echoMode() is Normal .

If the current validator disallows deleting the selected text, PySide.QtGui.QLineEdit.cut() will copy without deleting.

PySide.QtGui.QLineEdit.del_()¶: If no text is selected, deletes the character to the right of the text cursor. If any text is selected, the cursor is moved to the beginning of the selected text and the selected text is deleted.

See also

PySide.QtGui.QLineEdit.backspace()

PySide.QtGui.QLineEdit.deselect()¶: Deselects any selected text.

See also

PySide.QtGui.QLineEdit.setSelection() PySide.QtGui.QLineEdit.selectAll()

PySide.QtGui.QLineEdit.displayText()¶

Return type:	unicode

This property holds the displayed text.

If PySide.QtGui.QLineEdit.echoMode() is Normal this returns the same as PySide.QtGui.QLineEdit.text() ; if QLineEdit.EchoMode is Password or PasswordEchoOnEdit it returns a string of asterisks PySide.QtGui.QLineEdit.text() . length() characters long, e.g. “******”; if QLineEdit.EchoMode is NoEcho returns an empty string, “”.

By default, this property contains an empty string.

PySide.QtGui.QLineEdit.dragEnabled()¶

Return type:	`PySide.QtCore.bool`

This property holds whether the lineedit starts a drag if the user presses and moves the mouse on some selected text.

Dragging is disabled by default.

PySide.QtGui.QLineEdit.echoMode()¶

Return type:	`PySide.QtGui.QLineEdit.EchoMode`

This property holds the line edit’s echo mode.

The echo mode determines how the text entered in the line edit is displayed (or echoed) to the user.

The most common setting is Normal , in which the text entered by the user is displayed verbatim, but PySide.QtGui.QLineEdit also supports modes that allow the entered text to be suppressed or obscured: these include NoEcho , Password and PasswordEchoOnEdit .

The widget’s display and the ability to copy or drag the text is affected by this setting.

By default, this property is set to Normal .

See also

QLineEdit.EchoMode PySide.QtGui.QLineEdit.displayText()

PySide.QtGui.QLineEdit.editingFinished()¶

PySide.QtGui.QLineEdit.end(mark)¶

Parameters:	mark – `PySide.QtCore.bool`

Moves the text cursor to the end of the line unless it is already there. If mark is true, text is selected towards the last position; otherwise, any selected text is unselected if the cursor is moved.

See also

PySide.QtGui.QLineEdit.home()

PySide.QtGui.QLineEdit.getTextMargins()¶: Returns the widget’s text margins for left , top , right , and bottom .

See also

PySide.QtGui.QLineEdit.setTextMargins()

PySide.QtGui.QLineEdit.hasAcceptableInput()¶

Return type:	`PySide.QtCore.bool`

This property holds whether the input satisfies the PySide.QtGui.QLineEdit.inputMask() and the validator..

By default, this property is true.

PySide.QtGui.QLineEdit.hasFrame()¶

Return type:	`PySide.QtCore.bool`

This property holds whether the line edit draws itself with a frame.

If enabled (the default) the line edit draws itself inside a frame, otherwise the line edit draws itself without any frame.

PySide.QtGui.QLineEdit.hasSelectedText()¶

Return type:	`PySide.QtCore.bool`

This property holds whether there is any text selected.

PySide.QtGui.QLineEdit.hasSelectedText() returns true if some or all of the text has been selected by the user; otherwise returns false.

By default, this property is false.

See also

PySide.QtGui.QLineEdit.selectedText()

PySide.QtGui.QLineEdit.home(mark)¶

Parameters:	mark – `PySide.QtCore.bool`

Moves the text cursor to the beginning of the line unless it is already there. If mark is true, text is selected towards the first position; otherwise, any selected text is unselected if the cursor is moved.

See also

PySide.QtGui.QLineEdit.end()

PySide.QtGui.QLineEdit.initStyleOption(option)¶

Parameters:	option – `PySide.QtGui.QStyleOptionFrame`

Initialize option with the values from this PySide.QtGui.QLineEdit . This method is useful for subclasses when they need a PySide.QtGui.QStyleOptionFrame or PySide.QtGui.QStyleOptionFrameV2 , but don’t want to fill in all the information themselves. This function will check the version of the PySide.QtGui.QStyleOptionFrame and fill in the additional values for a PySide.QtGui.QStyleOptionFrameV2 .

See also

QStyleOption.initFrom()

PySide.QtGui.QLineEdit.inputMask()¶

Return type:	unicode

This property holds The validation input mask.

If no mask is set, PySide.QtGui.QLineEdit.inputMask() returns an empty string.

Sets the PySide.QtGui.QLineEdit ‘s validation mask. Validators can be used instead of, or in conjunction with masks; see PySide.QtGui.QLineEdit.setValidator() .

Unset the mask and return to normal PySide.QtGui.QLineEdit operation by passing an empty string (“”) or just calling PySide.QtGui.QLineEdit.setInputMask() with no arguments.

The table below shows the characters that can be used in an input mask. A space character, the default character for a blank, is needed for cases where a character is permitted but not required .

Character	Meaning
`A`	ASCII alphabetic character required. A-Z, a-z.
`a`	ASCII alphabetic character permitted but not required.
`N`	ASCII alphanumeric character required. A-Z, a-z, 0-9.
`n`	ASCII alphanumeric character permitted but not required.
`X`	Any character required.
`x`	Any character permitted but not required.
`9`	ASCII digit required. 0-9.
`0`	ASCII digit permitted but not required.
`D`	ASCII digit required. 1-9.
`d`	ASCII digit permitted but not required (1-9).
`#`	ASCII digit or plus/minus sign permitted but not required.
`H`	Hexadecimal character required. A-F, a-f, 0-9.
`h`	Hexadecimal character permitted but not required.
`B`	Binary character required. 0-1.
`b`	Binary character permitted but not required.
`>`	All following alphabetic characters are uppercased.
`<`	All following alphabetic characters are lowercased.
`!`	Switch off case conversion.
`\`	Use `\` to escape the special characters listed above to use them as separators.

The mask consists of a string of mask characters and separators, optionally followed by a semicolon and the character used for blanks. The blank characters are always removed from the text after editing.

Examples:

Mask	Notes
`000.000.000.000;_`	IP address; blanks are `_` .
`HH:HH:HH:HH:HH:HH;_`	MAC address
`0000-00-00`	ISO Date; blanks are `space`
`>AAAAA-AAAAA-AAAAA-AAAAA-AAAAA;#`	License number; blanks are `-` and all (alphabetic) characters are converted to uppercase.

To get range control (e.g., for an IP address) use masks together with validators .

See also

PySide.QtGui.QLineEdit.maxLength()

PySide.QtGui.QLineEdit.insert(arg__1)¶

Parameters:	arg__1 – unicode

Deletes any selected text, inserts newText , and validates the result. If it is valid, it sets it as the new contents of the line edit.

PySide.QtGui.QLineEdit.isModified()¶

Return type:	`PySide.QtCore.bool`

This property holds whether the line edit’s contents has been modified by the user.

The modified flag is never read by PySide.QtGui.QLineEdit ; it has a default value of false and is changed to true whenever the user changes the line edit’s contents.

This is useful for things that need to provide a default value but do not start out knowing what the default should be (perhaps it depends on other fields on the form). Start the line edit without the best default, and when the default is known, if modified() returns false (the user hasn’t entered any text), insert the default value.

Calling PySide.QtGui.QLineEdit.setText() resets the modified flag to false.

PySide.QtGui.QLineEdit.isReadOnly()¶

Return type:	`PySide.QtCore.bool`

This property holds whether the line edit is read only..

In read-only mode, the user can still copy the text to the clipboard, or drag and drop the text (if PySide.QtGui.QLineEdit.echoMode() is Normal ), but cannot edit it.

PySide.QtGui.QLineEdit does not show a cursor in read-only mode.

By default, this property is false.

See also

PySide.QtGui.QWidget.setEnabled()

PySide.QtGui.QLineEdit.isRedoAvailable()¶

Return type:	`PySide.QtCore.bool`

This property holds whether redo is available.

Redo becomes available once the user has performed one or more undo operations on text in the line edit.

By default, this property is false.

PySide.QtGui.QLineEdit.isUndoAvailable()¶

Return type:	`PySide.QtCore.bool`

This property holds whether undo is available.

Undo becomes available once the user has modified the text in the line edit.

By default, this property is false.

PySide.QtGui.QLineEdit.maxLength()¶

Return type:	`PySide.QtCore.int`

This property holds the maximum permitted length of the text.

If the text is too long, it is truncated at the limit.

If truncation occurs any selected text will be unselected, the cursor position is set to 0 and the first part of the string is shown.

If the line edit has an input mask, the mask defines the maximum string length.

By default, this property contains a value of 32767.

See also

PySide.QtGui.QLineEdit.inputMask()

PySide.QtGui.QLineEdit.paste()¶

Inserts the clipboard’s text at the cursor position, deleting any selected text, providing the line edit is not read-only .

If the end result would not be acceptable to the current validator , nothing happens.

PySide.QtGui.QLineEdit.placeholderText()¶

Return type:	unicode

This property holds the line edit’s placeholder text.

Setting this property makes the line edit display a grayed-out placeholder text as long as the PySide.QtGui.QLineEdit.text() is empty and the widget doesn’t have focus.

By default, this property contains an empty string.

See also

PySide.QtGui.QLineEdit.text()

PySide.QtGui.QLineEdit.redo()¶: Redoes the last operation if redo is available .

PySide.QtGui.QLineEdit.returnPressed()¶

PySide.QtGui.QLineEdit.selectAll()¶: Selects all the text (i.e. highlights it) and moves the cursor to the end. This is useful when a default value has been inserted because if the user types before clicking on the widget, the selected text will be deleted.

See also

PySide.QtGui.QLineEdit.setSelection() PySide.QtGui.QLineEdit.deselect()

PySide.QtGui.QLineEdit.selectedText()¶

Return type:	unicode

This property holds the selected text.

If there is no selected text this property’s value is an empty string.

By default, this property contains an empty string.

PySide.QtGui.QLineEdit.selectionChanged()¶

PySide.QtGui.QLineEdit.selectionStart()¶

Return type:	`PySide.QtCore.int`

PySide.QtGui.QLineEdit.selectionStart() returns the index of the first selected character in the line edit or -1 if no text is selected.

See also

PySide.QtGui.QLineEdit.selectedText()

PySide.QtGui.QLineEdit.setAlignment(flag)¶

Parameters:	flag – `PySide.QtCore.Qt.Alignment`

This property holds the alignment of the line edit.

Both horizontal and vertical alignment is allowed here, Qt.AlignJustify will map to Qt.AlignLeft .

By default, this property contains a combination of Qt.AlignLeft and Qt.AlignVCenter .

See also

Qt.Alignment

PySide.QtGui.QLineEdit.setCompleter(completer)¶

Parameters:	completer – `PySide.QtGui.QCompleter`

Sets this line edit to provide auto completions from the completer, c . The completion mode is set using QCompleter.setCompletionMode() .

To use a PySide.QtGui.QCompleter with a PySide.QtGui.QValidator or QLineEdit.inputMask , you need to ensure that the model provided to PySide.QtGui.QCompleter contains valid entries. You can use the PySide.QtGui.QSortFilterProxyModel to ensure that the PySide.QtGui.QCompleter ‘s model contains only valid entries.

If c == 0, PySide.QtGui.QLineEdit.setCompleter() removes the current completer, effectively disabling auto completion.

PySide.QtGui.QLineEdit.setCursorMoveStyle(style)¶

Parameters:	style – `PySide.QtCore.Qt.CursorMoveStyle`

This property holds the movement style of cursor in this line edit.

When this property is set to Qt.VisualMoveStyle , the line edit will use visual movement style. Pressing the left arrow key will always cause the cursor to move left, regardless of the text’s writing direction. The same behavior applies to right arrow key.

When the property is Qt.LogicalMoveStyle (the default), within a LTR text block, increase cursor position when pressing left arrow key, decrease cursor position when pressing the right arrow key. If the text block is right to left, the opposite behavior applies.

PySide.QtGui.QLineEdit.setCursorPosition(arg__1)¶

Parameters:	arg__1 – `PySide.QtCore.int`

This property holds the current cursor position for this line edit.

Setting the cursor position causes a repaint when appropriate.

By default, this property contains a value of 0.

PySide.QtGui.QLineEdit.setDragEnabled(b)¶

Parameters:	b – `PySide.QtCore.bool`

This property holds whether the lineedit starts a drag if the user presses and moves the mouse on some selected text.

Dragging is disabled by default.

PySide.QtGui.QLineEdit.setEchoMode(arg__1)¶

Parameters:	arg__1 – `PySide.QtGui.QLineEdit.EchoMode`

This property holds the line edit’s echo mode.

The echo mode determines how the text entered in the line edit is displayed (or echoed) to the user.

The most common setting is Normal , in which the text entered by the user is displayed verbatim, but PySide.QtGui.QLineEdit also supports modes that allow the entered text to be suppressed or obscured: these include NoEcho , Password and PasswordEchoOnEdit .

The widget’s display and the ability to copy or drag the text is affected by this setting.

By default, this property is set to Normal .

See also

QLineEdit.EchoMode PySide.QtGui.QLineEdit.displayText()

PySide.QtGui.QLineEdit.setFrame(arg__1)¶

Parameters:	arg__1 – `PySide.QtCore.bool`

This property holds whether the line edit draws itself with a frame.

If enabled (the default) the line edit draws itself inside a frame, otherwise the line edit draws itself without any frame.

PySide.QtGui.QLineEdit.setInputMask(inputMask)¶

Parameters:	inputMask – unicode

This property holds The validation input mask.

If no mask is set, PySide.QtGui.QLineEdit.inputMask() returns an empty string.

Sets the PySide.QtGui.QLineEdit ‘s validation mask. Validators can be used instead of, or in conjunction with masks; see PySide.QtGui.QLineEdit.setValidator() .

Unset the mask and return to normal PySide.QtGui.QLineEdit operation by passing an empty string (“”) or just calling PySide.QtGui.QLineEdit.setInputMask() with no arguments.

The table below shows the characters that can be used in an input mask. A space character, the default character for a blank, is needed for cases where a character is permitted but not required .

Character	Meaning
`A`	ASCII alphabetic character required. A-Z, a-z.
`a`	ASCII alphabetic character permitted but not required.
`N`	ASCII alphanumeric character required. A-Z, a-z, 0-9.
`n`	ASCII alphanumeric character permitted but not required.
`X`	Any character required.
`x`	Any character permitted but not required.
`9`	ASCII digit required. 0-9.
`0`	ASCII digit permitted but not required.
`D`	ASCII digit required. 1-9.
`d`	ASCII digit permitted but not required (1-9).
`#`	ASCII digit or plus/minus sign permitted but not required.
`H`	Hexadecimal character required. A-F, a-f, 0-9.
`h`	Hexadecimal character permitted but not required.
`B`	Binary character required. 0-1.
`b`	Binary character permitted but not required.
`>`	All following alphabetic characters are uppercased.
`<`	All following alphabetic characters are lowercased.
`!`	Switch off case conversion.
`\`	Use `\` to escape the special characters listed above to use them as separators.

The mask consists of a string of mask characters and separators, optionally followed by a semicolon and the character used for blanks. The blank characters are always removed from the text after editing.

Examples:

Mask	Notes
`000.000.000.000;_`	IP address; blanks are `_` .
`HH:HH:HH:HH:HH:HH;_`	MAC address
`0000-00-00`	ISO Date; blanks are `space`
`>AAAAA-AAAAA-AAAAA-AAAAA-AAAAA;#`	License number; blanks are `-` and all (alphabetic) characters are converted to uppercase.

To get range control (e.g., for an IP address) use masks together with validators .

See also

PySide.QtGui.QLineEdit.maxLength()

PySide.QtGui.QLineEdit.setMaxLength(arg__1)¶

Parameters:	arg__1 – `PySide.QtCore.int`

This property holds the maximum permitted length of the text.

If the text is too long, it is truncated at the limit.

If truncation occurs any selected text will be unselected, the cursor position is set to 0 and the first part of the string is shown.

If the line edit has an input mask, the mask defines the maximum string length.

By default, this property contains a value of 32767.

See also

PySide.QtGui.QLineEdit.inputMask()

PySide.QtGui.QLineEdit.setModified(arg__1)¶

Parameters:	arg__1 – `PySide.QtCore.bool`

This property holds whether the line edit’s contents has been modified by the user.

The modified flag is never read by PySide.QtGui.QLineEdit ; it has a default value of false and is changed to true whenever the user changes the line edit’s contents.

This is useful for things that need to provide a default value but do not start out knowing what the default should be (perhaps it depends on other fields on the form). Start the line edit without the best default, and when the default is known, if modified() returns false (the user hasn’t entered any text), insert the default value.

Calling PySide.QtGui.QLineEdit.setText() resets the modified flag to false.

PySide.QtGui.QLineEdit.setPlaceholderText(arg__1)¶

Parameters:	arg__1 – unicode

This property holds the line edit’s placeholder text.

Setting this property makes the line edit display a grayed-out placeholder text as long as the PySide.QtGui.QLineEdit.text() is empty and the widget doesn’t have focus.

By default, this property contains an empty string.

See also

PySide.QtGui.QLineEdit.text()

PySide.QtGui.QLineEdit.setReadOnly(arg__1)¶

Parameters:	arg__1 – `PySide.QtCore.bool`

This property holds whether the line edit is read only..

In read-only mode, the user can still copy the text to the clipboard, or drag and drop the text (if PySide.QtGui.QLineEdit.echoMode() is Normal ), but cannot edit it.

PySide.QtGui.QLineEdit does not show a cursor in read-only mode.

By default, this property is false.

See also

PySide.QtGui.QWidget.setEnabled()

PySide.QtGui.QLineEdit.setSelection(arg__1, arg__2)¶

Parameters:	arg__1 – `PySide.QtCore.int` arg__2 – `PySide.QtCore.int`

Selects text from position start and for length characters. Negative lengths are allowed.

PySide.QtGui.QLineEdit.setText(arg__1)¶

Parameters:	arg__1 – unicode

This property holds the line edit’s text.

Setting this property clears the selection, clears the undo/redo history, moves the cursor to the end of the line and resets the modified() property to false. The text is not validated when inserted with PySide.QtGui.QLineEdit.setText() .

The text is truncated to PySide.QtGui.QLineEdit.maxLength() length.

By default, this property contains an empty string.

PySide.QtGui.QLineEdit.setTextMargins(left, top, right, bottom)¶

Parameters:	left – `PySide.QtCore.int` top – `PySide.QtCore.int` right – `PySide.QtCore.int` bottom – `PySide.QtCore.int`

Sets the margins around the text inside the frame to have the sizes left , top , right , and bottom .

See also

PySide.QtGui.QLineEdit.textMargins()

PySide.QtGui.QLineEdit.setTextMargins(margins)

Parameters:	margins – `PySide.QtCore.QMargins`

Sets the margins around the text inside the frame.

PySide.QtGui.QLineEdit.setValidator(arg__1)¶

Parameters:	arg__1 – `PySide.QtGui.QValidator`

Sets this line edit to only accept input that the validator, v , will accept. This allows you to place any arbitrary constraints on the text which may be entered.

If v == 0, PySide.QtGui.QLineEdit.setValidator() removes the current input validator. The initial setting is to have no input validator (i.e. any input is accepted up to PySide.QtGui.QLineEdit.maxLength() ).

PySide.QtGui.QLineEdit.text()¶

Return type:	unicode

This property holds the line edit’s text.

Setting this property clears the selection, clears the undo/redo history, moves the cursor to the end of the line and resets the modified() property to false. The text is not validated when inserted with PySide.QtGui.QLineEdit.setText() .

The text is truncated to PySide.QtGui.QLineEdit.maxLength() length.

By default, this property contains an empty string.

PySide.QtGui.QLineEdit.textChanged(arg__1)¶

Parameters:	arg__1 – unicode

PySide.QtGui.QLineEdit.textEdited(arg__1)¶

Parameters:	arg__1 – unicode

PySide.QtGui.QLineEdit.textMargins()¶

Return type:	`PySide.QtCore.QMargins`

Returns the widget’s text margins.

PySide.QtGui.QLineEdit.undo()¶: Undoes the last operation if undo is available . Deselects any current selection, and updates the selection start to the current cursor position.

PySide.QtGui.QLineEdit.validator()¶

Return type:	`PySide.QtGui.QValidator`

Returns a pointer to the current input validator, or 0 if no validator has been set.

See also

PySide.QtGui.QLineEdit.setValidator()

Table Of Contents

Previous topic

Next topic

QLineEdit¶

Synopsis¶

Functions¶

Slots¶

Signals¶

Detailed Description¶

Keypress	Action
Left Arrow	Moves the cursor one character to the left.
Shift+Left Arrow	Moves and selects text one character to the left.
Right Arrow	Moves the cursor one character to the right.
Shift+Right Arrow	Moves and selects text one character to the right.
Home	Moves the cursor to the beginning of the line.
End	Moves the cursor to the end of the line.
Backspace	Deletes the character to the left of the cursor.
Ctrl+Backspace	Deletes the word to the left of the cursor.
Delete	Deletes the character to the right of the cursor.
Ctrl+Delete	Deletes the word to the right of the cursor.
Ctrl+A	Select all.
Ctrl+C	Copies the selected text to the clipboard.
Ctrl+Insert	Copies the selected text to the clipboard.
Ctrl+K	Deletes to the end of the line.
Ctrl+V	Pastes the clipboard text into line edit.
Shift+Insert	Pastes the clipboard text into line edit.
Ctrl+X	Deletes the selected text and copies it to the clipboard.
Shift+Delete	Deletes the selected text and copies it to the clipboard.
Ctrl+Z	Undoes the last operation.
Ctrl+Y	Redoes the last undone operation.

	A line edit shown in the Macintosh widget style .
	A line edit shown in the Windows XP widget style .
	A line edit shown in the Plastique widget style .

Table Of Contents

Previous topic

Next topic

Quick search

QLineEdit¶

Synopsis¶

Functions¶

Slots¶

Signals¶

Detailed Description¶