summaryrefslogtreecommitdiff
path: root/noncore/apps/checkbook/qrestrictedline.h
blob: 7e41cd929b166d14d23aafb431310f6f3b1ec78b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
/*
 *
 * Definition of QRestrictedLine
 *
 * Copyright (C) 1997 Michael Wiedmann, <mw@miwie.in-berlin.de>
 *
 * Edited 2001 by Nick Betcher <nbetcher@usinternet.com> to work
 * with Qt-only. Changed class name from QRestrictedLine to
 * QRestrictedLine.
 *
 * 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#ifndef QRESTRICTEDLINE_H
#define QRESTRICTEDLINE_H

#include <qlineedit.h>

/**
 * The QRestrictedLine widget is a variant of @ref QLineEdit which
 * accepts only a restricted set of characters as input.
 * All other characters will be discarded and the signal @ref #invalidChar()
 * will be emitted for each of them.
 *
 * Valid characters can be passed as a QString to the constructor
 * or set afterwards via @ref #setValidChars().
 * The default key bindings of @ref QLineEdit are still in effect.
 *
 * @short A line editor for restricted character sets.
 * @author Michael Wiedmann <mw@miwie.in-berlin.de>
 * @version 0.0.1
 */
class QRestrictedLine : public QLineEdit
{
  Q_OBJECT
  Q_PROPERTY( QString validChars READ validChars WRITE setValidChars )

public:

  /**
   * Constructor: This contructor takes three - optional - arguments.
   *  The first two parameters are simply passed on to @ref QLineEdit.
   *  @param parent   pointer to the parent widget
   *  @param name     pointer to the name of this widget
   *  @param valid    pointer to set of valid characters
   */
  QRestrictedLine( QWidget *parent=0, const char *name=0,
		   const QString& valid = QString::null);

  /**
   * Destructs the restricted line editor.
   */
  ~QRestrictedLine();

  /**
   * All characters in the string valid are treated as
   * acceptable characters.
   */
  void setValidChars(const QString& valid);
  /**
   * @return the string of acceptable characters.
   */
  QString validChars() const;

signals:

  /**
   * Emitted when an invalid character was typed.
   */
  void	invalidChar(int);

protected:
  /**
   * @reimplemented
   */
  void	keyPressEvent( QKeyEvent *e );

private:
  /// QString of valid characters for this line
  QString	qsValidChars;
};

#endif // QRESTRICTEDLINE_H