src/libs/cplusplus/Overview.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (info@qt.nokia.com)
   8 **
   9 **
  10 ** GNU Lesser General Public License Usage
  11 **
  12 ** This file may be used under the terms of the GNU Lesser General Public
  13 ** License version 2.1 as published by the Free Software Foundation and
  14 ** appearing in the file LICENSE.LGPL included in the packaging of this file.
  15 ** Please review the following information to ensure the GNU Lesser General
  16 ** Public License version 2.1 requirements will be met:
  17 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  18 **
  19 ** In addition, as a special exception, Nokia gives you certain additional
  20 ** rights. These rights are described in the Nokia Qt LGPL Exception
  21 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  22 **
  23 ** Other Usage
  24 **
  25 ** Alternatively, this file may be used in accordance with the terms and
  26 ** conditions contained in a signed written agreement between you and Nokia.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **************************************************************************/
  32
  33 #ifndef CPLUSPLUS_OVERVIEW_H
  34 #define CPLUSPLUS_OVERVIEW_H
  35
  36 #include <CPlusPlusForwardDeclarations.h>
  37
  38 #include <QtCore/QList>
  39 #include <QtCore/QString>
  40
  41 namespace CPlusPlus {
  42
  43 class CPLUSPLUS_EXPORT Overview
  44 {
  45     Overview(const Overview &other);
  46     void operator =(const Overview &other);
  47
  48 public:
  49     Overview();
  50     ~Overview();
  51
  52     bool showArgumentNames() const;
  53     void setShowArgumentNames(bool showArgumentNames);
  54
  55     bool showReturnTypes() const;
  56     void setShowReturnTypes(bool showReturnTypes);
  57
  58     bool showFunctionSignatures() const;
  59     void setShowFunctionSignatures(bool showFunctionSignatures);
  60
  61     bool showDefaultArguments() const;
  62     void setShowDefaultArguments(bool showDefaultArguments);
  63
  64     bool showTemplateParameters() const;
  65     void setShowTemplateParameters(bool showTemplateParameters);
  66
  67     // argument index that you want to mark
  68     unsigned markedArgument() const;
  69     void setMarkedArgument(unsigned position);
  70
  71     int markedArgumentBegin() const;
  72     void setMarkedArgumentBegin(int begin);
  73
  74     int markedArgumentEnd() const;
  75     void setMarkedArgumentEnd(int end);
  76
  77     QString operator()(const Name *name) const
  78     { return prettyName(name); }
  79
  80     QString operator()(const QList<const Name *> &fullyQualifiedName) const
  81     { return prettyName(fullyQualifiedName); }
  82
  83     QString operator()(const FullySpecifiedType &type, const Name *name = 0) const
  84     { return prettyType(type, name); }
  85
  86     QString prettyName(const Name *name) const;
  87     QString prettyName(const QList<const Name *> &fullyQualifiedName) const;
  88     QString prettyType(const FullySpecifiedType &type, const Name *name = 0) const;
  89     QString prettyType(const FullySpecifiedType &type, const QString &name) const;
  90
  91 private:
  92     unsigned _markedArgument;
  93     int _markedArgumentBegin;
  94     int _markedArgumentEnd;
  95     bool _showArgumentNames: 1;
  96     bool _showReturnTypes: 1;
  97     bool _showFunctionSignatures: 1;
  98     bool _showDefaultArguments: 1;
  99     bool _showTemplateParameters: 1;
 100 };
 101
 102 } // namespace CPlusPlus
 103
 104 #endif // CPLUSPLUS_OVERVIEW_H