kio Library API Documentation

kshellcompletion.h

00001 /* This file is part of the KDE libraries
00002     Copyright (C) 2000 David Smith  <dsmith@algonet.se>
00003 
00004     This library is free software; you can redistribute it and/or
00005     modify it under the terms of the GNU Library General Public
00006     License as published by the Free Software Foundation; either
00007     version 2 of the License, or (at your option) any later version.
00008 
00009     This library is distributed in the hope that it will be useful,
00010     but WITHOUT ANY WARRANTY; without even the implied warranty of
00011     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00012     Library General Public License for more details.
00013 
00014     You should have received a copy of the GNU Library General Public License
00015     along with this library; see the file COPYING.LIB.  If not, write to
00016     the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00017     Boston, MA 02111-1307, USA.
00018 */
00019 
00020 #ifndef KSHELLCOMPLETION_H
00021 #define KSHELLCOMPLETION_H
00022 
00023 #include <qstring.h>
00024 #include <qstringlist.h>
00025 
00026 #include "kurlcompletion.h"
00027 
00028 class KShellCompletionPrivate;
00029 
00041 class KShellCompletion : public KURLCompletion 
00042 {
00043         Q_OBJECT
00044 
00045 public:
00049         KShellCompletion();
00050 
00055         QString makeCompletion(const QString&);
00056 
00057 protected:
00058         // Called by KCompletion
00059         void postProcessMatch( QString *match ) const;
00060         void postProcessMatches( QStringList *matches ) const;
00061         void postProcessMatches( KCompletionMatches *matches ) const;
00062 
00063 private:
00064         // Find the part of text that should be completed
00065         void splitText(const QString &text, QString &text_start, QString &text_compl) const;
00066         // Insert quotes and neseccary escapes
00067         bool quoteText(QString *text, bool force, bool skip_last) const;
00068         QString unquote(const QString &text) const;
00069                                                                                         
00070         QString m_text_start; // part of the text that was not completed
00071         QString m_text_compl; // part of the text that was completed (unchanged)
00072 
00073     QChar m_word_break_char;
00074         QChar m_quote_char1;
00075         QChar m_quote_char2;
00076         QChar m_escape_char;  
00077                                 
00078 protected:
00079         virtual void virtual_hook( int id, void* data );
00080 private:
00081         KShellCompletionPrivate *d;
00082 };
00083 
00084 #endif // KSHELLCOMPLETION_H
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.5.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Jan 28 13:14:21 2004 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2001