summaryrefslogtreecommitdiffstats
path: root/tdeui/krestrictedline.h
diff options
context:
space:
mode:
Diffstat (limited to 'tdeui/krestrictedline.h')
-rw-r--r--tdeui/krestrictedline.h95
1 files changed, 95 insertions, 0 deletions
diff --git a/tdeui/krestrictedline.h b/tdeui/krestrictedline.h
new file mode 100644
index 000000000..7d13f40ca
--- /dev/null
+++ b/tdeui/krestrictedline.h
@@ -0,0 +1,95 @@
+/*
+ *
+ * $Id$
+ *
+ * Definition of KRestrictedLine
+ *
+ * Copyright (C) 1997 Michael Wiedmann, <mw@miwie.in-berlin.de>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the Free
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ *
+ */
+
+#ifndef KRESTRICTEDLINE_H
+#define KRESTRICTEDLINE_H
+
+#include <klineedit.h>
+
+/**
+ * @short A line editor for restricted character sets.
+ *
+ * The KRestrictedLine widget is a variant of TQLineEdit which
+ * accepts only a restricted set of characters as input.
+ * All other characters will be discarded and the signal invalidChar()
+ * will be emitted for each of them.
+ *
+ * Valid characters can be passed as a TQString to the constructor
+ * or set afterwards via setValidChars().
+ * The default key bindings of TQLineEdit are still in effect.
+ *
+ * @author Michael Wiedmann <mw@miwie.in-berlin.de>
+ */
+class KDEUI_EXPORT KRestrictedLine : public KLineEdit
+{
+ Q_OBJECT
+ Q_PROPERTY( TQString validChars READ validChars WRITE setValidChars )
+
+public:
+
+ /**
+ * Constructor: This contructor takes three - optional - arguments.
+ * The first two parameters are simply passed on to TQLineEdit.
+ * @param parent pointer to the parent widget
+ * @param name pointer to the name of this widget
+ * @param valid pointer to set of valid characters
+ */
+ KRestrictedLine( TQWidget *parent=0, const char *name=0,
+ const TQString& valid = TQString::null);
+
+ /**
+ * Destructs the restricted line editor.
+ */
+ ~KRestrictedLine();
+
+ /**
+ * All characters in the string valid are treated as
+ * acceptable characters.
+ */
+ void setValidChars(const TQString& valid);
+ /**
+ * @return the string of acceptable characters.
+ */
+ TQString validChars() const;
+
+signals:
+
+ /**
+ * Emitted when an invalid character was typed.
+ */
+ void invalidChar(int);
+
+protected:
+ void keyPressEvent( TQKeyEvent *e );
+
+private:
+ /// TQString of valid characters for this line
+ QString qsValidChars;
+protected:
+ virtual void virtual_hook( int id, void* data );
+private:
+ class KRestrictedLinePrivate* d;
+};
+
+#endif // KRESTRICTEDLINE_H