The QLineEdit widget is a one-line text editor. More...

#include <qlineedit.h>

Inheritance diagram for QLineEdit:

Collaboration diagram for QLineEdit:

Public Types
enum	ActionPosition { LeadingPosition , TrailingPosition }
	This enum type describes how a line edit should display the action widgets to be added. More...

enum	EchoMode { Normal , NoEcho , Password , PasswordEchoOnEdit }
	This enum type describes how a line edit should display its contents. More...

Public Types inherited from QWidget
enum	RenderFlag { DrawWindowBackground = 0x1 , DrawChildren = 0x2 , IgnoreMask = 0x4 }
	This enum describes how to render the widget when calling QWidget::render(). More...

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric { PdmWidth = 1 , PdmHeight , PdmWidthMM , PdmHeightMM , PdmNumColors , PdmDepth , PdmDpiX , PdmDpiY , PdmPhysicalDpiX , PdmPhysicalDpiY , PdmDevicePixelRatio , PdmDevicePixelRatioScaled }

Public Slots
void	setText (const QString &)

void	clear ()
	Clears the contents of the line edit.

void	selectAll ()
	Selects all the text (i.e.

void	undo ()
	Undoes the last operation if undo is \l{QLineEdit::undoAvailable}{available}.

void	redo ()
	Redoes the last operation if redo is \l{QLineEdit::redoAvailable}{available}.

void	cut ()
	Copies the selected text to the clipboard and deletes it, if there is any, and if echoMode() is \l Normal.

void	copy () const
	Copies the selected text to the clipboard, if there is any, and if echoMode() is \l Normal.

void	paste ()
	Inserts the clipboard's text at the cursor position, deleting any selected text, providing the line edit is not \l{QLineEdit::readOnly}{read-only}.

Public Slots inherited from QWidget
void	setEnabled (bool)

void	setDisabled (bool)
	Disables widget input events if disable is true; otherwise enables input events.

void	setWindowModified (bool)

void	setWindowTitle (const QString &)

void	setStyleSheet (const QString &styleSheet)

void	setFocus ()
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}.

void	update ()
	Updates the widget unless updates are disabled or the widget is hidden.

void	repaint ()
	Repaints the widget directly by calling paintEvent() immediately, unless updates are disabled or the widget is hidden.

virtual void	setVisible (bool visible)

void	setHidden (bool hidden)
	Convenience function, equivalent to setVisible(!hidden).

void	show ()
	Shows the widget and its child widgets.

void	hide ()
	Hides the widget.

void	showMinimized ()
	Shows the widget minimized, as an icon.

void	showMaximized ()
	Shows the widget maximized.

void	showFullScreen ()
	Shows the widget in full-screen mode.

void	showNormal ()
	Restores the widget after it has been maximized or minimized.

bool	close ()
	Closes this widget.

void	raise ()
	Raises this widget to the top of the parent widget's stack.

void	lower ()
	Lowers the widget to the bottom of the parent widget's stack.

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	textChanged (const QString &)
	This signal is emitted whenever the text changes.

void	textEdited (const QString &)
	This signal is emitted whenever the text is edited.

void	cursorPositionChanged (int, int)
	This signal is emitted whenever the cursor moves.

void	returnPressed ()
	This signal is emitted when the Return or Enter key is pressed.

void	editingFinished ()
	This signal is emitted when the Return or Enter key is pressed, or if the line edit loses focus and its contents have changed since the last time this signal was emitted.

void	selectionChanged ()
	This signal is emitted whenever the selection changes.

void	inputRejected ()

Signals inherited from QWidget
void	windowTitleChanged (const QString &title)
	This signal is emitted when the window's title has changed, with the new title as an argument.

void	windowIconChanged (const QIcon &icon)
	This signal is emitted when the window's icon has changed, with the new icon as an argument.

void	windowIconTextChanged (const QString &iconText)
	This signal is emitted when the window's icon text has changed, with the new iconText as an argument.

void	customContextMenuRequested (const QPoint &pos)
	This signal is emitted when the widget's \l contextMenuPolicy is Qt::CustomContextMenu, and the user has requested a context menu on the widget.

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QLineEdit (QWidget *parent=nullptr)
	Constructs a line edit with no text.

	QLineEdit (const QString &, QWidget *parent=nullptr)
	Constructs a line edit containing the text contents.

	~QLineEdit ()
	Destroys the line edit.

QString	text () const

QString	displayText () const

QString	placeholderText () const

void	setPlaceholderText (const QString &)

int	maxLength () const

void	setMaxLength (int)

void	setFrame (bool)

bool	hasFrame () const

void	setClearButtonEnabled (bool enable)

bool	isClearButtonEnabled () const

EchoMode	echoMode () const

void	setEchoMode (EchoMode)

bool	isReadOnly () const

void	setReadOnly (bool)

void	setValidator (const QValidator *)
	Sets the validator for values of line edit to v.

const QValidator *	validator () const
	Returns a pointer to the current input validator, or \nullptr if no validator has been set.

QSize	sizeHint () const override
	Returns a recommended size for the widget.

QSize	minimumSizeHint () const override
	Returns a minimum size for the line edit.

int	cursorPosition () const

void	setCursorPosition (int)

int	cursorPositionAt (const QPoint &pos)
	Returns the cursor position under the point pos.

void	setAlignment (Qt::Alignment flag)

Qt::Alignment	alignment () const

void	cursorForward (bool mark, int steps=1)
	Moves the cursor forward steps characters.

void	cursorBackward (bool mark, int steps=1)
	Moves the cursor back steps characters.

void	cursorWordForward (bool mark)
	Moves the cursor one word forward.

void	cursorWordBackward (bool mark)
	Moves the cursor one word backward.

void	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.

void	del ()
	If no text is selected, deletes the character to the right of the text cursor.

void	home (bool mark)
	Moves the text cursor to the beginning of the line unless it is already there.

void	end (bool mark)
	Moves the text cursor to the end of the line unless it is already there.

bool	isModified () const

void	setModified (bool)

void	setSelection (int, int)
	Selects text from position start and for length characters.

bool	hasSelectedText () const

QString	selectedText () const

int	selectionStart () const
	Returns the index of the first selected character in the line edit or -1 if no text is selected.

int	selectionEnd () const
	Returns the index of the character directly after the selection in the line edit or -1 if no text is selected.

int	selectionLength () const
	Returns the length of the selection.

bool	isUndoAvailable () const

bool	isRedoAvailable () const

void	setDragEnabled (bool b)

bool	dragEnabled () const

void	setCursorMoveStyle (Qt::CursorMoveStyle style)

Qt::CursorMoveStyle	cursorMoveStyle () const

QString	inputMask () const

void	setInputMask (const QString &inputMask)

bool	hasAcceptableInput () const

void	setTextMargins (int left, int top, int right, int bottom)
	Sets the margins around the text inside the frame to have the sizes left, top, right, and bottom.

void	setTextMargins (const QMargins &margins)

QMargins	textMargins () const

void	deselect ()
	Deselects any selected text.

void	insert (const QString &)
	Deletes any selected text, inserts newText, and validates the result.

QMenu *	createStandardContextMenu ()
	This function creates the standard context menu which is shown when the user clicks on the line edit with the right mouse button.

QVariant	inputMethodQuery (Qt::InputMethodQuery) const override
	\reimp

Q_INVOKABLE QVariant	inputMethodQuery (Qt::InputMethodQuery property, QVariant argument) const

void	timerEvent (QTimerEvent *) override
	\reimp

bool	event (QEvent *) override
	\reimp

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
	Constructs a widget which is a child of parent, with widget flags set to f.

	~QWidget ()
	Destroys the widget.

int	devType () const override

WId	winId () const
	Returns the window system identifier of the widget.

void	createWinId ()

WId	internalWinId () const

WId	effectiveWinId () const

QStyle *	style () const

void	setStyle (QStyle *)
	Sets the widget's GUI style to style.

bool	isWindow () const
	Returns `true` if the widget is an independent window, otherwise returns `false`.

bool	isModal () const

Qt::WindowModality	windowModality () const

void	setWindowModality (Qt::WindowModality windowModality)

bool	isEnabled () const

bool	isEnabledTo (const QWidget *) const
	Returns `true` if this widget would become enabled if ancestor is enabled; otherwise returns `false`.

QRect	frameGeometry () const

const QRect &	geometry () const

QRect	normalGeometry () const

int	x () const

int	y () const

QPoint	pos () const

QSize	frameSize () const

QSize	size () const

int	width () const

int	height () const

QRect	rect () const

QRect	childrenRect () const

QRegion	childrenRegion () const

QSize	minimumSize () const

QSize	maximumSize () const

int	minimumWidth () const

int	minimumHeight () const

int	maximumWidth () const

int	maximumHeight () const

void	setMinimumSize (const QSize &)

void	setMinimumSize (int minw, int minh)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMinimumSize(QSize(minw, minh)).

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMaximumSize(QSize(maxw, maxh)).

void	setMinimumWidth (int minw)

void	setMinimumHeight (int minh)

void	setMaximumWidth (int maxw)

void	setMaximumHeight (int maxh)

QSize	sizeIncrement () const

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the x (width) size increment to w and the y (height) size increment to h.

QSize	baseSize () const

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setBaseSize(QSize(basew, baseh)).

void	setFixedSize (const QSize &)
	Sets both the minimum and maximum sizes of the widget to s, thereby preventing it from ever growing or shrinking.

void	setFixedSize (int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the width of the widget to w and the height to h.

void	setFixedWidth (int w)
	Sets both the minimum and maximum width of the widget to w without changing the heights.

void	setFixedHeight (int h)
	Sets both the minimum and maximum heights of the widget to h without changing the widths.

QPointF	mapToGlobal (const QPointF &) const
	Translates the widget coordinate pos to global screen coordinates.

QPoint	mapToGlobal (const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapFromGlobal (const QPointF &) const
	Translates the global screen coordinate pos to widget coordinates.

QPoint	mapFromGlobal (const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapToParent (const QPointF &) const
	Translates the widget coordinate pos to a coordinate in the parent widget.

QPoint	mapToParent (const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapFromParent (const QPointF &) const
	Translates the parent widget coordinate pos to widget coordinates.

QPoint	mapFromParent (const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapTo (const QWidget *, const QPointF &) const
	Translates the widget coordinate pos to the coordinate system of parent.

QPoint	mapTo (const QWidget *, const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapFrom (const QWidget *, const QPointF &) const
	Translates the widget coordinate pos from the coordinate system of parent to this widget's coordinate system.

QPoint	mapFrom (const QWidget *, const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QWidget *	window () const
	Returns the window for this widget, i.e.

QWidget *	nativeParentWidget () const

QWidget *	topLevelWidget () const

const QPalette &	palette () const

void	setPalette (const QPalette &)

void	setBackgroundRole (QPalette::ColorRole)
	Sets the background role of the widget to role.

QPalette::ColorRole	backgroundRole () const
	Returns the background role of the widget.

void	setForegroundRole (QPalette::ColorRole)
	Sets the foreground role of the widget to role.

QPalette::ColorRole	foregroundRole () const
	Returns the foreground role.

const QFont &	font () const

void	setFont (const QFont &)

QFontMetrics	fontMetrics () const
	Returns the font metrics for the widget's current font.

QFontInfo	fontInfo () const
	Returns the font info for the widget's current font.

QCursor	cursor () const

void	setCursor (const QCursor &)

void	unsetCursor ()

void	setMouseTracking (bool enable)

bool	hasMouseTracking () const

bool	underMouse () const
	Returns `true` if the widget is under the mouse cursor; otherwise returns `false`.

void	setTabletTracking (bool enable)

bool	hasTabletTracking () const

void	setMask (const QBitmap &)
	Causes only the pixels of the widget for which bitmap has a corresponding 1 bit to be visible.

void	setMask (const QRegion &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Causes only the parts of the widget which overlap region to be visible.

QRegion	mask () const
	Returns the mask currently set on a widget.

void	clearMask ()
	Removes any mask set by setMask().

void	render (QPaintDevice *target, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground\|DrawChildren))

void	render (QPainter *painter, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground\|DrawChildren))
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Renders the widget into the painter's QPainter::device().

Q_INVOKABLE QPixmap	grab (const QRect &rectangle=QRect(QPoint(0, 0), QSize(-1, -1)))

void	grabGesture (Qt::GestureType type, Qt::GestureFlags flags=Qt::GestureFlags())
	Subscribes the widget to a given gesture with specific flags.

void	ungrabGesture (Qt::GestureType type)
	Unsubscribes the widget from a given gesture type.

QString	styleSheet () const

QString	windowTitle () const

void	setWindowIcon (const QIcon &icon)

QIcon	windowIcon () const

void	setWindowIconText (const QString &)

QString	windowIconText () const

void	setWindowRole (const QString &)
	Sets the window's role to role.

QString	windowRole () const
	Returns the window's role, or an empty string.

void	setWindowFilePath (const QString &filePath)

QString	windowFilePath () const

void	setWindowOpacity (qreal level)

qreal	windowOpacity () const

bool	isWindowModified () const

void	setLayoutDirection (Qt::LayoutDirection direction)

Qt::LayoutDirection	layoutDirection () const

void	unsetLayoutDirection ()

void	setLocale (const QLocale &locale)

QLocale	locale () const

void	unsetLocale ()

bool	isRightToLeft () const

bool	isLeftToRight () const

bool	isActiveWindow () const

void	activateWindow ()
	Sets the top-level widget containing this widget to be the active window.

void	clearFocus ()
	Takes keyboard input focus from the widget.

void	setFocus (Qt::FocusReason reason)
	Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}.

Qt::FocusPolicy	focusPolicy () const

void	setFocusPolicy (Qt::FocusPolicy policy)

bool	hasFocus () const

void	setFocusProxy (QWidget *)
	Sets the widget's focus proxy to widget w.

QWidget *	focusProxy () const
	Returns the focus proxy, or \nullptr if there is no focus proxy.

Qt::ContextMenuPolicy	contextMenuPolicy () const

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	grabMouse ()
	Grabs the mouse input.

void	grabMouse (const QCursor &)

void	releaseMouse ()
	Releases the mouse grab.

void	grabKeyboard ()
	Grabs the keyboard input.

void	releaseKeyboard ()
	Releases the keyboard grab.

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context=Qt::WindowShortcut)
	Adds a shortcut to Qt's shortcut system that watches for the given key sequence in the given context.

void	releaseShortcut (int id)
	Removes the shortcut with the given id from Qt's shortcut system.

void	setShortcutEnabled (int id, bool enable=true)
	If enable is true, the shortcut with the given id is enabled; otherwise the shortcut is disabled.

void	setShortcutAutoRepeat (int id, bool enable=true)

bool	updatesEnabled () const

void	setUpdatesEnabled (bool enable)

void	update (int x, int y, int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle (x, y, w, h) inside the widget.

void	update (const QRect &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle rect inside the widget.

void	update (const QRegion &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget.

void	repaint (int x, int y, int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle (x, y, w, h) inside the widget.

void	repaint (const QRect &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle rect inside the widget.

void	repaint (const QRegion &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget.

void	stackUnder (QWidget *)
	Places the widget under w in the parent widget's stack.

void	move (int x, int y)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to move(QPoint(x, y)).

void	move (const QPoint &)

void	resize (int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to resize(QSize(w, h)).

void	resize (const QSize &)

void	setGeometry (int x, int y, int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setGeometry(QRect(x, y, w, h)).

void	setGeometry (const QRect &)

QByteArray	saveGeometry () const

bool	restoreGeometry (const QByteArray &geometry)

void	adjustSize ()
	Adjusts the size of the widget to fit its contents.

bool	isVisible () const

bool	isVisibleTo (const QWidget *) const
	Returns `true` if this widget would become visible if ancestor is shown; otherwise returns `false`.

bool	isHidden () const
	Returns `true` if the widget is hidden, otherwise returns `false`.

bool	isMinimized () const

bool	isMaximized () const

bool	isFullScreen () const

Qt::WindowStates	windowState () const
	Returns the current window state.

void	setWindowState (Qt::WindowStates state)
	Sets the window state to windowState.

void	overrideWindowState (Qt::WindowStates state)

virtual QSize	sizeHint () const

virtual QSize	minimumSizeHint () const

QSizePolicy	sizePolicy () const

void	setSizePolicy (QSizePolicy)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the size policy of the widget to horizontal and vertical, with standard stretch and no height-for-width.

virtual int	heightForWidth (int) const
	Returns the preferred height for this widget, given the width w.

virtual bool	hasHeightForWidth () const

QRegion	visibleRegion () const
	Returns the unobscured region where paint events can occur.

void	setContentsMargins (int left, int top, int right, int bottom)
	Sets the margins around the contents of the widget to have the sizes left, top, right, and bottom.

void	setContentsMargins (const QMargins &margins)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QMargins	contentsMargins () const
	The contentsMargins function returns the widget's contents margins.

QRect	contentsRect () const
	Returns the area inside the widget's margins.

QLayout *	layout () const
	Returns the layout manager that is installed on this widget, or \nullptr if no layout manager is installed.

void	setLayout (QLayout *)
	Sets the layout manager for this widget to layout.

void	updateGeometry ()
	Notifies the layout system that this widget has changed and may need to change geometry.

void	setParent (QWidget *parent)
	Sets the parent of the widget to parent, and resets the window flags.

void	setParent (QWidget *parent, Qt::WindowFlags f)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function also takes widget flags, f as an argument.

void	scroll (int dx, int dy)
	Scrolls the widget including its children dx pixels to the right and dy downward.

void	scroll (int dx, int dy, const QRect &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version only scrolls r and does not move the children of the widget.

QWidget *	focusWidget () const
	Returns the last child of this widget that setFocus had been called on.

QWidget *	nextInFocusChain () const
	Returns the next widget in this widget's focus chain.

QWidget *	previousInFocusChain () const
	The previousInFocusChain function returns the previous widget in this widget's focus chain.

bool	acceptDrops () const

void	setAcceptDrops (bool on)

void	addAction (QAction *action)
	Appends the action action to this widget's list of actions.

void	addActions (const QList< QAction * > &actions)
	Appends the actions actions to this widget's list of actions.

void	insertActions (QAction before, const QList< QAction > &actions)
	Inserts the actions actions to this widget's list of actions, before the action before.

void	insertAction (QAction before, QAction action)
	Inserts the action action to this widget's list of actions, before the action before.

void	removeAction (QAction *action)
	Removes the action action from this widget's list of actions.

QList< QAction * >	actions () const
	Returns the (possibly empty) list of this widget's actions.

QAction *	addAction (const QString &text)

QAction *	addAction (const QIcon &icon, const QString &text)

QAction *	addAction (const QString &text, const QObject receiver, const char member, Qt::ConnectionType type=Qt::AutoConnection)

QAction *	addAction (const QIcon &icon, const QString &text, const QObject receiver, const char member, Qt::ConnectionType type=Qt::AutoConnection)

template<typename... Args, typename = compatible_action_slot_args<Args...>>
QAction *	addAction (const QString &text, Args &&...args)

template<typename... Args, typename = compatible_action_slot_args<Args...>>
QAction *	addAction (const QIcon &icon, const QString &text, Args &&...args)

QWidget *	parentWidget () const
	Returns the parent of this widget, or \nullptr if it does not have any parent widget.

void	setWindowFlags (Qt::WindowFlags type)

Qt::WindowFlags	windowFlags () const
	Window flags are a combination of a type (e.g.

void	setWindowFlag (Qt::WindowType, bool on=true)

void	overrideWindowFlags (Qt::WindowFlags type)
	Sets the window flags for the widget to flags, without telling the window system.

Qt::WindowType	windowType () const
	Returns the window type of this widget.

QWidget *	childAt (int x, int y) const
	Returns the visible child widget at the position ({x}, {y}) in the widget's coordinate system.

QWidget *	childAt (const QPoint &p) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns the visible child widget at point p in the widget's own coordinate system.

void	setAttribute (Qt::WidgetAttribute, bool on=true)
	Sets the attribute attribute on this widget if on is true; otherwise clears the attribute.

bool	testAttribute (Qt::WidgetAttribute) const
	Returns `true` if attribute attribute is set on this widget; otherwise returns `false`.

QPaintEngine *	paintEngine () const override
	Returns the widget's paint engine.

void	ensurePolished () const
	Ensures that the widget and its children have been polished by QStyle (i.e., have a proper font and palette).

bool	isAncestorOf (const QWidget *child) const
	Returns `true` if this widget is a parent, (or grandparent and so on to any level), of the given child, and both widgets are within the same window; otherwise returns `false`.

bool	autoFillBackground () const

void	setAutoFillBackground (bool enabled)

QBackingStore *	backingStore () const

QWindow *	windowHandle () const
	If this is a native widget, return the associated QWindow.

QScreen *	screen () const
	Returns the screen the widget is on.

void	setScreen (QScreen *)
	Sets the screen on which the widget should be shown to screen.

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery) const
	This method is only relevant for input widgets.

Qt::InputMethodHints	inputMethodHints () const

void	setInputMethodHints (Qt::InputMethodHints hints)

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()

virtual int	devType () const

bool	paintingActive () const

virtual QPaintEngine *	paintEngine () const =0

int	width () const

int	height () const

int	widthMM () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

int	physicalDpiX () const

int	physicalDpiY () const

qreal	devicePixelRatio () const

qreal	devicePixelRatioF () const

int	colorCount () const

int	depth () const

Protected Member Functions
void	mousePressEvent (QMouseEvent *) override
	\reimp

void	mouseMoveEvent (QMouseEvent *) override
	\reimp

void	mouseReleaseEvent (QMouseEvent *) override
	\reimp

void	mouseDoubleClickEvent (QMouseEvent *) override
	\reimp

void	keyPressEvent (QKeyEvent *) override
	Converts the given key press event into a line edit action.

void	keyReleaseEvent (QKeyEvent *) override
	\reimp

void	focusInEvent (QFocusEvent *) override
	\reimp

void	focusOutEvent (QFocusEvent *) override
	\reimp

void	paintEvent (QPaintEvent *) override
	\reimp

void	changeEvent (QEvent *) override
	\reimp

void	contextMenuEvent (QContextMenuEvent *) override
	Shows the standard context menu created with createStandardContextMenu().

void	inputMethodEvent (QInputMethodEvent *) override
	\reimp

virtual void	initStyleOption (QStyleOptionFrame *option) const
	Initialize option with the values from this QLineEdit.

QRect	cursorRect () const

Protected Member Functions inherited from QWidget
bool	event (QEvent *event) override
	This is the main event handler; it handles event event.

virtual void	mousePressEvent (QMouseEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive mouse press events for the widget.

virtual void	mouseReleaseEvent (QMouseEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive mouse release events for the widget.

virtual void	mouseDoubleClickEvent (QMouseEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive mouse double click events for the widget.

virtual void	mouseMoveEvent (QMouseEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive mouse move events for the widget.

virtual void	keyPressEvent (QKeyEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive key press events for the widget.

virtual void	keyReleaseEvent (QKeyEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive key release events for the widget.

virtual void	focusInEvent (QFocusEvent *event)
	This event handler can be reimplemented in a subclass to receive keyboard focus events (focus received) for the widget.

virtual void	focusOutEvent (QFocusEvent *event)
	This event handler can be reimplemented in a subclass to receive keyboard focus events (focus lost) for the widget.

virtual void	enterEvent (QEnterEvent *event)
	This event handler can be reimplemented in a subclass to receive widget enter events which are passed in the event parameter.

virtual void	leaveEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive widget leave events which are passed in the event parameter.

virtual void	paintEvent (QPaintEvent *event)
	This event handler can be reimplemented in a subclass to receive paint events passed in event.

virtual void	moveEvent (QMoveEvent *event)
	This event handler can be reimplemented in a subclass to receive widget move events which are passed in the event parameter.

virtual void	resizeEvent (QResizeEvent *event)
	This event handler can be reimplemented in a subclass to receive widget resize events which are passed in the event parameter.

virtual void	closeEvent (QCloseEvent *event)
	This event handler is called with the given event when Qt receives a window close request for a top-level widget from the window system.

virtual void	contextMenuEvent (QContextMenuEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive widget context menu events.

virtual void	actionEvent (QActionEvent *event)
	This event handler is called with the given event whenever the widget's actions are changed.

virtual void	showEvent (QShowEvent *event)
	This event handler can be reimplemented in a subclass to receive widget show events which are passed in the event parameter.

virtual void	hideEvent (QHideEvent *event)
	This event handler can be reimplemented in a subclass to receive widget hide events.

virtual bool	nativeEvent (const QByteArray &eventType, void message, qintptr result)
	This special event handler can be reimplemented in a subclass to receive native platform events identified by eventType which are passed in the message parameter.

virtual void	changeEvent (QEvent *)
	This event handler can be reimplemented to handle state changes.

int	metric (PaintDeviceMetric) const override
	Internal implementation of the virtual QPaintDevice::metric() function.

void	initPainter (QPainter *painter) const override
	Initializes the painter pen, background and font to the same as the given widget's.

QPaintDevice *	redirected (QPoint *offset) const override

QPainter *	sharedPainter () const override

virtual void	inputMethodEvent (QInputMethodEvent *)
	This event handler, for event event, can be reimplemented in a subclass to receive Input Method composition events.

void	create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true)
	Creates a new widget window.

void	destroy (bool destroyWindow=true, bool destroySubWindows=true)
	Frees up window system resources.

virtual bool	focusNextPrevChild (bool next)
	Finds a new widget to give the keyboard focus to, as appropriate for Tab and Shift+Tab, and returns `true` if it can find a new widget, or false if it can't.

bool	focusNextChild ()
	Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Tab, and returns `true` if it can find a new widget, or false if it can't.

bool	focusPreviousChild ()
	Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Shift+Tab, and returns `true` if it can find a new widget, or false if it can't.

	QWidget (QWidgetPrivate &d, QWidget *parent, Qt::WindowFlags f)

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Member Functions inherited from QPaintDevice
	QPaintDevice () noexcept

virtual int	metric (PaintDeviceMetric metric) const

virtual void	initPainter (QPainter *painter) const

virtual QPaintDevice *	redirected (QPoint *offset) const

virtual QPainter *	sharedPainter () const

Properties
QString	inputMask
	The validation input mask.

QString	text
	the line edit's text.

int	maxLength
	the maximum permitted length of the text.

bool	frame
	whether the line edit draws itself with a frame.

EchoMode	echoMode
	the line edit's echo mode.

QString	displayText
	the displayed text.

int	cursorPosition
	the current cursor position for this line edit.

Qt::Alignment	alignment
	the alignment of the line edit.

bool	modified
	whether the line edit's contents has been modified by the user.

bool	hasSelectedText
	whether there is any text selected.

QString	selectedText
	the selected text.

bool	dragEnabled
	whether the lineedit starts a drag if the user presses and moves the mouse on some selected text.

bool	readOnly
	whether the line edit is read only.

bool	undoAvailable
	whether undo is available.

bool	redoAvailable
	whether redo is available.

bool	acceptableInput
	whether the input satisfies the inputMask and the validator.

QString	placeholderText
	the line edit's placeholder text.

Qt::CursorMoveStyle	cursorMoveStyle
	the movement style of cursor in this line edit.

bool	clearButtonEnabled
	Whether the line edit displays a clear button when it is not empty.

Properties inherited from QWidget
bool	modal
	whether the widget is a modal widget

Qt::WindowModality	windowModality
	which windows are blocked by the modal widget

bool	enabled
	whether the widget is enabled

QRect	geometry
	the geometry of the widget relative to its parent and excluding the window frame

QRect	frameGeometry
	geometry of the widget relative to its parent including any window frame

QRect	normalGeometry
	the geometry of the widget as it will appear when shown as a normal (not maximized or full screen) top-level widget

int	x
	the x coordinate of the widget relative to its parent including any window frame

int	y
	the y coordinate of the widget relative to its parent and including any window frame

QPoint	pos
	the position of the widget within its parent widget

QSize	frameSize
	the size of the widget including any window frame

QSize	size
	the size of the widget excluding any window frame

int	width
	the width of the widget excluding any window frame

int	height
	the height of the widget excluding any window frame

QRect	rect
	the internal geometry of the widget excluding any window frame

QRect	childrenRect
	the bounding rectangle of the widget's children

QRegion	childrenRegion
	the combined region occupied by the widget's children

QSizePolicy	sizePolicy
	the default layout behavior of the widget

QSize	minimumSize
	the widget's minimum size

QSize	maximumSize
	the widget's maximum size in pixels

int	minimumWidth
	the widget's minimum width in pixels

int	minimumHeight
	the widget's minimum height in pixels

int	maximumWidth
	the widget's maximum width in pixels

int	maximumHeight
	the widget's maximum height in pixels

QSize	sizeIncrement
	the size increment of the widget

QSize	baseSize
	the base size of the widget

QPalette	palette
	the widget's palette

QFont	font
	the font currently set for the widget

QCursor	cursor
	the cursor shape for this widget

bool	mouseTracking
	whether mouse tracking is enabled for the widget

bool	tabletTracking
	whether tablet tracking is enabled for the widget

bool	isActiveWindow
	whether this widget's window is the active window

Qt::FocusPolicy	focusPolicy
	the way the widget accepts keyboard focus

bool	focus
	whether this widget (or its focus proxy) has the keyboard input focus

Qt::ContextMenuPolicy	contextMenuPolicy
	how the widget shows a context menu

bool	updatesEnabled
	whether updates are enabled

bool	visible
	whether the widget is visible

bool	minimized
	whether this widget is minimized (iconified)

bool	maximized
	whether this widget is maximized

bool	fullScreen
	whether the widget is shown in full screen mode

QSize	sizeHint
	the recommended size for the widget

QSize	minimumSizeHint
	the recommended minimum size for the widget

bool	acceptDrops
	whether drop events are enabled for this widget

QString	windowTitle
	the window title (caption)

QIcon	windowIcon
	the widget's icon

QString	windowIconText
	the text to be displayed on the icon of a minimized window

double	windowOpacity
	The level of opacity for the window.

bool	windowModified
	whether the document shown in the window has unsaved changes

Qt::LayoutDirection	layoutDirection
	the layout direction for this widget.

bool	autoFillBackground
	whether the widget background is filled automatically

QString	styleSheet
	the widget's style sheet

QLocale	locale
	the widget's locale

QString	windowFilePath
	the file path associated with a widget

Qt::InputMethodHints	inputMethodHints
	What input method specific hints the widget has.

Properties inherited from QObject
QString	objectName
	the name of this object

Friends
class	QAbstractSpinBox

class	QAccessibleLineEdit

class	QComboBox

Additional Inherited Members
Static Public Member Functions inherited from QWidget
static void	setTabOrder (QWidget , QWidget )
	Puts the second widget after the first widget in the focus order.

static void	setTabOrder (std::initializer_list< QWidget * > widgets)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

static QWidget *	mouseGrabber ()
	Returns the widget that is currently grabbing the mouse input.

static QWidget *	keyboardGrabber ()
	Returns the widget that is currently grabbing the keyboard input.

static QWidget *	find (WId)
	Returns a pointer to the widget with window identifier/handle id.

static QWidget *	createWindowContainer (QWindow window, QWidget parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
	Creates a QWidget that makes it possible to embed window into a QWidget-based application.

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Static Public Member Functions inherited from QPaintDevice
static qreal	devicePixelRatioFScale ()

Protected Slots inherited from QWidget
void	updateMicroFocus (Qt::InputMethodQuery query=Qt::ImQueryAll)
	Updates the widget's micro focus and informs input methods that the state specified by query has changed.

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Protected Attributes inherited from QPaintDevice
ushort	painters

Related Symbols inherited from QWidget
	setupUi (QWidget *widget)
	\macro QWIDGETSIZE_MAX

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

The QLineEdit widget is a one-line text editor.

\inmodule QtWidgets

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 (see \l setDragEnabled()).

By changing the 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 maxLength(). The text can be arbitrarily constrained using a validator() or an 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 QTextEdit which allows multi-line, rich text editing.

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

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

When editing is finished, either because the line edit lost focus or Return/Enter is pressed the editingFinished() signal is emitted. Note that if focus is lost without any changes done, the editingFinished() signal won't be emitted.

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

By default, QLineEdits have a frame as specified by platform 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. \target desc \table \header

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

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

See also: QTextEdit, QLabel, QComboBox, {Line Edits Example}

Definition at line 27 of file qlineedit.h.

Member Enumeration Documentation

◆ ActionPosition

enum QLineEdit::ActionPosition

This enum type describes how a line edit should display the action widgets to be added.

\value LeadingPosition The widget is displayed to the left of the text when using layout direction Qt::LeftToRight or to the right when using Qt::RightToLeft, respectively.

\value TrailingPosition The widget is displayed to the right of the text when using layout direction Qt::LeftToRight or to the left when using Qt::RightToLeft, respectively.

See also: addAction(), removeAction(), QWidget::layoutDirection

Since: 5.2

Enumerator
LeadingPosition
TrailingPosition

Definition at line 51 of file qlineedit.h.

◆ EchoMode

enum QLineEdit::EchoMode

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

\value Normal Display characters as they are entered. This is the default. \value NoEcho Do not display anything. This may be appropriate for passwords where even the length of the password should be kept secret. \value Password Display platform-dependent password mask characters instead of the characters actually entered. \value PasswordEchoOnEdit Display characters as they are entered while editing otherwise display characters as with Password.

See also: setEchoMode(), echoMode()

Enumerator
Normal
NoEcho
Password
PasswordEchoOnEdit

Definition at line 77 of file qlineedit.h.

Constructor & Destructor Documentation

◆ QLineEdit() [1/2]

QLineEdit::QLineEdit ( QWidget * parent = nullptr )

explicit

Constructs a line edit with no text.

The maximum text length is set to 32767 characters.

The parent argument is sent to the QWidget constructor.

See also: setText(), setMaxLength()

Definition at line 227 of file qlineedit.cpp.

◆ QLineEdit() [2/2]

QLineEdit::QLineEdit	(	const QString &	contents,
		QWidget *	parent = `nullptr`
	)

explicit

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 QWidget constructor.

See also: text(), setMaxLength()

Definition at line 243 of file qlineedit.cpp.

◆ ~QLineEdit()

QLineEdit::~QLineEdit ( )

Destroys the line edit.

Definition at line 256 of file qlineedit.cpp.

Member Function Documentation

◆ alignment()

Qt::Alignment QLineEdit::alignment ( ) const

Definition at line 744 of file qlineedit.cpp.

References d.

◆ backspace()

void 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()

Definition at line 819 of file qlineedit.cpp.

References d.

◆ changeEvent()

void QLineEdit::changeEvent ( QEvent * ev )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 2262 of file qlineedit.cpp.

References QEvent::ActivationChange, QPalette::Active, QWidget::changeEvent(), d, e, QWidget::font, QEvent::FontChange, QPalette::Inactive, initStyleOption(), isEqual(), QEvent::LayoutDirectionChange, opt, QWidget::palette, setIcon(), QStyle::SH_LineEdit_PasswordCharacter, QStyle::SH_LineEdit_PasswordMaskDelay, QLineEditPrivate::SideWidgetClearButton, QWidget::style(), QEvent::StyleChange, QEvent::type(), and QWidget::update().

Here is the call graph for this function:

◆ clear

void QLineEdit::clear ( )

slot

Clears the contents of the line edit.

See also: setText(), insert()

Definition at line 1279 of file qlineedit.cpp.

References d.

Referenced by QFileDialogPrivate::_q_enterDirectory(), QFontDialogPrivate::_q_updateSample(), inputMethodEvent(), QFontDialogPrivate::updateSizes(), and QFontDialogPrivate::updateStyles().

Here is the caller graph for this function:

◆ contextMenuEvent()

void QLineEdit::contextMenuEvent ( QContextMenuEvent * event )

overrideprotectedvirtual

Shows the standard context menu created with createStandardContextMenu().

If you do not want the line edit to have a context menu, you can set its \l contextMenuPolicy to Qt::NoContextMenu. If you want to customize the context menu, reimplement this function. If you want to extend the standard context menu, reimplement this function, call createStandardContextMenu() and extend the menu returned.

void LineEdit::contextMenuEvent(QContextMenuEvent *event)
{
    QMenu *menu = createStandardContextMenu();
    menu->addAction(tr("My Menu Item"));
    //...
    menu->exec(event->globalPos());
    delete menu;
}

The event parameter is used to obtain the position where the mouse cursor was when the event was generated.

See also: setContextMenuPolicy()

Reimplemented from QWidget.

Definition at line 2178 of file qlineedit.cpp.

References createStandardContextMenu(), menu, QMenu::popup(), QWidget::setAttribute(), and Qt::WA_DeleteOnClose.

Here is the call graph for this function:

◆ copy

void QLineEdit::copy ( ) const

slot

Copies the selected text to the clipboard, if there is any, and if echoMode() is \l Normal.

See also: cut(), paste()

Definition at line 1381 of file qlineedit.cpp.

References d.

Referenced by createStandardContextMenu(), and cut().

Here is the caller graph for this function:

◆ createStandardContextMenu()

QMenu * QLineEdit::createStandardContextMenu ( )

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 contextMenuEvent() handler. The popup menu's ownership is transferred to the caller.

Definition at line 2192 of file qlineedit.cpp.

References ACCEL_KEY, QMenu::addAction(), QMenu::addMenu(), QMenu::addSeparator(), QGuiApplication::clipboard(), QObject::connect(), QKeySequence::Copy, copy(), QKeySequence::Cut, cut(), d, QString::isEmpty(), QMenu::isEmpty(), isReadOnly(), Normal, QKeySequence::Paste, paste(), QStringLiteral, QKeySequence::Redo, redo(), QKeySequence::SelectAll, selectAll(), setActionIcon(), QAction::setEnabled(), QObject::setObjectName(), SIGNAL, SLOT, QGuiApplication::styleHints(), QClipboard::text(), QKeySequence::Undo, undo(), and QStyleHints::useRtlExtensions.

Referenced by contextMenuEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cursorBackward()

void QLineEdit::cursorBackward	(	bool	mark,
		int	steps = `1`
	)

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.

See also: cursorForward()

Definition at line 780 of file qlineedit.cpp.

References cursorForward().

Here is the call graph for this function:

◆ cursorForward()

void QLineEdit::cursorForward	(	bool	mark,
		int	steps = `1`
	)

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.

See also: cursorBackward()

Definition at line 766 of file qlineedit.cpp.

References d.

Referenced by cursorBackward().

Here is the caller graph for this function:

◆ cursorMoveStyle()

Qt::CursorMoveStyle QLineEdit::cursorMoveStyle ( ) const

Definition at line 1073 of file qlineedit.cpp.

References d.

◆ cursorPosition()

int QLineEdit::cursorPosition ( ) const

Definition at line 708 of file qlineedit.cpp.

References d.

◆ cursorPositionAt()

int QLineEdit::cursorPositionAt ( const QPoint & pos )

Returns the cursor position under the point pos.

Definition at line 724 of file qlineedit.cpp.

References d, QWidget::pos, and QPoint::x().

Here is the call graph for this function:

◆ cursorPositionChanged

void QLineEdit::cursorPositionChanged	(	int	oldPos,
		int	newPos
	)

signal

This signal is emitted whenever the cursor moves.

The previous position is given by oldPos, and the new position by newPos.

See also: setCursorPosition(), cursorPosition()

◆ cursorRect()

QRect QLineEdit::cursorRect ( ) const

protected

Since: 4.4

Returns a rectangle that includes the lineedit cursor.

Definition at line 1764 of file qlineedit.cpp.

References d.

◆ cursorWordBackward()

void QLineEdit::cursorWordBackward ( bool mark )

Moves the cursor one word backward.

If mark is true, the word is also selected.

See also: cursorWordForward()

Definition at line 804 of file qlineedit.cpp.

References d.

◆ cursorWordForward()

void QLineEdit::cursorWordForward ( bool mark )

Moves the cursor one word forward.

If mark is true, the word is also selected.

See also: cursorWordBackward()

Definition at line 791 of file qlineedit.cpp.

References d.

◆ cut

void QLineEdit::cut ( )

slot

Copies the selected text to the clipboard and deletes it, if there is any, and if echoMode() is \l Normal.

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

See also: copy(), paste(), setValidator()

Definition at line 1365 of file qlineedit.cpp.

References copy(), del(), and hasSelectedText.

Referenced by createStandardContextMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ del()

void 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: backspace()

Definition at line 833 of file qlineedit.cpp.

References d.

Referenced by cut().

Here is the caller graph for this function:

◆ deselect()

void QLineEdit::deselect ( )

Deselects any selected text.

See also: setSelection(), selectAll()

Definition at line 1253 of file qlineedit.cpp.

References d.

Referenced by QComboBoxPrivate::_q_returnPressed(), focusOutEvent(), and mouseReleaseEvent().

Here is the caller graph for this function:

◆ displayText()

QString QLineEdit::displayText ( ) const

Definition at line 336 of file qlineedit.cpp.

References d.

◆ dragEnabled()

bool QLineEdit::dragEnabled ( ) const

Definition at line 1045 of file qlineedit.cpp.

References d.

◆ echoMode()

QLineEdit::EchoMode QLineEdit::echoMode ( ) const

Definition at line 532 of file qlineedit.cpp.

References d.

◆ editingFinished

void QLineEdit::editingFinished ( )

signal

This signal is emitted when the Return or Enter key is pressed, or if the line edit loses focus and its contents have changed since the last time this signal was emitted.

Note that if there is a validator() or inputMask() set on the line edit and enter/return is pressed, the editingFinished() signal will only be emitted if the input follows the inputMask() and the validator() returns QValidator::Acceptable.

Referenced by event(), and focusOutEvent().

Here is the caller graph for this function:

◆ end()

void QLineEdit::end ( bool mark )

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: home()

Definition at line 863 of file qlineedit.cpp.

References d.

Referenced by QComboBoxPrivate::_q_returnPressed().

Here is the caller graph for this function:

◆ event()

bool QLineEdit::event ( QEvent * e )

overridevirtual

\reimp

Reimplemented from QObject.

Definition at line 1424 of file qlineedit.cpp.

References QEvent::ActionRemoved, QEvent::ContextMenu, d, e, editingFinished(), emit, QWidget::event(), QWidget::hasFocus(), hasSelectedText, initStyleOption(), opt, QEvent::Resize, QStyle::SH_BlinkCursorWhenTextSelected, QEvent::ShortcutOverride, QEvent::Show, QTimer::singleShot, SLOT, QWidget::style(), QEvent::StyleChange, and QEvent::WindowActivate.

Referenced by QComboBoxPrivate::showPopupFromMouseEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ focusInEvent()

void QLineEdit::focusInEvent ( QFocusEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 1880 of file qlineedit.cpp.

References Qt::BacktabFocusReason, QObject::connect(), d, e, hasSelectedText, initStyleOption(), Qt::MouseFocusReason, opt, Qt::PopupFocusReason, selectAll(), setText(), QStyle::SH_BlinkCursorWhenTextSelected, Qt::ShortcutFocusReason, SIGNAL, SLOT, QWidget::style(), Qt::TabFocusReason, QWidget::update(), and QWidget::updateMicroFocus().

Here is the call graph for this function:

◆ focusOutEvent()

void QLineEdit::focusOutEvent ( QFocusEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 1923 of file qlineedit.cpp.

References QApplication::activePopupWidget(), Qt::ActiveWindowFocusReason, d, deselect(), QObject::disconnect(), e, editingFinished(), emit, QWidget::focusOutEvent(), hasAcceptableInput(), QWidget::parentWidget(), and Qt::PopupFocusReason.

Here is the call graph for this function:

◆ hasAcceptableInput()

bool QLineEdit::hasAcceptableInput ( ) const

Definition at line 1094 of file qlineedit.cpp.

References d.

Referenced by focusOutEvent(), and QWizardPage::isComplete().

Here is the caller graph for this function:

◆ hasFrame()

bool QLineEdit::hasFrame ( ) const

Definition at line 380 of file qlineedit.cpp.

References d.

◆ hasSelectedText()

bool QLineEdit::hasSelectedText ( ) const

Definition at line 913 of file qlineedit.cpp.

References d.

◆ home()

void QLineEdit::home ( bool mark )

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: end()

Definition at line 848 of file qlineedit.cpp.

References d.

◆ initStyleOption()

void QLineEdit::initStyleOption ( QStyleOptionFrame * option ) const

protectedvirtual

Initialize option with the values from this QLineEdit.

This method is useful for subclasses when they need a QStyleOptionFrame, but don't want to fill in all the information themselves.

See also: QStyleOption::initFrom()

Definition at line 73 of file qlineedit.cpp.

References QWidget::contentsRect(), d, QStyleOptionFrame::None, QStyle::pixelMetric(), QStyle::PM_DefaultFrameWidth, QStyle::State_ReadOnly, QStyle::State_Sunken, and QWidget::style().

Referenced by changeEvent(), event(), focusInEvent(), minimumSizeHint(), paintEvent(), setSelection(), and sizeHint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ inputMask()

QString QLineEdit::inputMask ( ) const

Definition at line 1220 of file qlineedit.cpp.

References d.

◆ inputMethodEvent()

void QLineEdit::inputMethodEvent ( QInputMethodEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 1772 of file qlineedit.cpp.

References clear(), d, e, echoMode, QWidget::hasFocus(), Qt::Key_unknown, and PasswordEchoOnEdit.

Here is the call graph for this function:

◆ inputMethodQuery() [1/2]

QVariant QLineEdit::inputMethodQuery	(	Qt::InputMethodQuery	property,
		QVariant	argument
	)		const

Definition at line 1827 of file qlineedit.cpp.

References argument, QTextLine::CursorBetweenCharacters, d, QWidget::font, Qt::ImAbsolutePosition, Qt::ImAnchorPosition, Qt::ImAnchorRectangle, Qt::ImCurrentSelection, Qt::ImCursorPosition, Qt::ImCursorRectangle, Qt::ImEnabled, Qt::ImFont, Qt::ImMaximumTextLength, Qt::ImReadOnly, Qt::ImSurroundingText, Qt::ImTextAfterCursor, Qt::ImTextBeforeCursor, QWidget::inputMethodQuery(), QWidget::isEnabled(), QPointF::isNull(), isReadOnly(), maxLength, property, selectedText, and QPointF::x().

Here is the call graph for this function:

◆ inputMethodQuery() [2/2]

QVariant QLineEdit::inputMethodQuery ( Qt::InputMethodQuery property ) const

overridevirtual

\reimp

Reimplemented from QWidget.

Definition at line 1804 of file qlineedit.cpp.

References Qt::EnterKeyNext, Qt::ImEnterKeyType, inputMethodQuery(), QWidget::mapToGlobal(), next, QWidget::nextInFocusChain(), Qt::NoFocus, property, and QPointF::y().

Referenced by inputMethodQuery().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ inputRejected

void QLineEdit::inputRejected ( )

signal

Since: 5.12

This signal is emitted when the user presses a key that is not considered to be acceptable input. For example, if a key press results in a validator's validate() call to return Invalid. Another case is when trying to enter in more characters beyond the maximum length of the line edit.

Note: This signal will still be emitted in a case where part of the text is accepted but not all of it is. For example, if there is a maximum length set and the clipboard text is longer than the maximum length when it is pasted.

◆ insert()

void QLineEdit::insert ( const QString & newText )

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.

See also: setText(), clear()

Definition at line 1267 of file qlineedit.cpp.

References d.

◆ isClearButtonEnabled()

bool QLineEdit::isClearButtonEnabled ( ) const

Definition at line 473 of file qlineedit.cpp.

References clearButtonActionNameC.

Referenced by setClearButtonEnabled().

Here is the caller graph for this function:

◆ isModified()

bool QLineEdit::isModified ( ) const

Definition at line 888 of file qlineedit.cpp.

References d.

◆ isReadOnly()

bool QLineEdit::isReadOnly ( ) const

Definition at line 1324 of file qlineedit.cpp.

References d.

Referenced by createStandardContextMenu(), inputMethodQuery(), keyPressEvent(), keyReleaseEvent(), mouseReleaseEvent(), and setClearButtonEnabled().

Here is the caller graph for this function:

◆ isRedoAvailable()

bool QLineEdit::isRedoAvailable ( ) const

Definition at line 1031 of file qlineedit.cpp.

References d.

◆ isUndoAvailable()

bool QLineEdit::isUndoAvailable ( ) const

Definition at line 1015 of file qlineedit.cpp.

References d.

◆ keyPressEvent()

void QLineEdit::keyPressEvent ( QKeyEvent * event )

overrideprotectedvirtual

Converts the given key press event into a line edit action.

If Return or Enter is pressed and the current text is valid (or can be \l{QValidator::fixup()}{made valid} by the validator), the signal returnPressed() is emitted.

The default key bindings are listed in the class's detailed description.

Reimplemented from QWidget.

Definition at line 1697 of file qlineedit.cpp.

References Qt::ControlModifier, d, isReadOnly(), Qt::Key_Back, Qt::Key_No, Qt::Key_Select, and select().

Referenced by QFileDialogLineEdit::keyPressEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ keyReleaseEvent()

void QLineEdit::keyReleaseEvent ( QKeyEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 1750 of file qlineedit.cpp.

References d, e, isReadOnly(), and QWidget::keyReleaseEvent().

Here is the call graph for this function:

◆ maxLength()

int QLineEdit::maxLength ( ) const

Definition at line 361 of file qlineedit.cpp.

References d.

◆ minimumSizeHint()

QSize QLineEdit::minimumSizeHint ( ) const

overridevirtual

Returns a minimum size for the line edit.

The width returned is usually enough for at least one character.

Reimplemented from QWidget.

Definition at line 681 of file qlineedit.cpp.

References QMargins::bottom(), QStyle::CT_LineEdit, d, QWidget::ensurePolished(), QWidget::fontMetrics(), QFontMetrics::height(), QLineEditPrivate::horizontalMargin, initStyleOption(), QFontMetrics::leading(), QMargins::left(), QFontMetrics::maxWidth(), opt, qMax(), QMargins::right(), QStyle::sizeFromContents(), QWidget::style(), QMargins::top(), and QLineEditPrivate::verticalMargin.

Referenced by QPrintPreviewDialogPrivate::init(), and QPrintPreviewDialogPrivate::updatePageNumLabel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mouseDoubleClickEvent()

void QLineEdit::mouseDoubleClickEvent ( QMouseEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 1602 of file qlineedit.cpp.

References d, QApplication::doubleClickInterval, e, Qt::LeftButton, position(), and qBound().

Here is the call graph for this function:

◆ mouseMoveEvent()

void QLineEdit::mouseMoveEvent ( QMouseEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 1523 of file qlineedit.cpp.

References d, e, Qt::ImhNoPredictiveText, QWidget::layoutDirection, Qt::LeftButton, Qt::RightToLeft, select(), and QApplication::startDragDistance.

Here is the call graph for this function:

◆ mousePressEvent()

void QLineEdit::mousePressEvent ( QMouseEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 1481 of file qlineedit.cpp.

References QWidget::cursor, d, e, Qt::ImhNoPredictiveText, Qt::LeftButton, Normal, QCoreApplication::QApplicationPrivate, Qt::RightButton, selectAll(), Qt::ShiftModifier, QApplication::startDragDistance, and QApplication::startDragTime.

Here is the call graph for this function:

◆ mouseReleaseEvent()

void QLineEdit::mouseReleaseEvent ( QMouseEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 1570 of file qlineedit.cpp.

References QGuiApplication::clipboard(), contains(), d, deselect(), e, isReadOnly(), Qt::LeftButton, Qt::MiddleButton, QWidget::rect, and QClipboard::Selection.

Here is the call graph for this function:

◆ paintEvent()

void QLineEdit::paintEvent ( QPaintEvent * )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 1963 of file qlineedit.cpp.

References Qt::AlignAbsolute, Qt::AlignBottom, Qt::AlignHCenter, Qt::AlignRight, Qt::AlignTop, Qt::AlignVertical_Mask, QFontMetrics::ascent(), QFontMetrics::boundingRect(), QBrush::color(), QPalette::currentColorGroup(), d, QWidgetLineControl::DrawCursor, QStyle::drawPrimitive(), QWidgetLineControl::DrawSelections, QWidgetLineControl::DrawText, QFontMetrics::elidedText(), Qt::ElideRight, QWidget::fontMetrics(), QFontMetrics::height(), QRect::height(), QLineEditPrivate::horizontalMargin, initStyleOption(), Qt::LeftToRight, QRect::marginsRemoved(), QWidget::palette, panel, QStyle::PE_PanelLineEdit, QPalette::placeholderText(), QStyle::PM_TextCursorWidth, qMax(), qRound(), qt_styleSheet(), Qt::RightToLeft, QStyle::SE_LineEditContents, QWidget::style(), QStyle::subElementRect(), QPalette::text(), QRect::topLeft(), QLineEditPrivate::verticalMargin, QStyle::visualAlignment(), and QRect::width().

Here is the call graph for this function:

◆ paste

void QLineEdit::paste ( )

slot

Inserts the clipboard's text at the cursor position, deleting any selected text, providing the line edit is not \l{QLineEdit::readOnly}{read-only}.

If the end result would be invalid to the current \l{setValidator()}{validator}, nothing happens.

See also: copy(), cut()

Definition at line 1397 of file qlineedit.cpp.

References d.

Referenced by createStandardContextMenu().

Here is the caller graph for this function:

◆ placeholderText()

QString QLineEdit::placeholderText ( ) const

Definition at line 306 of file qlineedit.cpp.

References d.

◆ redo

void QLineEdit::redo ( )

slot

Redoes the last operation if redo is \l{QLineEdit::redoAvailable}{available}.

Definition at line 1301 of file qlineedit.cpp.

References d.

Referenced by createStandardContextMenu().

Here is the caller graph for this function:

◆ returnPressed

void QLineEdit::returnPressed ( )

signal

This signal is emitted when the Return or Enter key is pressed.

Note that if there is a validator() or inputMask() set on the line edit, the returnPressed() signal will only be emitted if the input follows the inputMask() and the validator() returns QValidator::Acceptable.

◆ selectAll

void QLineEdit::selectAll ( )

slot

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: setSelection(), deselect()

Definition at line 1241 of file qlineedit.cpp.

References d.

Referenced by QFontDialogPrivate::_q_familyHighlighted(), QComboBoxPrivate::_q_itemSelected(), QFontDialogPrivate::_q_sizeHighlighted(), QFontDialogPrivate::_q_styleHighlighted(), createStandardContextMenu(), QFileDialogPrivate::createWidgets(), focusInEvent(), mousePressEvent(), QDateTimeEditPrivate::setSelected(), QFontDialogPrivate::updateFamilies(), QFontDialogPrivate::updateSizes(), and QFontDialogPrivate::updateStyles().

Here is the caller graph for this function:

◆ selectedText()

QString QLineEdit::selectedText ( ) const

Definition at line 931 of file qlineedit.cpp.

References d.

◆ selectionChanged

void QLineEdit::selectionChanged ( )

signal

This signal is emitted whenever the selection changes.

See also: hasSelectedText(), selectedText()

◆ selectionEnd()

int QLineEdit::selectionEnd ( ) const

Returns the index of the character directly after the selection in the line edit or -1 if no text is selected.

Since: 5.10

See also: selectedText(); selectionStart(); selectionLength()

Definition at line 961 of file qlineedit.cpp.

References d.

Referenced by selectionLength().

Here is the caller graph for this function:

◆ selectionLength()

int QLineEdit::selectionLength ( ) const

Returns the length of the selection.

Since: 5.10

See also: selectedText(); selectionStart(); selectionEnd()

Definition at line 975 of file qlineedit.cpp.

References selectionEnd(), and selectionStart().

Here is the call graph for this function:

◆ selectionStart()

int QLineEdit::selectionStart ( ) const

Returns the index of the first selected character in the line edit or -1 if no text is selected.

See also: selectedText(); selectionEnd(); selectionLength()

Definition at line 946 of file qlineedit.cpp.

References d.

Referenced by QAbstractSpinBoxPrivate::_q_editorCursorPositionChanged(), QDateTimeEditPrivate::_q_editorCursorPositionChanged(), and selectionLength().

Here is the caller graph for this function:

◆ setAlignment()

void QLineEdit::setAlignment ( Qt::Alignment flag )

Definition at line 750 of file qlineedit.cpp.

References alignment, d, and QWidget::update().

Referenced by QFontDialogPrivate::init(), and QPrintPreviewDialogPrivate::init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setClearButtonEnabled()

void QLineEdit::setClearButtonEnabled ( bool enable )

Definition at line 448 of file qlineedit.cpp.

References clearButtonActionNameC, d, isClearButtonEnabled(), isReadOnly(), Q_ASSERT, Q_UNUSED, QAction::setEnabled(), QObject::setObjectName(), QLineEditPrivate::SideWidgetClearButton, QLineEditPrivate::SideWidgetFadeInWithText, text, and TrailingPosition.

Referenced by QKeySequenceEditPrivate::init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCursorMoveStyle()

void QLineEdit::setCursorMoveStyle ( Qt::CursorMoveStyle style )

Definition at line 1079 of file qlineedit.cpp.

References d, and QWidget::style().

Here is the call graph for this function:

◆ setCursorPosition()

void QLineEdit::setCursorPosition ( int pos )

Definition at line 714 of file qlineedit.cpp.

References d, and QWidget::pos.

Referenced by QAbstractSpinBoxPrivate::_q_editorCursorPositionChanged(), QDateTimeEditPrivate::_q_editorCursorPositionChanged(), QDateTimeEditPrivate::clearSection(), QAbstractSpinBoxPrivate::interpret(), QAbstractSpinBoxPrivate::updateEdit(), and QDateTimeEditPrivate::updateEdit().

Here is the caller graph for this function:

◆ setDragEnabled()

void QLineEdit::setDragEnabled ( bool b )

Definition at line 1051 of file qlineedit.cpp.

References d.

◆ setEchoMode()

void QLineEdit::setEchoMode ( EchoMode mode )

Definition at line 538 of file qlineedit.cpp.

References d, Qt::ImhHiddenText, Qt::ImhNoAutoUppercase, Qt::ImhNoPredictiveText, Qt::ImhSensitiveData, QWidget::inputMethodHints, NoEcho, Normal, Password, QWidget::setInputMethodHints(), and QWidget::update().

Here is the call graph for this function:

◆ setFrame()

void QLineEdit::setFrame ( bool enable )

Definition at line 482 of file qlineedit.cpp.

References d, QWidget::update(), and QWidget::updateGeometry().

Here is the call graph for this function:

◆ setInputMask()

void QLineEdit::setInputMask ( const QString & inputMask )

Definition at line 1226 of file qlineedit.cpp.

References d, and inputMask.

◆ setMaxLength()

void QLineEdit::setMaxLength ( int maxLength )

Definition at line 367 of file qlineedit.cpp.

References d.

◆ setModified()

void QLineEdit::setModified ( bool modified )

Definition at line 894 of file qlineedit.cpp.

References d, and modified.

◆ setPlaceholderText()

void QLineEdit::setPlaceholderText ( const QString & placeholderText )

Definition at line 312 of file qlineedit.cpp.

References d, placeholderText, and QWidget::update().

Referenced by QKeySequenceEditPrivate::resetState().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setReadOnly()

void QLineEdit::setReadOnly ( bool enable )

Definition at line 1330 of file qlineedit.cpp.

References Qt::ArrowCursor, d, Qt::IBeamCursor, QEvent::ReadOnlyChange, QCoreApplication::sendEvent(), QWidget::setAttribute(), QWidget::setCursor(), QWidget::update(), Qt::WA_InputMethodEnabled, and Qt::WA_MacShowFocusRect.

Referenced by QtPrivate::QColorShower::QColorShower(), and QFontDialogPrivate::init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSelection()

void QLineEdit::setSelection	(	int	start,
		int	length
	)

Selects text from position start and for length characters.

Negative lengths are allowed.

See also: deselect(), selectAll(), selectedText()

Definition at line 987 of file qlineedit.cpp.

References d, initStyleOption(), opt, Q_UNLIKELY, qWarning, QStyle::SH_BlinkCursorWhenTextSelected, and QWidget::style().

Referenced by QAbstractSpinBoxPrivate::_q_editorCursorPositionChanged(), QDateTimeEditPrivate::setSelected(), QAbstractSpinBoxPrivate::updateEdit(), and QDateTimeEditPrivate::updateEdit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setText

void QLineEdit::setText ( const QString & text )

slot

Definition at line 282 of file qlineedit.cpp.

References d, and text.

Here is the caller graph for this function:

◆ setTextMargins() [1/2]

void QLineEdit::setTextMargins ( const QMargins & margins )

Since: 4.6 Sets the margins around the text inside the frame.

◆ setTextMargins() [2/2]

void QLineEdit::setTextMargins	(	int	left,
		int	top,
		int	right,
		int	bottom
	)

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

Since: 4.5

◆ setValidator()

void QLineEdit::setValidator ( const QValidator * v )

Sets the validator for values of line edit to v.

The line edit's returnPressed() and editingFinished() signals will only be emitted if v validates the line edit's content as \l{QValidator::}{Acceptable}. The user may change the content to any \l{QValidator::}{Intermediate} value during editing, but will be prevented from editing the text to a value that v validates as \l{QValidator::}{Invalid}.

This allows you to constrain the text that shall finally be entered when editing is done, while leaving users with enough freedom to edit the text from one valid state to another.

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

See also: validator(), hasAcceptableInput(), QIntValidator, QDoubleValidator, QRegularExpressionValidator

Definition at line 588 of file qlineedit.cpp.

References d.

Referenced by QtPrivate::QColorShower::QColorShower(), QFontDialogPrivate::init(), QAbstractSpinBoxPrivate::init(), QPrintPreviewDialogPrivate::updatePageNumLabel(), src_gui_util_qvalidator::Wrapper::wrapper0(), and src_gui_util_qvalidator::Wrapper::wrapper2().

Here is the caller graph for this function:

◆ sizeHint()

QSize QLineEdit::sizeHint ( ) const

overridevirtual

Returns a recommended size for the widget.

The width returned, in pixels, is usually enough for about 15 to 20 characters.

Reimplemented from QWidget.

Definition at line 656 of file qlineedit.cpp.

References QMargins::bottom(), QStyle::CT_LineEdit, d, QWidget::ensurePolished(), QWidget::font, QFontMetrics::height(), QFontMetrics::horizontalAdvance(), QLineEditPrivate::horizontalMargin, iconSize, initStyleOption(), QMargins::left(), opt, QStyle::pixelMetric(), QStyle::PM_SmallIconSize, qMax(), QMargins::right(), QStyle::sizeFromContents(), QWidget::style(), QMargins::top(), and QLineEditPrivate::verticalMargin.

Here is the call graph for this function:

◆ text()

QString QLineEdit::text ( ) const

Definition at line 276 of file qlineedit.cpp.

References d.

◆ textChanged

void QLineEdit::textChanged ( const QString & text )

signal

This signal is emitted whenever the text changes.

The text argument is the new text.

Unlike textEdited(), this signal is also emitted when the text is changed programmatically, for example, by calling setText().

Referenced by QtPrivate::QColorShower::QColorShower(), QKeySequenceEditPrivate::init(), and main().

Here is the caller graph for this function:

◆ textEdited

void QLineEdit::textEdited ( const QString & text )

signal

This signal is emitted whenever the text is edited.

The text argument is the new text.

Unlike textChanged(), this signal is not emitted when the text is changed programmatically, for example, by calling setText().

◆ textMargins()

QMargins QLineEdit::textMargins ( ) const

Since: 4.6 Returns the widget's text margins.

See also: setTextMargins()

Definition at line 1132 of file qlineedit.cpp.

References d.

◆ timerEvent()

void QLineEdit::timerEvent ( QTimerEvent * e )

overridevirtual

\reimp

Reimplemented from QObject.

Definition at line 1408 of file qlineedit.cpp.

References d, and e.

◆ undo

void QLineEdit::undo ( )

slot

Undoes the last operation if undo is \l{QLineEdit::undoAvailable}{available}.

Deselects any current selection, and updates the selection start to the current cursor position.

Definition at line 1291 of file qlineedit.cpp.

References d.

Referenced by createStandardContextMenu().

Here is the caller graph for this function:

◆ validator()

const QValidator * QLineEdit::validator ( ) const

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

See also: setValidator()

Definition at line 562 of file qlineedit.cpp.

References d.

Friends And Related Symbol Documentation

◆ QAbstractSpinBox

friend class QAbstractSpinBox

friend

Definition at line 209 of file qlineedit.h.

◆ QAccessibleLineEdit

friend class QAccessibleLineEdit

friend

Definition at line 210 of file qlineedit.h.

◆ QComboBox

friend class QComboBox

friend

Definition at line 211 of file qlineedit.h.

Property Documentation

◆ acceptableInput

QLineEdit::acceptableInput

read

whether the input satisfies the inputMask and the validator.

By default, this property is true.

See also: setInputMask(), setValidator()

Definition at line 233 of file qlineedit.h.

◆ alignment

QLineEdit::alignment

readwrite

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

Definition at line 233 of file qlineedit.h.

Referenced by setAlignment().

◆ clearButtonEnabled

QLineEdit::clearButtonEnabled

readwrite

Whether the line edit displays a clear button when it is not empty.

If enabled, the line edit displays a trailing clear button when it contains some text, otherwise the line edit does not show a clear button (the default).

See also: addAction(), removeAction()

Since: 5.2

Definition at line 233 of file qlineedit.h.

◆ cursorMoveStyle

QLineEdit::cursorMoveStyle

readwrite

the movement style of cursor in this line edit.

Since: 4.8

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.

Definition at line 233 of file qlineedit.h.

◆ cursorPosition

QLineEdit::cursorPosition

readwrite

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.

Definition at line 233 of file qlineedit.h.

Referenced by QAbstractSpinBoxPrivate::_q_editorTextChanged(), QDateTimeEditPrivate::clearSection(), QDateTimeEditPrivate::cursorPosition(), QAbstractSpinBoxPrivate::interpret(), QDateTimeEditPrivate::interpret(), QDateTimeEditPrivate::stepBy(), QDateTimeEditPrivate::updateCache(), and QAbstractSpinBoxPrivate::updateEdit().

◆ displayText

QLineEdit::displayText

read

the displayed text.

If \l echoMode is \l Normal this returns the same as text(); if \l EchoMode is \l Password or \l PasswordEchoOnEdit it returns a string of platform-dependent password mask characters text().length() in size, e.g. "******"; if \l EchoMode is \l NoEcho returns an empty string, "".

By default, this property contains an empty string.

See also: setEchoMode(), text(), EchoMode

Definition at line 233 of file qlineedit.h.

Referenced by QSpinBoxPrivate::emitSignals(), QDoubleSpinBoxPrivate::emitSignals(), QAbstractSpinBoxPrivate::interpret(), QAbstractSpinBox::text(), and QAbstractSpinBoxPrivate::updateEdit().

◆ dragEnabled

QLineEdit::dragEnabled

readwrite

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

Dragging is disabled by default.

Definition at line 233 of file qlineedit.h.

◆ echoMode

QLineEdit::echoMode

readwrite

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 \l Normal, in which the text entered by the user is displayed verbatim, but QLineEdit also supports modes that allow the entered text to be suppressed or obscured: these include \l NoEcho, \l Password and \l 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 \l Normal.

See also: EchoMode, displayText()

Definition at line 233 of file qlineedit.h.

Referenced by inputMethodEvent().

◆ frame

QLineEdit::frame

readwrite

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.

Definition at line 233 of file qlineedit.h.

◆ hasSelectedText

QLineEdit::hasSelectedText

read

whether there is any text selected.

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: selectedText()

Definition at line 233 of file qlineedit.h.

Referenced by QAbstractSpinBoxPrivate::_q_editorCursorPositionChanged(), QDateTimeEditPrivate::_q_editorCursorPositionChanged(), cut(), event(), and focusInEvent().

◆ inputMask

QLineEdit::inputMask

readwrite

The validation input mask.

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

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

Unset the mask and return to normal QLineEdit operation by passing an empty string ("").

The input mask is an input template string. It can contain the following elements: \table \row

Mask Characters
Defines the \l {QChar::} {Category} of input characters that are considered valid in this position \row
Meta Characters
Various special meanings \row
Separators
All other characters are regarded as immutable separators \endtable

The following table shows the mask and meta characters that can be used in an input mask.

\table \header

Mask Character
Meaning \row
A
character of the Letter category required, such as A-Z, a-z. \row
a
character of the Letter category permitted but not required. \row
N
character of the Letter or Number category required, such as A-Z, a-z, 0-9. \row
n
character of the Letter or Number category permitted but not required. \row
X
Any non-blank character required. \row
x
Any non-blank character permitted but not required. \row
9
character of the Number category required, e.g 0-9. \row
0
character of the Number category permitted but not required. \row
D
character of the Number category and larger than zero required, such as 1-9 \row
d
character of the Number category and larger than zero permitted but not required, such as 1-9. \row
#
character of the Number category, or plus/minus sign permitted but not required. \row
H
Hexadecimal character required. A-F, a-f, 0-9. \row
h
Hexadecimal character permitted but not required. \row
B
Binary character required. 0-1. \row
b
Binary character permitted but not required. \header
Meta Character
Meaning \row
>
All following alphabetic characters are uppercased. \row
<
All following alphabetic characters are lowercased. \row
!
Switch off case conversion. \row
{;c}
Terminates the input mask and sets the {blank} character to {c}. \row
{[ ] { }}
Reserved. \row
\tt{\}
Use \tt{\} to escape the special characters listed above to use them as separators. \endtable

When created or cleared, the line edit will be filled with a copy of the input mask string where the meta characters have been removed, and the mask characters have been replaced with the {blank} character (by default, a space).

When an input mask is set, the text() method returns a modified copy of the line edit content where all the {blank} characters have been removed. The unmodified content can be read using displayText().

The hasAcceptableInput() method returns false if the current content of the line edit does not fulfil the requirements of the input mask.

Examples: \table \header

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

To get range control (e.g., for an IP address) use masks together with \l{setValidator()}{validators}.

See also: maxLength, QChar::isLetter(), QChar::isNumber(), QChar::digitValue()

Definition at line 233 of file qlineedit.h.

Referenced by setInputMask().

◆ maxLength

QLineEdit::maxLength

readwrite

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: inputMask

Definition at line 233 of file qlineedit.h.

Referenced by inputMethodQuery().

◆ modified

QLineEdit::modified

readwrite

whether the line edit's contents has been modified by the user.

The modified flag is never read by 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 setText() resets the modified flag to false.

Definition at line 233 of file qlineedit.h.

Referenced by setModified().

◆ placeholderText

QLineEdit::placeholderText

readwrite

the line edit's placeholder text.

Since: 4.7

Setting this property makes the line edit display a grayed-out placeholder text as long as the line edit is empty.

Normally, an empty line edit shows the placeholder text even when it has focus. However, if the content is horizontally centered, the placeholder text is not displayed under the cursor when the line edit has focus.

By default, this property contains an empty string.

See also: text()

Definition at line 233 of file qlineedit.h.

Referenced by setPlaceholderText().

◆ readOnly

QLineEdit::readOnly

readwrite

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 echoMode() is \l Normal), but cannot edit it.

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

By default, this property is false.

See also: setEnabled()

Definition at line 233 of file qlineedit.h.

◆ redoAvailable

QLineEdit::redoAvailable

read

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.

Definition at line 233 of file qlineedit.h.

◆ selectedText

QLineEdit::selectedText

read

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.

See also: hasSelectedText()

Definition at line 233 of file qlineedit.h.

Referenced by QAbstractSpinBoxPrivate::_q_editorCursorPositionChanged(), QDateTimeEditPrivate::_q_editorCursorPositionChanged(), inputMethodQuery(), QAbstractSpinBoxPrivate::updateEdit(), and QDateTimeEditPrivate::updateEdit().

◆ text

QLineEdit::text

readwrite

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 \l modified property to false. The text is not validated when inserted with setText().

The text is truncated to maxLength() length.

By default, this property contains an empty string.

See also: insert(), clear()

Definition at line 233 of file qlineedit.h.

Referenced by QComboBoxPrivate::_q_editingFinished(), QAbstractSpinBoxPrivate::_q_editorCursorPositionChanged(), QPrintPreviewDialogPrivate::_q_pageNumEdited(), QComboBoxPrivate::_q_returnPressed(), QFileDialogPrivate::_q_updateOkButton(), QFontDialogPrivate::_q_updateSample(), QFileDialogPrivate::_q_useNameFilter(), QPrintPreviewDialogPrivate::_q_zoomFactorChanged(), QDateTimeEditPrivate::clearSection(), QDateTimeEditPrivate::displayText(), setClearButtonEnabled(), QComboBoxPrivate::setCurrentIndex(), setText(), QFileDialogPrivate::typedFiles(), QAbstractSpinBoxPrivate::updateEdit(), and QFileDialogPrivate::userSelectedFiles().

◆ undoAvailable

QLineEdit::undoAvailable

read

whether undo is available.

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

By default, this property is false.

Definition at line 233 of file qlineedit.h.

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

qtbase/src/widgets/widgets/qlineedit.h
qtbase/src/widgets/widgets/qlineedit.cpp

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ActionPosition

◆ EchoMode

Constructor & Destructor Documentation

◆ QLineEdit() [1/2]

◆ QLineEdit() [2/2]

◆ ~QLineEdit()

Member Function Documentation

◆ alignment()

◆ backspace()

◆ changeEvent()

◆ clear

◆ contextMenuEvent()

◆ copy

◆ createStandardContextMenu()

◆ cursorBackward()

◆ cursorForward()

◆ cursorMoveStyle()

◆ cursorPosition()

◆ cursorPositionAt()

◆ cursorPositionChanged

◆ cursorRect()

◆ cursorWordBackward()

◆ cursorWordForward()

◆ cut

◆ del()

◆ deselect()

◆ displayText()

◆ dragEnabled()

◆ echoMode()

◆ editingFinished

◆ end()

◆ event()

◆ focusInEvent()

◆ focusOutEvent()

◆ hasAcceptableInput()

◆ hasFrame()

◆ hasSelectedText()

◆ home()

◆ initStyleOption()

◆ inputMask()

◆ inputMethodEvent()

◆ inputMethodQuery() [1/2]

◆ inputMethodQuery() [2/2]

◆ inputRejected

◆ insert()

◆ isClearButtonEnabled()

◆ isModified()

◆ isReadOnly()

◆ isRedoAvailable()

◆ isUndoAvailable()

◆ keyPressEvent()

◆ keyReleaseEvent()

◆ maxLength()

◆ minimumSizeHint()

◆ mouseDoubleClickEvent()

◆ mouseMoveEvent()

◆ mousePressEvent()

◆ mouseReleaseEvent()

◆ paintEvent()

◆ paste

◆ placeholderText()

◆ redo

◆ returnPressed

◆ selectAll

◆ selectedText()

◆ selectionChanged

◆ selectionEnd()

◆ selectionLength()

◆ selectionStart()

◆ setAlignment()