source: trunk/tools/xmlpatterns/qapplicationargument.cpp@ 500

Last change on this file since 500 was 2, checked in by Dmitry A. Kuminov, 16 years ago

Initially imported qt-all-opensource-src-4.5.1 from Trolltech.
File size: 9.4 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4** Contact: Qt Software Information ([email protected])
5**
6** This file is part of the tools applications of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial Usage
10** Licensees holding valid Qt Commercial licenses may use this file in
11** accordance with the Qt Commercial License Agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and Nokia.
14**
15** GNU Lesser General Public License Usage
16** Alternatively, this file may be used under the terms of the GNU Lesser
17** General Public License version 2.1 as published by the Free Software
18** Foundation and appearing in the file LICENSE.LGPL included in the
19** packaging of this file. Please review the following information to
20** ensure the GNU Lesser General Public License version 2.1 requirements
21** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
22**
23** In addition, as a special exception, Nokia gives you certain
24** additional rights. These rights are described in the Nokia Qt LGPL
25** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
26** package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file. Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you are unsure which license is appropriate for your use, please
37** contact the sales department at [email protected].
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#include <QHash>
43#include <QString>
44
45#include "qapplicationargument_p.h"
46
47QT_BEGIN_NAMESPACE
48
49/*!
50 \class QApplicationArgument
51 \brief The QApplicationArgument class is a declared of a command line
52 argument for QApplicationArgumentParser.
53 \reentrant
54 \internal
55 \since 4.4
56
57 QApplicationArgument describes a valid command line argument,
58 by having a set of characteristics:
59
60 \table
61 \header
62 \o Characteristic
63 \o Functions
64 \row
65 \o A name. For instance, "backend"
66 \o setName() and name()
67 \row
68 \o A description, for human consumption.
69 \o setDescription() and description()
70 \row
71 \o How many times the argument can occur. For instance, whether the argument is optional or not.
72 \o setMinimumOccurrence() & minimumOccurrence(), setMaximumOccurrence() & maximumOccurrence()
73 \row
74 \o The type of the argument's value, if it has one. For instance, \c int or \c bool.
75 \o setType() and type()
76 \row
77 \o The value that should be used in case the argument isn't used.
78 \o setDefaultValue() and defaultValue()
79 \endtable
80
81 \sa QApplicationArgumentParser
82 */
83
84class QApplicationArgumentPrivate
85{
86public:
87 inline QApplicationArgumentPrivate(const QString &newName,
88 const QString &desc,
89 const int newType) : name(newName)
90 , description(desc)
91 , type(newType)
92 , minimum(0)
93 , maximum(1)
94 , isNameless(false)
95 {
96 }
97
98 QString name;
99 QString description;
100 int type;
101 QVariant defaultValue;
102 int minimum;
103 int maximum;
104 bool isNameless;
105};