summaryrefslogtreecommitdiff
path: root/libopie2/qt3
authormickeyl <mickeyl>2003-04-07 14:40:28 (UTC)
committer mickeyl <mickeyl>2003-04-07 14:40:28 (UTC)
commit75f029f87d4c84b37ccfe1c81ef205a6cd5fca79 (patch) (side-by-side diff)
tree293f6709a304aed084622e61633c945124836296 /libopie2/qt3
parent46cda1cdb4c71de6e2627a54f31d1b56cc85ee85 (diff)
downloadopie-75f029f87d4c84b37ccfe1c81ef205a6cd5fca79.zip
opie-75f029f87d4c84b37ccfe1c81ef205a6cd5fca79.tar.gz
opie-75f029f87d4c84b37ccfe1c81ef205a6cd5fca79.tar.bz2
started to document the whole stuff
Diffstat (limited to 'libopie2/qt3') (more/less context) (ignore whitespace changes)
-rw-r--r--libopie2/qt3/opiecore/ocompletion.h1
1 files changed, 0 insertions, 1 deletions
diff --git a/libopie2/qt3/opiecore/ocompletion.h b/libopie2/qt3/opiecore/ocompletion.h
index 0317c1b..7f28182 100644
--- a/libopie2/qt3/opiecore/ocompletion.h
+++ b/libopie2/qt3/opiecore/ocompletion.h
@@ -129,49 +129,48 @@ public:
* mode it will be "carp@cs.tu-berlin.de", as that is alphabetically
* smaller.
* If setOrder was set to Insertion, "carpdjih@sp.zrz.tu-berlin.de"
* would be completed in auto-completion-mode, as that was inserted before
* "carp@cs.tu-berlin.de".
*
* You can dynamically update the completable items by removing and adding them
* whenever you want.
* For advanced usage, you could even use multiple OCompletion objects. E.g.
* imagine an editor like kwrite with multiple open files. You could store
* items of each file in a different OCompletion object, so that you know (and
* tell the user) where a completion comes from.
*
* Note: OCompletion does not work with strings that contain 0x0 characters
* (unicode nul), as this is used internally as a delimiter.
*
* You may inherit from OCompletion and override @ref makeCompletion() in
* special cases (like reading directories/urls and then supplying the
* contents to OCompletion, as OURLCompletion does), but generally, this is
* not necessary.
*
*
* @short A generic class for completing QStrings
* @author Carsten Pfeiffer <pfeiffer@kde.org>
- * @version $Id$
*/
class OCompletion : public QObject
{
Q_ENUMS( CompOrder )
Q_PROPERTY( CompOrder order READ order WRITE setOrder )
Q_PROPERTY( bool ignoreCase READ ignoreCase WRITE setIgnoreCase )
Q_PROPERTY( QStringList items READ items WRITE setItems )
Q_OBJECT
public:
/**
* Constants that represent the order in which OCompletion performs
* completion-lookups.
*/
enum CompOrder { Sorted, Insertion, Weighted };
/**
* Constructor, nothing special here :)
*/
OCompletion();
// FIXME: copy constructor, assignment constructor...