Overview.h 3.21 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2
3
4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
9
** Commercial Usage
10
**
11
12
13
14
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
15
**
16
** GNU Lesser General Public License Usage
17
**
18
19
20
21
22
23
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24
**
25
** If you are unsure which license is appropriate for your use, please
hjk's avatar
hjk committed
26
** contact the sales department at http://qt.nokia.com/contact.
con's avatar
con committed
27
**
28
**************************************************************************/
hjk's avatar
hjk committed
29

Roberto Raggi's avatar
Roberto Raggi committed
30
31
#ifndef CPLUSPLUS_OVERVIEW_H
#define CPLUSPLUS_OVERVIEW_H
con's avatar
con committed
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

#include <CPlusPlusForwardDeclarations.h>
#include <QString>

namespace CPlusPlus {

class CPLUSPLUS_EXPORT Overview
{
    Overview(const Overview &other);
    void operator =(const Overview &other);

public:
    Overview();
    ~Overview();

    bool showArgumentNames() const;
    void setShowArgumentNames(bool showArgumentNames);

    bool showReturnTypes() const;
    void setShowReturnTypes(bool showReturnTypes);

    bool showFunctionSignatures() const;
    void setShowFunctionSignatures(bool showFunctionSignatures);

56
57
58
    bool showDefaultArguments() const;
    void setShowDefaultArguments(bool showDefaultArguments);

59
60
61
62
63
64
65
66
67
    // argument index that you want to mark
    unsigned markedArgument() const;
    void setMarkedArgument(unsigned position);

    int markedArgumentBegin() const;
    void setMarkedArgumentBegin(int begin);

    int markedArgumentEnd() const;
    void setMarkedArgumentEnd(int end);
con's avatar
con committed
68

Roberto Raggi's avatar
Roberto Raggi committed
69
    QString operator()(const Name *name) const
con's avatar
con committed
70
71
    { return prettyName(name); }

72
73
74
    QString operator()(const QList<const Name *> &fullyQualifiedName) const
    { return prettyName(fullyQualifiedName); }

Roberto Raggi's avatar
Roberto Raggi committed
75
    QString operator()(const FullySpecifiedType &type, const Name *name = 0) const
con's avatar
con committed
76
77
    { return prettyType(type, name); }

Roberto Raggi's avatar
Roberto Raggi committed
78
    QString prettyName(const Name *name) const;
79
    QString prettyName(const QList<const Name *> &fullyQualifiedName) const;
Roberto Raggi's avatar
Roberto Raggi committed
80
    QString prettyType(const FullySpecifiedType &type, const Name *name = 0) const;
con's avatar
con committed
81
82
    QString prettyType(const FullySpecifiedType &type, const QString &name) const;

83
84
85
86
    QString prettyTypeWithName(const FullySpecifiedType &type,
                               const Name *name,
                               Control *control);

con's avatar
con committed
87
private:
88
89
90
    unsigned _markedArgument;
    int _markedArgumentBegin;
    int _markedArgumentEnd;
con's avatar
con committed
91
92
93
    bool _showArgumentNames: 1;
    bool _showReturnTypes: 1;
    bool _showFunctionSignatures: 1;
94
    bool _showDefaultArguments: 1;
con's avatar
con committed
95
96
97
98
};

} // end of namespace CPlusPlus

Roberto Raggi's avatar
Roberto Raggi committed
99
#endif // CPLUSPLUS_OVERVIEW_H