1/* This file is part of the KDE libraries
2 Copyright (C) 2000 David Smith <dsmith@algonet.se>
3
4 This library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Library General Public
6 License as published by the Free Software Foundation; either
7 version 2 of the License, or (at your option) any later version.
8
9 This library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 Library General Public License for more details.
13
14 You should have received a copy of the GNU Library General Public License
15 along with this library; see the file COPYING.LIB. If not, write to
16 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17 Boston, MA 02110-1301, USA.
18*/
19
20#ifndef KSHELLCOMPLETION_H
21#define KSHELLCOMPLETION_H
22
23#include <QtCore/QString>
24#include <QtCore/QStringList>
25
26#include "kurlcompletion.h"
27
28class KShellCompletionPrivate;
29
30/**
31 * This class does shell-like completion of file names.
32 * A string passed to makeCompletion() will be interpreted as a shell
33 * command line. Completion will be done on the last argument on the line.
34 * Returned matches consist of the first arguments (uncompleted) plus the
35 * completed last argument.
36 *
37 * @short Shell-like completion of file names
38 * @author David Smith <dsmith@algonet.se>
39 */
40class KIO_EXPORT KShellCompletion : public KUrlCompletion
41{
42 Q_OBJECT
43
44public:
45 /**
46 * Constructs a KShellCompletion object.
47 */
48 KShellCompletion();
49 ~KShellCompletion();
50
51 /**
52 * Finds completions to the given text.
53 * The first match is returned and emitted in the signal match().
54 * @param text the text to complete
55 * @return the first match, or QString() if not found
56 */
57 QString makeCompletion(const QString &text);
58
59protected:
60 // Called by KCompletion
61 void postProcessMatch( QString *match ) const;
62 void postProcessMatches( QStringList *matches ) const;
63 void postProcessMatches( KCompletionMatches *matches ) const;
64
65private:
66 KShellCompletionPrivate * const d;
67};
68
69#endif // KSHELLCOMPLETION_H
70