• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.10.5 API Reference
  • KDE Home
  • Contact Us
 

KIO

Public Member Functions | Protected Member Functions
KShellCompletion Class Reference

#include <kshellcompletion.h>

Inheritance diagram for KShellCompletion:
KUrlCompletion KCompletion QObject

List of all members.

Public Member Functions

 KShellCompletion ()
 ~KShellCompletion ()
QString makeCompletion (const QString &text)
- Public Member Functions inherited from KUrlCompletion
 KUrlCompletion ()
 KUrlCompletion (Mode)
virtual ~KUrlCompletion ()
virtual QString dir () const
virtual bool isRunning () const
virtual Mode mode () const
QString replacedPath (const QString &text) const
virtual bool replaceEnv () const
virtual bool replaceHome () const
virtual void setDir (const QString &dir)
virtual void setMode (Mode mode)
virtual void setReplaceEnv (bool replace)
virtual void setReplaceHome (bool replace)
virtual void stop ()
- Public Member Functions inherited from KCompletion
 KCompletion ()
virtual ~KCompletion ()
QStringList allMatches (const QString &string)
QStringList allMatches ()
KCompletionMatches allWeightedMatches ()
KCompletionMatches allWeightedMatches (const QString &string)
KGlobalSettings::Completion completionMode () const
bool hasMultipleMatches () const
bool ignoreCase () const
bool isEmpty () const
QStringList items () const
virtual const QString & lastMatch () const
QString nextMatch ()
CompOrder order () const
QString previousMatch ()
virtual void setCompletionMode (KGlobalSettings::Completion mode)
virtual void setIgnoreCase (bool ignoreCase)
virtual void setOrder (CompOrder order)
virtual void setSoundsEnabled (bool enable)
bool soundsEnabled () const
QStringList substringCompletion (const QString &string) const

Protected Member Functions

void postProcessMatch (QString *match) const
void postProcessMatches (QStringList *matches) const
void postProcessMatches (KCompletionMatches *matches) const
- Protected Member Functions inherited from KUrlCompletion
virtual void customEvent (QEvent *e)

Additional Inherited Members

- Public Types inherited from KUrlCompletion
enum  Mode { ExeCompletion = 1, FileCompletion, DirCompletion }
- Public Types inherited from KCompletion
enum  CompOrder
- Static Public Member Functions inherited from KUrlCompletion
static QString replacedPath (const QString &text, bool replaceHome, bool replaceEnv=true)

Detailed Description

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.

Shell-like completion of file names

Author:
David Smith dsmit.nosp@m.h@al.nosp@m.gonet.nosp@m..se

Definition at line 40 of file kshellcompletion.h.


Constructor & Destructor Documentation

KShellCompletion::KShellCompletion ( )

Constructs a KShellCompletion object.

Definition at line 53 of file kshellcompletion.cpp.

KShellCompletion::~KShellCompletion ( )

Definition at line 59 of file kshellcompletion.cpp.


Member Function Documentation

QString KShellCompletion::makeCompletion ( const QString &  text)
virtual

Finds completions to the given text.

The first match is returned and emitted in the signal match().

Parameters:
textthe text to complete
Returns:
the first match, or QString() if not found

Reimplemented from KUrlCompletion.

Definition at line 70 of file kshellcompletion.cpp.

void KShellCompletion::postProcessMatch ( QString *  match) const
protectedvirtual

Reimplemented from KUrlCompletion.

Definition at line 109 of file kshellcompletion.cpp.

void KShellCompletion::postProcessMatches ( QStringList *  matches) const
protectedvirtual

Reimplemented from KUrlCompletion.

Definition at line 124 of file kshellcompletion.cpp.

void KShellCompletion::postProcessMatches ( KCompletionMatches *  matches) const
protectedvirtual

Reimplemented from KUrlCompletion.

Definition at line 142 of file kshellcompletion.cpp.


The documentation for this class was generated from the following files:
  • kshellcompletion.h
  • kshellcompletion.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Jul 23 2013 20:37:48 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KIO

Skip menu "KIO"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs-4.10.5 API Reference

Skip menu "kdelibs-4.10.5 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal