KShellCompletion
#include <KShellCompletion>

Public Member Functions | |
KShellCompletion () | |
QString | makeCompletion (const QString &text) override |
![]() | |
KUrlCompletion () | |
KUrlCompletion (Mode) | |
~KUrlCompletion () override | |
virtual QUrl | dir () const |
virtual bool | isRunning () const |
QString | makeCompletion (const QString &text) override |
QStringList | mimeTypeFilters () const |
virtual Mode | mode () const |
QString | replacedPath (const QString &text) const |
virtual bool | replaceEnv () const |
virtual bool | replaceHome () const |
virtual void | setDir (const QUrl &dir) |
void | setMimeTypeFilters (const QStringList &mimeTypes) |
virtual void | setMode (Mode mode) |
virtual void | setReplaceEnv (bool replace) |
virtual void | setReplaceHome (bool replace) |
virtual void | stop () |
![]() | |
QStringList | allMatches () |
QStringList | allMatches (const QString &string) |
KCompletionMatches | allWeightedMatches () |
KCompletionMatches | allWeightedMatches (const QString &string) |
CompletionMode | completionMode () const |
bool | hasMultipleMatches () const |
bool | ignoreCase () const |
bool | isEmpty () const |
QStringList | items () const |
virtual const QString & | lastMatch () const |
CompOrder | order () const |
virtual void | setCompletionMode (CompletionMode mode) |
virtual void | setIgnoreCase (bool ignoreCase) |
virtual void | setOrder (CompOrder order) |
virtual void | setSoundsEnabled (bool enable) |
bool | shouldAutoSuggest () const |
bool | soundsEnabled () const |
QStringList | substringCompletion (const QString &string) const |
![]() | |
QObject (QObject *parent) | |
bool | blockSignals (bool block) |
const QObjectList & | children () 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< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegExp ®Exp, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, 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 QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () 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 | |
T | qFindChild (const QObject *obj, const QString &name) |
QList< T > | qFindChildren (const QObject *obj, const QRegExp ®Exp) |
QList< T > | qFindChildren (const QObject *obj, const QString &name) |
T | qobject_cast (const QObject *object) |
T | qobject_cast (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) |
QThread * | thread () const const |
Protected Member Functions | |
void | postProcessMatch (QString *match) const override |
void | postProcessMatches (KCompletionMatches *matches) const override |
void | postProcessMatches (QStringList *matches) const override |
![]() | |
void | customEvent (QEvent *e) override |
void | postProcessMatch (QString *match) const override |
void | postProcessMatches (KCompletionMatches *matches) const override |
void | postProcessMatches (QStringList *matches) const override |
![]() | |
void | setShouldAutoSuggest (bool shouldAutosuggest) |
void | setSorterFunction (SorterFunction sortFunc) |
![]() | |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const QMetaMethod &signal) |
virtual void | disconnectNotify (const QMetaMethod &signal) |
bool | isSignalConnected (const QMetaMethod &signal) const const |
int | receivers (const char *signal) const const |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Additional Inherited Members | |
![]() | |
enum | Mode { ExeCompletion = 1, FileCompletion, DirCompletion } |
![]() | |
enum | CompletionMode |
enum | CompOrder |
typedef std::function< void(QStringList &)> | SorterFunction |
![]() | |
objectName | |
![]() | |
void | match (const QString &item) |
void | matches (const QStringList &matchlist) |
void | multipleMatches () |
![]() | |
void | addItem (const QString &item) |
void | addItem (const QString &item, uint weight) |
virtual void | clear () |
void | insertItems (const QStringList &items) |
QString | nextMatch () |
QString | previousMatch () |
void | removeItem (const QString &item) |
virtual void | setItems (const QStringList &itemList) |
void | slotMakeCompletion (const QString &string) |
void | slotNextMatch () |
void | slotPreviousMatch () |
![]() | |
static QString | replacedPath (const QString &text, bool replaceHome, bool replaceEnv=true) |
![]() | |
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 *context, Functor functor, 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) |
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, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
![]() | |
CompletionAuto | |
CompletionMan | |
CompletionNone | |
CompletionPopup | |
CompletionPopupAuto | |
CompletionShell | |
Insertion | |
Sorted | |
Weighted | |
![]() | |
typedef | QObjectList |
Detailed Description
Shell-like completion of file names.
This class does shell-like completion of file names. A string passed to makeCompletion() will be interpreted as a shell command line. Completion will be done on the last argument on the line. Returned matches consist of the first arguments (uncompleted) plus the completed last argument.
Definition at line 32 of file kshellcompletion.h.
Constructor & Destructor Documentation
◆ KShellCompletion()
KShellCompletion::KShellCompletion | ( | ) |
Constructs a KShellCompletion object.
Definition at line 38 of file kshellcompletion.cpp.
Member Function Documentation
◆ makeCompletion()
Finds completions to the given text.
The first match is returned and emitted in the signal match().
- Parameters
-
text the text to complete
- Returns
- the first match, or QString() if not found
Reimplemented from KCompletion.
Definition at line 51 of file kshellcompletion.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Sep 26 2023 03:52:57 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.