src/libs/utils/uncommentselection.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 (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 **
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33
  34 #ifndef UNCOMMENTSELECTION_H
  35 #define UNCOMMENTSELECTION_H
  36
  37 #include "utils_global.h"
  38
  39 #include <QtCore/QString>
  40
  41 QT_BEGIN_NAMESPACE
  42 class QPlainTextEdit;
  43 QT_END_NAMESPACE
  44
  45 namespace Utils {
  46
  47 class QTCREATOR_UTILS_EXPORT CommentDefinition
  48 {
  49 public:
  50     CommentDefinition();
  51
  52     CommentDefinition &setAfterWhiteSpaces(const bool);
  53     CommentDefinition &setSingleLine(const QString &singleLine);
  54     CommentDefinition &setMultiLineStart(const QString &multiLineStart);
  55     CommentDefinition &setMultiLineEnd(const QString &multiLineEnd);
  56
  57     bool isAfterWhiteSpaces() const;
  58     const QString &singleLine() const;
  59     const QString &multiLineStart() const;
  60     const QString &multiLineEnd() const;
  61
  62     bool hasSingleLineStyle() const;
  63     bool hasMultiLineStyle() const;
  64
  65     void clearCommentStyles();
  66
  67 private:
  68     bool m_afterWhiteSpaces;
  69     QString m_singleLine;
  70     QString m_multiLineStart;
  71     QString m_multiLineEnd;
  72 };
  73
  74 QTCREATOR_UTILS_EXPORT
  75 void unCommentSelection(QPlainTextEdit *edit,
  76                         const CommentDefinition &definiton = CommentDefinition());
  77
  78 } // namespace Utils
  79
  80 #endif // UNCOMMENTSELECTION_H