KLineEdit

#include <KLineEdit>

Inheritance diagram for KLineEdit:

Properties

QString clickMessage
 
bool contextMenuEnabled
 
bool passwordMode
 
bool showClearButton
 
bool squeezedTextEnabled
 
bool trapEnterKeyEvent
 
bool urlDropsEnabled
 
- Properties inherited from QLineEdit
 acceptableInput
 
 alignment
 
 clearButtonEnabled
 
 cursorMoveStyle
 
 cursorPosition
 
 displayText
 
 dragEnabled
 
 echoMode
 
 frame
 
 hasSelectedText
 
 inputMask
 
 maxLength
 
 modified
 
 placeholderText
 
 readOnly
 
 redoAvailable
 
 selectedText
 
 text
 
 undoAvailable
 
- Properties inherited from QWidget
 acceptDrops
 
 accessibleDescription
 
 accessibleName
 
 autoFillBackground
 
 baseSize
 
 childrenRect
 
 childrenRegion
 
 contextMenuPolicy
 
 cursor
 
 enabled
 
 focus
 
 focusPolicy
 
 font
 
 frameGeometry
 
 frameSize
 
 fullScreen
 
 geometry
 
 height
 
 inputMethodHints
 
 isActiveWindow
 
 layoutDirection
 
 locale
 
 maximized
 
 maximumHeight
 
 maximumSize
 
 maximumWidth
 
 minimized
 
 minimumHeight
 
 minimumSize
 
 minimumSizeHint
 
 minimumWidth
 
 modal
 
 mouseTracking
 
 normalGeometry
 
 palette
 
 pos
 
 rect
 
 size
 
 sizeHint
 
 sizeIncrement
 
 sizePolicy
 
 statusTip
 
 styleSheet
 
 tabletTracking
 
 toolTip
 
 toolTipDuration
 
 updatesEnabled
 
 visible
 
 whatsThis
 
 width
 
 windowFilePath
 
 windowFlags
 
 windowIcon
 
 windowIconText
 
 windowModality
 
 windowModified
 
 windowOpacity
 
 windowTitle
 
 x
 
 y
 
- Properties inherited from QObject
 objectName
 

Signals

void aboutToShowContextMenu (QMenu *contextMenu)
 
void clearButtonClicked ()
 
void completion (const QString &)
 
void completionBoxActivated (const QString &)
 
void completionModeChanged (KCompletion::CompletionMode)
 
void returnPressed (const QString &)
 
void substringCompletion (const QString &)
 
void textRotation (KCompletionBase::KeyBindingType)
 
QT_MOC_COMPAT void userTextChanged (const QString &)
 

Public Slots

bool passwordMode () const
 
void rotateText (KCompletionBase::KeyBindingType type)
 
void setCompletedItems (const QStringList &items, bool autoSuggest=true) override
 
void setCompletedText (const QString &) override
 
void setPasswordMode (bool passwordMode=true)
 
virtual void setReadOnly (bool)
 
void setSqueezedText (const QString &text)
 
virtual void setText (const QString &)
 

Public Member Functions

 KLineEdit (const QString &string, QWidget *parent=nullptr)
 
 KLineEdit (QWidget *parent=nullptr)
 
 ~KLineEdit () override
 
QSize clearButtonUsedSize () const
 
QString clickMessage () const
 
virtual KCompletionBoxcompletionBox (bool create=true)
 
virtual void copy () const
 
void doCompletion (const QString &text)
 
bool isClearButtonShown () const
 
bool isContextMenuEnabled () const
 
bool isSqueezedTextEnabled () const
 
QString originalText () const
 
void setClearButtonShown (bool show)
 
void setClickMessage (const QString &msg)
 
void setCompletionBox (KCompletionBox *box)
 
void setCompletionMode (KCompletion::CompletionMode mode) override
 
void setCompletionModeDisabled (KCompletion::CompletionMode mode, bool disable=true)
 
void setCompletionObject (KCompletion *, bool handle=true) override
 
virtual void setContextMenuEnabled (bool showMenu)
 
void setSqueezedTextEnabled (bool enable)
 
void setTrapReturnKey (bool trap)
 
void setUrl (const QUrl &url)
 
void setUrlDropsEnabled (bool enable)
 
bool trapReturnKey () const
 
bool urlDropsEnabled () const
 
QString userText () const
 
- Public Member Functions inherited from QLineEdit
 QLineEdit (QWidget *parent)
 
 QLineEdit (const QString &contents, QWidget *parent)
 
void addAction (QAction *action, QLineEdit::ActionPosition position)
 
QActionaddAction (const QIcon &icon, QLineEdit::ActionPosition position)
 
Qt::Alignment alignment () const const
 
void backspace ()
 
void clear ()
 
QCompletercompleter () const const
 
void copy () const const
 
QMenucreateStandardContextMenu ()
 
void cursorBackward (bool mark, int steps)
 
void cursorForward (bool mark, int steps)
 
Qt::CursorMoveStyle cursorMoveStyle () const const
 
int cursorPosition () const const
 
int cursorPositionAt (const QPoint &pos)
 
void cursorPositionChanged (int oldPos, int newPos)
 
void cursorWordBackward (bool mark)
 
void cursorWordForward (bool mark)
 
void cut ()
 
void del ()
 
void deselect ()
 
QString displayText () const const
 
bool dragEnabled () const const
 
QLineEdit::EchoMode echoMode () const const
 
void editingFinished ()
 
void end (bool mark)
 
void getTextMargins (int *left, int *top, int *right, int *bottom) const const
 
bool hasAcceptableInput () const const
 
bool hasFrame () const const
 
bool hasSelectedText () const const
 
void home (bool mark)
 
QString inputMask () const const
 
virtual QVariant inputMethodQuery (Qt::InputMethodQuery property) const const override
 
void inputRejected ()
 
void insert (const QString &newText)
 
bool isClearButtonEnabled () const const
 
bool isModified () const const
 
bool isReadOnly () const const
 
bool isRedoAvailable () const const
 
bool isUndoAvailable () const const
 
int maxLength () const const
 
virtual QSize minimumSizeHint () const const override
 
void paste ()
 
QString placeholderText () const const
 
void redo ()
 
void returnPressed ()
 
void selectAll ()
 
QString selectedText () const const
 
void selectionChanged ()
 
int selectionEnd () const const
 
int selectionLength () const const
 
int selectionStart () const const
 
void setAlignment (Qt::Alignment flag)
 
void setClearButtonEnabled (bool enable)
 
void setCompleter (QCompleter *c)
 
void setCursorMoveStyle (Qt::CursorMoveStyle style)
 
void setCursorPosition (int)
 
void setDragEnabled (bool b)
 
void setEchoMode (QLineEdit::EchoMode)
 
void setFrame (bool)
 
void setInputMask (const QString &inputMask)
 
void setMaxLength (int)
 
void setModified (bool)
 
void setPlaceholderText (const QString &)
 
void setReadOnly (bool)
 
void setSelection (int start, int length)
 
void setText (const QString &)
 
void setTextMargins (int left, int top, int right, int bottom)
 
void setTextMargins (const QMargins &margins)
 
void setValidator (const QValidator *v)
 
virtual QSize sizeHint () const const override
 
QString text () const const
 
void textChanged (const QString &text)
 
void textEdited (const QString &text)
 
QMargins textMargins () const const
 
void undo ()
 
const QValidatorvalidator () const const
 
- Public Member Functions inherited from QWidget
 QWidget (QWidget *parent, Qt::WindowFlags f)
 
bool acceptDrops () const const
 
QString accessibleDescription () const const
 
QString accessibleName () const const
 
QList< QAction * > actions () const const
 
void activateWindow ()
 
void addAction (QAction *action)
 
void addActions (QList< QAction * > actions)
 
void adjustSize ()
 
bool autoFillBackground () const const
 
QPalette::ColorRole backgroundRole () const const
 
QBackingStorebackingStore () const const
 
QSize baseSize () const const
 
QWidgetchildAt (int x, int y) const const
 
QWidgetchildAt (const QPoint &p) const const
 
QRect childrenRect () const const
 
QRegion childrenRegion () const const
 
void clearFocus ()
 
void clearMask ()
 
bool close ()
 
QMargins contentsMargins () const const
 
QRect contentsRect () const const
 
Qt::ContextMenuPolicy contextMenuPolicy () const const
 
QCursor cursor () const const
 
void customContextMenuRequested (const QPoint &pos)
 
WId effectiveWinId () const const
 
void ensurePolished () const const
 
Qt::FocusPolicy focusPolicy () const const
 
QWidgetfocusProxy () const const
 
QWidgetfocusWidget () const const
 
const QFontfont () const const
 
QFontInfo fontInfo () const const
 
QFontMetrics fontMetrics () const const
 
QPalette::ColorRole foregroundRole () const const
 
QRect frameGeometry () const const
 
QSize frameSize () const const
 
const QRectgeometry () const const
 
void getContentsMargins (int *left, int *top, int *right, int *bottom) const const
 
QPixmap grab (const QRect &rectangle)
 
void grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)
 
void grabKeyboard ()
 
void grabMouse ()
 
void grabMouse (const QCursor &cursor)
 
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)
 
QGraphicsEffectgraphicsEffect () const const
 
QGraphicsProxyWidgetgraphicsProxyWidget () const const
 
bool hasEditFocus () const const
 
bool hasFocus () const const
 
virtual bool hasHeightForWidth () const const
 
bool hasMouseTracking () const const
 
bool hasTabletTracking () const const
 
int height () const const
 
virtual int heightForWidth (int w) const const
 
void hide ()
 
Qt::InputMethodHints inputMethodHints () const const
 
void insertAction (QAction *before, QAction *action)
 
void insertActions (QAction *before, QList< QAction * > actions)
 
bool isActiveWindow () const const
 
bool isAncestorOf (const QWidget *child) const const
 
bool isEnabled () const const
 
bool isEnabledTo (const QWidget *ancestor) const const
 
bool isEnabledToTLW () const const
 
bool isFullScreen () const const
 
bool isHidden () const const
 
bool isMaximized () const const
 
bool isMinimized () const const
 
bool isModal () const const
 
bool isTopLevel () const const
 
bool isVisible () const const
 
bool isVisibleTo (const QWidget *ancestor) const const
 
bool isWindow () const const
 
bool isWindowModified () const const
 
QLayoutlayout () const const
 
Qt::LayoutDirection layoutDirection () const const
 
QLocale locale () const const
 
void lower ()
 
QPoint mapFrom (const QWidget *parent, const QPoint &pos) const const
 
QPoint mapFromGlobal (const QPoint &pos) const const
 
QPoint mapFromParent (const QPoint &pos) const const
 
QPoint mapTo (const QWidget *parent, const QPoint &pos) const const
 
QPoint mapToGlobal (const QPoint &pos) const const
 
QPoint mapToParent (const QPoint &pos) const const
 
QRegion mask () const const
 
int maximumHeight () const const
 
QSize maximumSize () const const
 
int maximumWidth () const const
 
int minimumHeight () const const
 
QSize minimumSize () const const
 
int minimumWidth () const const
 
void move (int x, int y)
 
void move (const QPoint &)
 
QWidgetnativeParentWidget () const const
 
QWidgetnextInFocusChain () const const
 
QRect normalGeometry () const const
 
void overrideWindowFlags (Qt::WindowFlags flags)
 
virtual QPaintEnginepaintEngine () const const override
 
const QPalettepalette () const const
 
QWidgetparentWidget () const const
 
QPoint pos () const const
 
QWidgetpreviousInFocusChain () const const
 
 QWIDGETSIZE_MAX QWIDGETSIZE_MAX
 
void raise ()
 
QRect rect () const const
 
void releaseKeyboard ()
 
void releaseMouse ()
 
void releaseShortcut (int id)
 
void removeAction (QAction *action)
 
void render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
 
void render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
 
void repaint ()
 
void repaint (int x, int y, int w, int h)
 
void repaint (const QRect &rect)
 
void repaint (const QRegion &rgn)
 
void resize (int w, int h)
 
void resize (const QSize &)
 
bool restoreGeometry (const QByteArray &geometry)
 
QByteArray saveGeometry () const const
 
QScreenscreen () const const
 
void scroll (int dx, int dy)
 
void scroll (int dx, int dy, const QRect &r)
 
void setAcceptDrops (bool on)
 
void setAccessibleDescription (const QString &description)
 
void setAccessibleName (const QString &name)
 
void setAttribute (Qt::WidgetAttribute attribute, bool on)
 
void setAutoFillBackground (bool enabled)
 
void setBackgroundRole (QPalette::ColorRole role)
 
void setBaseSize (int basew, int baseh)
 
void setBaseSize (const QSize &)
 
void setContentsMargins (const QMargins &margins)
 
void setContentsMargins (int left, int top, int right, int bottom)
 
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
 
void setCursor (const QCursor &)
 
void setDisabled (bool disable)
 
void setEditFocus (bool enable)
 
void setEnabled (bool)
 
void setFixedHeight (int h)
 
void setFixedSize (const QSize &s)
 
void setFixedSize (int w, int h)
 
void setFixedWidth (int w)
 
void setFocus (Qt::FocusReason reason)
 
void setFocus ()
 
void setFocusPolicy (Qt::FocusPolicy policy)
 
void setFocusProxy (QWidget *w)
 
void setFont (const QFont &)
 
void setForegroundRole (QPalette::ColorRole role)
 
void setGeometry (const QRect &)
 
void setGeometry (int x, int y, int w, int h)
 
void setGraphicsEffect (QGraphicsEffect *effect)
 
void setHidden (bool hidden)
 
void setInputMethodHints (Qt::InputMethodHints hints)
 
void setLayout (QLayout *layout)
 
void setLayoutDirection (Qt::LayoutDirection direction)
 
void setLocale (const QLocale &locale)
 
void setMask (const QBitmap &bitmap)
 
void setMask (const QRegion &region)
 
void setMaximumHeight (int maxh)
 
void setMaximumSize (int maxw, int maxh)
 
void setMaximumSize (const QSize &)
 
void setMaximumWidth (int maxw)
 
void setMinimumHeight (int minh)
 
void setMinimumSize (const QSize &)
 
void setMinimumSize (int minw, int minh)
 
void setMinimumWidth (int minw)
 
void setMouseTracking (bool enable)
 
void setPalette (const QPalette &)
 
void setParent (QWidget *parent, Qt::WindowFlags f)
 
void setParent (QWidget *parent)
 
void setShortcutAutoRepeat (int id, bool enable)
 
void setShortcutEnabled (int id, bool enable)
 
void setSizeIncrement (const QSize &)
 
void setSizeIncrement (int w, int h)
 
void setSizePolicy (QSizePolicy)
 
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
 
void setStatusTip (const QString &)
 
void setStyle (QStyle *style)
 
void setStyleSheet (const QString &styleSheet)
 
void setTabletTracking (bool enable)
 
void setToolTip (const QString &)
 
void setToolTipDuration (int msec)
 
void setUpdatesEnabled (bool enable)
 
void setupUi (QWidget *widget)
 
virtual void setVisible (bool visible)
 
void setWhatsThis (const QString &)
 
void setWindowFilePath (const QString &filePath)
 
void setWindowFlag (Qt::WindowType flag, bool on)
 
void setWindowFlags (Qt::WindowFlags type)
 
void setWindowIcon (const QIcon &icon)
 
void setWindowIconText (const QString &)
 
void setWindowModality (Qt::WindowModality windowModality)
 
void setWindowModified (bool)
 
void setWindowOpacity (qreal level)
 
void setWindowRole (const QString &role)
 
void setWindowState (Qt::WindowStates windowState)
 
void setWindowTitle (const QString &)
 
void show ()
 
void showFullScreen ()
 
void showMaximized ()
 
void showMinimized ()
 
void showNormal ()
 
QSize size () const const
 
QSize sizeIncrement () const const
 
QSizePolicy sizePolicy () const const
 
void stackUnder (QWidget *w)
 
QString statusTip () const const
 
QStylestyle () const const
 
QString styleSheet () const const
 
bool testAttribute (Qt::WidgetAttribute attribute) const const
 
QString toolTip () const const
 
int toolTipDuration () const const
 
QWidgettopLevelWidget () const const
 
bool underMouse () const const
 
void ungrabGesture (Qt::GestureType gesture)
 
void unsetCursor ()
 
void unsetLayoutDirection ()
 
void unsetLocale ()
 
void update (int x, int y, int w, int h)
 
void update (const QRect &rect)
 
void update (const QRegion &rgn)
 
void update ()
 
void updateGeometry ()
 
bool updatesEnabled () const const
 
QRegion visibleRegion () const const
 
QString whatsThis () const const
 
int width () const const
 
QWidgetwindow () const const
 
QString windowFilePath () const const
 
Qt::WindowFlags windowFlags () const const
 
QWindowwindowHandle () const const
 
QIcon windowIcon () const const
 
void windowIconChanged (const QIcon &icon)
 
QString windowIconText () const const
 
void windowIconTextChanged (const QString &iconText)
 
Qt::WindowModality windowModality () const const
 
qreal windowOpacity () const const
 
QString windowRole () const const
 
Qt::WindowStates windowState () const const
 
QString windowTitle () const const
 
void windowTitleChanged (const QString &title)
 
Qt::WindowType windowType () const const
 
WId winId () const const
 
int x () const const
 
int y () const const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 
- Public Member Functions inherited from QPaintDevice
int colorCount () const const
 
int depth () const const
 
int devicePixelRatio () const const
 
qreal devicePixelRatioF () const const
 
int height () const const
 
int heightMM () const const
 
int logicalDpiX () const const
 
int logicalDpiY () const const
 
bool paintingActive () const const
 
int physicalDpiX () const const
 
int physicalDpiY () const const
 
int width () const const
 
int widthMM () const const
 
- Public Member Functions inherited from KCompletionBase
 KCompletionBase ()
 
virtual ~KCompletionBase ()
 
KCompletion::CompletionMode completionMode () const
 
KCompletioncompletionObject (bool handleSignals=true)
 
KCompletioncompObj () const
 
bool emitSignals () const
 
QList< QKeySequencegetKeyBinding (KeyBindingType item) const
 
bool handleSignals () const
 
bool isCompletionObjectAutoDeleted () const
 
QList< QKeySequencekeyBinding (KeyBindingType item) const
 
void setAutoDeleteCompletionObject (bool autoDelete)
 
virtual void setCompletedItems (const QStringList &items, bool autoSuggest=true)=0
 
virtual void setCompletedText (const QString &text)=0
 
void setEmitSignals (bool emitRotationSignals)
 
void setEnableSignals (bool enable)
 
virtual void setHandleSignals (bool handle)
 
bool setKeyBinding (KeyBindingType item, const QList< QKeySequence > &key)
 
void useGlobalKeyBindings ()
 

Protected Slots

virtual void makeCompletion (const QString &)
 
void userCancelled (const QString &cancelText)
 

Protected Member Functions

bool autoSuggest () const
 
void contextMenuEvent (QContextMenuEvent *) override
 
QMenucreateStandardContextMenu ()
 
bool event (QEvent *) override
 
void keyPressEvent (QKeyEvent *) override
 
void mouseDoubleClickEvent (QMouseEvent *) override
 
void mousePressEvent (QMouseEvent *) override
 
void mouseReleaseEvent (QMouseEvent *) override
 
void paintEvent (QPaintEvent *ev) override
 
void resizeEvent (QResizeEvent *) override
 
virtual void setCompletedText (const QString &, bool)
 
void setUserSelection (bool userSelection)
 
- Protected Member Functions inherited from QLineEdit
virtual void changeEvent (QEvent *ev) override
 
QRect cursorRect () const const
 
virtual void dragEnterEvent (QDragEnterEvent *e) override
 
virtual void dragLeaveEvent (QDragLeaveEvent *e) override
 
virtual void dragMoveEvent (QDragMoveEvent *e) override
 
virtual void dropEvent (QDropEvent *e) override
 
virtual void focusInEvent (QFocusEvent *e) override
 
virtual void focusOutEvent (QFocusEvent *e) override
 
void initStyleOption (QStyleOptionFrame *option) const const
 
virtual void inputMethodEvent (QInputMethodEvent *e) override
 
virtual void mouseMoveEvent (QMouseEvent *e) override
 
- Protected Member Functions inherited from QWidget
virtual void actionEvent (QActionEvent *event)
 
virtual void closeEvent (QCloseEvent *event)
 
void create (WId window, bool initializeWindow, bool destroyOldWindow)
 
void destroy (bool destroyWindow, bool destroySubWindows)
 
virtual void enterEvent (QEvent *event)
 
bool focusNextChild ()
 
virtual bool focusNextPrevChild (bool next)
 
bool focusPreviousChild ()
 
virtual void hideEvent (QHideEvent *event)
 
virtual void initPainter (QPainter *painter) const const override
 
virtual void keyReleaseEvent (QKeyEvent *event)
 
virtual void leaveEvent (QEvent *event)
 
virtual int metric (QPaintDevice::PaintDeviceMetric m) const const override
 
virtual void moveEvent (QMoveEvent *event)
 
virtual bool nativeEvent (const QByteArray &eventType, void *message, long *result)
 
virtual void showEvent (QShowEvent *event)
 
virtual void tabletEvent (QTabletEvent *event)
 
void updateMicroFocus ()
 
virtual void wheelEvent (QWheelEvent *event)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 
- Protected Member Functions inherited from KCompletionBase
KCompletionBasedelegate () const
 
KeyBindingMap getKeyBindings () const
 
KeyBindingMap keyBindingMap () const
 
void setDelegate (KCompletionBase *delegate)
 
void setKeyBindingMap (KeyBindingMap keyBindingMap)
 
virtual void virtual_hook (int id, void *data)
 

Additional Inherited Members

- Public Types inherited from QLineEdit
enum  ActionPosition
 
enum  EchoMode
 
- Public Types inherited from QWidget
enum  RenderFlag
 
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric
 
- Public Types inherited from KCompletionBase
typedef QMap< KeyBindingType, QList< QKeySequence > > KeyBindingMap
 
enum  KeyBindingType { TextCompletion, PrevCompletionMatch, NextCompletionMatch, SubstringCompletion }
 
- Static Public Member Functions inherited from QWidget
QWidgetcreateWindowContainer (QWindow *window, QWidget *parent, Qt::WindowFlags flags)
 
QWidgetfind (WId id)
 
QWidgetkeyboardGrabber ()
 
QWidgetmouseGrabber ()
 
void setTabOrder (QWidget *first, QWidget *second)
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QLineEdit
 LeadingPosition
 
 NoEcho
 
 Normal
 
 Password
 
 PasswordEchoOnEdit
 
 TrailingPosition
 
- Public Attributes inherited from QWidget
 DrawChildren
 
 DrawWindowBackground
 
 IgnoreMask
 
typedef RenderFlags
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Public Attributes inherited from QPaintDevice
 PdmDepth
 
 PdmDevicePixelRatio
 
 PdmDevicePixelRatioScaled
 
 PdmDpiX
 
 PdmDpiY
 
 PdmHeight
 
 PdmHeightMM
 
 PdmNumColors
 
 PdmPhysicalDpiX
 
 PdmPhysicalDpiY
 
 PdmWidth
 
 PdmWidthMM
 

Detailed Description

An enhanced QLineEdit widget for inputting text.

Detail
This widget inherits from QLineEdit and implements the following additional functionalities: a completion object that provides both automatic and manual text completion as well as multiple match iteration features, configurable key-bindings to activate these features and a popup-menu item that can be used to allow the user to set text completion modes on the fly based on their preference.

To support these new features KLineEdit also emits a few more additional signals. These are: completion( const QString& ), textRotation( KeyBindingType ), and returnPressed( const QString& ). The completion signal can be connected to a slot that will assist the user in filling out the remaining text. The text rotation signal is intended to be used to iterate through the list of all possible matches whenever there is more than one match for the entered text. The returnPressed( const QString& ) signals are the same as QLineEdit's except it provides the current text in the widget as its argument whenever appropriate.

This widget by default creates a completion object when you invoke the completionObject( bool ) member function for the first time or use setCompletionObject( KCompletion*, bool ) to assign your own completion object. Additionally, to make this widget more functional, KLineEdit will by default handle the text rotation and completion events internally when a completion object is created through either one of the methods mentioned above. If you do not need this functionality, simply use KCompletionBase::setHandleSignals( bool ) or set the boolean parameter in the above functions to false.

The default key-bindings for completion and rotation is determined from the global settings in KStandardShortcut. These values, however, can be overridden locally by invoking KCompletionBase::setKeyBinding(). The values can easily be reverted back to the default setting, by simply calling useGlobalSettings(). An alternate method would be to default individual key-bindings by using setKeyBinding() with the default second argument.

If EchoMode for this widget is set to something other than QLineEdit::Normal, the completion mode will always be defaulted to CompletionNone. This is done purposefully to guard against protected entries such as passwords being cached in KCompletion's list. Hence, if the EchoMode is not QLineEdit::Normal, the completion mode is automatically disabled.

A read-only KLineEdit will have the same background color as a disabled KLineEdit, but its foreground color will be the one used for the read-write mode. This differs from QLineEdit's implementation and is done to give visual distinction between the three different modes: disabled, read-only, and read-write.

KLineEdit has also a password mode which depends of globals KDE settings. Use KLineEdit::setPasswordMode instead of QLineEdit::echoMode property to have a password field.

Usage
To enable the basic completion feature:

KLineEdit *edit = new KLineEdit( this );
KCompletion *comp = edit->completionObject();
// Connect to the return pressed signal - optional
connect(edit,SIGNAL(returnPressed(const QString&)),comp,SLOT(addItem(const QString&)));

To use a customized completion objects or your own completion object:

KLineEdit *edit = new KLineEdit( this );
edit->setCompletionObject( comp );
// Connect to the return pressed signal - optional
connect(edit,SIGNAL(returnPressed(const QString&)),comp,SLOT(addItem(const QString&)));

Note if you specify your own completion object you have to either delete it when you don't need it anymore, or you can tell KLineEdit to delete it for you:

Miscellaneous function calls :

// Tell the widget to not handle completion and iteration automatically.
edit->setHandleSignals( false );
// Set your own key-bindings for a text completion mode.
// Hide the context (popup) menu
// Default the key-bindings back to the default system settings.
klineedit.png
KLineEdit widgets with clear-button
Author
Dawit Alemayehu adawi[email protected][email protected][email protected]e.org

Definition at line 140 of file klineedit.h.

Constructor & Destructor Documentation

KLineEdit::KLineEdit ( const QString string,
QWidget parent = nullptr 
)
explicit

Constructs a KLineEdit object with a default text, a parent, and a name.

Parameters
stringText to be shown in the edit widget.
parentThe parent widget of the line edit.

Definition at line 128 of file klineedit.cpp.

KLineEdit::KLineEdit ( QWidget parent = nullptr)
explicit

Constructs a line edit.

Parameters
parentThe parent widget of the line edit.

Definition at line 135 of file klineedit.cpp.

KLineEdit::~KLineEdit ( )
override

Destructor.

Definition at line 142 of file klineedit.cpp.

Member Function Documentation

void KLineEdit::aboutToShowContextMenu ( QMenu contextMenu)
signal

Emitted before the context menu is displayed.

The signal allows you to add your own entries into the the context menu that is created on demand.

NOTE: Do not store the pointer to the QMenu provided through since it is created and deleted on demand.

Parameters
contextMenuthe context menu about to be displayed
bool KLineEdit::autoSuggest ( ) const
protected

Whether in current state text should be auto-suggested.

Definition at line 1387 of file klineedit.cpp.

void KLineEdit::clearButtonClicked ( )
signal

Emitted when the user clicked on the clear button.

QSize KLineEdit::clearButtonUsedSize ( ) const
Returns
the size used by the clear button
Since
4.1

Definition at line 167 of file klineedit.cpp.

QString KLineEdit::clickMessage ( ) const
Returns
the message set with setClickMessage
Deprecated:
since 5.0, use QLineEdit::placeholderText instead.
void KLineEdit::completion ( const QString )
signal

Emitted when the completion key is pressed.

Please note that this signal is not emitted if the completion mode is set to CompletionNone or EchoMode is normal.

KCompletionBox * KLineEdit::completionBox ( bool  create = true)
virtual
Returns
the completion-box, that is used in completion mode CompletionPopup. This method will create a completion-box if none is there, yet.
Parameters
createSet this to false if you don't want the box to be created i.e. to test if it is available.

Definition at line 1299 of file klineedit.cpp.

void KLineEdit::completionBoxActivated ( const QString )
signal

Emitted whenever the completion box is activated.

void KLineEdit::completionModeChanged ( KCompletion::CompletionMode  )
signal

Emitted when the user changed the completion mode by using the popupmenu.

void KLineEdit::contextMenuEvent ( QContextMenuEvent e)
overrideprotectedvirtual

Reimplemented for internal reasons.

API not affected.

See QLineEdit::contextMenuEvent().

Reimplemented from QLineEdit.

Definition at line 987 of file klineedit.cpp.

void KLineEdit::copy ( ) const
virtual

Reimplemented for internal reasons, the API is not affected.

Definition at line 438 of file klineedit.cpp.

QMenu * KLineEdit::createStandardContextMenu ( )
protected

Reimplemented for internal reasons.

API not affected.

See QLineEdit::createStandardContextMenu().

Definition at line 906 of file klineedit.cpp.

void KLineEdit::doCompletion ( const QString text)

Do completion now.

This is called automatically when typing a key for instance. Emits completion() and/or calls makeCompletion(), depending on emitSignals and handleSignals.

Since
4.2.1

Definition at line 1463 of file klineedit.cpp.

bool KLineEdit::event ( QEvent ev)
overrideprotectedvirtual

Reimplemented for internal reasons.

API not affected.

Reimplemented from QLineEdit.

Definition at line 1036 of file klineedit.cpp.

bool KLineEdit::isClearButtonShown ( ) const
Returns
whether or not the clear button is shown
Deprecated:
since 5.46 Use QLineEdit::isClearButtonEnabled

Definition at line 161 of file klineedit.cpp.

bool KLineEdit::isContextMenuEnabled ( ) const

Returns true when the context menu is enabled.

Deprecated:
since 4.5, use contextMenuPolicy instead

Definition at line 1435 of file klineedit.cpp.

bool KLineEdit::isSqueezedTextEnabled ( ) const

Returns true if text squeezing is enabled.

This is only valid when the widget is in read-only mode.

Definition at line 353 of file klineedit.cpp.

void KLineEdit::keyPressEvent ( QKeyEvent e)
overrideprotectedvirtual

Reimplemented for internal reasons.

API not affected.

See QLineEdit::keyPressEvent().

Reimplemented from QLineEdit.

Definition at line 489 of file klineedit.cpp.

void KLineEdit::makeCompletion ( const QString text)
protectedvirtualslot

Completes the remaining text with a matching one from a given list.

Definition at line 275 of file klineedit.cpp.

void KLineEdit::mouseDoubleClickEvent ( QMouseEvent e)
overrideprotectedvirtual

Reimplemented for internal reasons.

API not affected.

See QWidget::mouseDoubleClickEvent().

Reimplemented from QLineEdit.

Definition at line 855 of file klineedit.cpp.

void KLineEdit::mousePressEvent ( QMouseEvent e)
overrideprotectedvirtual

Reimplemented for internal reasons.

API not affected.

See QLineEdit::mousePressEvent().

Reimplemented from QLineEdit.

Definition at line 866 of file klineedit.cpp.

void KLineEdit::mouseReleaseEvent ( QMouseEvent e)
overrideprotectedvirtual

Reimplemented for internal reasons.

API not affected.

See QLineEdit::mouseReleaseEvent().

Reimplemented from QLineEdit.

Definition at line 888 of file klineedit.cpp.

QString KLineEdit::originalText ( ) const

Returns the original text if text squeezing is enabled.

If the widget is not in "read-only" mode, this function returns the same thing as QLineEdit::text().

See also
QLineEdit

Definition at line 1371 of file klineedit.cpp.

bool KLineEdit::passwordMode ( ) const
slot
Returns
returns true if the lineedit is set to password mode echoing
void KLineEdit::resizeEvent ( QResizeEvent ev)
overrideprotectedvirtual

Reimplemented for internal reasons.

API not affected.

See QLineEdit::resizeEvent().

Reimplemented from QWidget.

Definition at line 479 of file klineedit.cpp.

void KLineEdit::returnPressed ( const QString )
signal

Emitted when the user presses the return key.

The argument is the current text. Note that this signal is not emitted if the widget's EchoMode is set to QLineEdit::EchoMode.

void KLineEdit::rotateText ( KCompletionBase::KeyBindingType  type)
slot

Iterates through all possible matches of the completed text or the history list.

This function simply iterates over all possible matches in case multiple matches are found as a result of a text completion request. It will have no effect if only a single match is found.

Parameters
typeThe key-binding invoked.

Definition at line 253 of file klineedit.cpp.

void KLineEdit::setClearButtonShown ( bool  show)

This makes the line edit display an icon on one side of the line edit which, when clicked, clears the contents of the line edit.

This is useful for such things as location or search bars.

Deprecated:
since 5.46 Use QLineEdit::setClearButtonEnabled

Definition at line 154 of file klineedit.cpp.

void KLineEdit::setClickMessage ( const QString msg)

This makes the line edit display a grayed-out hinting text as long as the user didn't enter any text.

It is often used as indication about the purpose of the line edit.

Deprecated:
since 5.0, use QLineEdit::setPlaceholderText instead.

Definition at line 1421 of file klineedit.cpp.

void KLineEdit::setCompletedItems ( const QStringList items,
bool  autoSuggest = true 
)
overrideslot

Same as the above function except it allows you to temporarily turn off text completion in CompletionPopupAuto mode.

Parameters
itemslist of completion matches to be shown in the completion box.
autoSuggesttrue if you want automatic text completion (suggestion) enabled.

Definition at line 1241 of file klineedit.cpp.

void KLineEdit::setCompletedText ( const QString text)
overrideslot

See KCompletionBase::setCompletedText.

Definition at line 243 of file klineedit.cpp.

void KLineEdit::setCompletedText ( const QString t,
bool  marked 
)
protectedvirtual

This function simply sets the lineedit text and highlights the text appropriately if the boolean value is set to true.

Parameters
text
marked

Definition at line 222 of file klineedit.cpp.

void KLineEdit::setCompletionBox ( KCompletionBox box)

Set the completion-box to be used in completion mode CompletionPopup.

This will do nothing if a completion-box already exists.

Parameters
boxThe KCompletionBox to set

Definition at line 1104 of file klineedit.cpp.

void KLineEdit::setCompletionMode ( KCompletion::CompletionMode  mode)
overridevirtual

Reimplemented from KCompletionBase for internal reasons.

This function is re-implemented in order to make sure that the EchoMode is acceptable before we set the completion mode.

See KCompletionBase::setCompletionMode

Reimplemented from KCompletionBase.

Definition at line 184 of file klineedit.cpp.

void KLineEdit::setCompletionModeDisabled ( KCompletion::CompletionMode  mode,
bool  disable = true 
)

Disables completion modes by makeing them non-checkable.

The context menu allows to change the completion mode. This method allows to disable some modes.

Definition at line 216 of file klineedit.cpp.

void KLineEdit::setCompletionObject ( KCompletion comp,
bool  handle = true 
)
overridevirtual

Reimplemented for internal reasons, the API is not affected.

Reimplemented from KCompletionBase.

Definition at line 1311 of file klineedit.cpp.

void KLineEdit::setContextMenuEnabled ( bool  showMenu)
virtual

Enables/disables the popup (context) menu.

This method only works if this widget is editable, i.e. read-write and allows you to enable/disable the context menu. It does nothing if invoked for a none-editable combo-box.

By default, the context menu is created if this widget is editable. Call this function with the argument set to false to disable the popup menu.

Parameters
showMenuIf true, show the context menu.
Deprecated:
since 4.5, use setContextMenuPolicy instead

Definition at line 1428 of file klineedit.cpp.

void KLineEdit::setPasswordMode ( bool  passwordMode = true)
slot

set the line edit in password mode.

this change the EchoMode according to KDE preferences.

Parameters
passwordModetrue to set in password mode

Definition at line 1441 of file klineedit.cpp.

void KLineEdit::setReadOnly ( bool  readOnly)
virtualslot

Sets the lineedit to read-only.

Similar to QLineEdit::setReadOnly but also takes care of the background color, and the clear button.

Definition at line 314 of file klineedit.cpp.

void KLineEdit::setSqueezedText ( const QString text)
slot

Squeezes text into the line edit.

This can only be used with read-only line-edits.

Definition at line 341 of file klineedit.cpp.

void KLineEdit::setSqueezedTextEnabled ( bool  enable)

Enable text squeezing whenever the supplied text is too long.

Only works for "read-only" mode.

Note that once text squeezing is enabled, QLineEdit::text() and QLineEdit::displayText() return the squeezed text. If you want the original text, use originalText.

See also
QLineEdit

Definition at line 347 of file klineedit.cpp.

void KLineEdit::setText ( const QString text)
virtualslot

Reimplemented to enable text squeezing.

API is not affected.

Definition at line 359 of file klineedit.cpp.

void KLineEdit::setTrapReturnKey ( bool  trap)

By default, KLineEdit recognizes Key_Return and Key_Enter and emits the returnPressed() signals, but it also lets the event pass, for example causing a dialog's default-button to be called.

Call this method with trap = true to make KLineEdit stop these events. The signals will still be emitted of course.

See also
trapReturnKey()

Definition at line 1087 of file klineedit.cpp.

void KLineEdit::setUrl ( const QUrl url)

Sets url into the lineedit.

It uses QUrl::toDisplayString() so that the url is properly decoded for displaying.

Definition at line 1099 of file klineedit.cpp.

void KLineEdit::setUrlDropsEnabled ( bool  enable)

Enables/Disables handling of URL drops.

If enabled and the user drops an URL, the decoded URL will be inserted. Otherwise the default behavior of QLineEdit is used, which inserts the encoded URL. Call setUrlDropsEnabled(false) if you need dropEvent to be called in a KLineEdit subclass.

Parameters
enableIf true, insert decoded URLs

Definition at line 1068 of file klineedit.cpp.

void KLineEdit::setUserSelection ( bool  userSelection)
protected

Sets the widget in userSelection mode or in automatic completion selection mode.

This changes the colors of selections.

Definition at line 1325 of file klineedit.cpp.

void KLineEdit::substringCompletion ( const QString )
signal

Emitted when the shortcut for substring completion is pressed.

void KLineEdit::textRotation ( KCompletionBase::KeyBindingType  )
signal

Emitted when the text rotation key-bindings are pressed.

The argument indicates which key-binding was pressed. In KLineEdit's case this can be either one of two values: PrevCompletionMatch or NextCompletionMatch. See KCompletionBase::setKeyBinding for details.

Note that this signal is not emitted if the completion mode is set to CompletionNone or echoMode() is not normal.

bool KLineEdit::trapReturnKey ( ) const
Returns
true if keyevents of Key_Return or Key_Enter will be stopped or if they will be propagated.
See also
setTrapReturnKey ()

Definition at line 1093 of file klineedit.cpp.

bool KLineEdit::urlDropsEnabled ( ) const

Returns true when decoded URL drops are enabled.

void KLineEdit::userCancelled ( const QString cancelText)
protectedslot

Resets the current displayed text.

Call this function to revert a text completion if the user cancels the request. Mostly applies to popup completions.

Definition at line 1139 of file klineedit.cpp.

QString KLineEdit::userText ( ) const

Returns the text as given by the user (i.e.

not autocompleted) if the widget has autocompletion disabled, this function returns the same as QLineEdit::text().

Since
4.2.2

Definition at line 1381 of file klineedit.cpp.

QT_MOC_COMPAT void KLineEdit::userTextChanged ( const QString )
signal

Emitted when the text is changed NOT by the suggested autocompletion: either when the user is physically typing keys, or when the text is changed programmatically, for example, by calling setText().

But not when automatic completion changes the text temporarily.

Since
4.2.2
Deprecated:
since 4.5. You probably want to connect to textEdited() instead, which is emitted whenever the text is actually changed by the user (by typing or accepting autocompletion), without side effects from suggested autocompletion either. userTextChanged isn't needed anymore.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed Aug 5 2020 22:50:13 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.