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 
00057     QString makeCompletion(const QString &text);
00058 
00059 protected:
00060     // Called by KCompletion
00061     void postProcessMatch( QString *match ) const;
00062     void postProcessMatches( QStringList *matches ) const;
00063         void postProcessMatches( KCompletionMatches *matches ) const;
00064 
00065 private:
00066     // Find the part of text that should be completed
00067     void splitText(const QString &text, QString &text_start, QString &text_compl) const;
00068     // Insert quotes and neseccary escapes
00069     bool quoteText(QString *text, bool force, bool skip_last) const;
00070     QString unquote(const QString &text) const;
00071                                                                                 
00072     QString m_text_start; // part of the text that was not completed
00073     QString m_text_compl; // part of the text that was completed (unchanged)
00074 
00075     QChar m_word_break_char;
00076     QChar m_quote_char1;
00077     QChar m_quote_char2;
00078     QChar m_escape_char;  
00079                 
00080 protected:
00081     virtual void virtual_hook( int id, void* data );
00082 private:
00083     KShellCompletionPrivate *d;
00084 };
00085 
00086 #endif // KSHELLCOMPLETION_H
KDE Logo
This file is part of the documentation for kio Library Version 3.3.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Sep 23 17:12:23 2004 by doxygen 1.3.8-20040913 written by Dimitri van Heesch, © 1997-2003