tools/qdoc3/openedlist.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the tools applications of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** No Commercial Usage
  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 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  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 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 /*
  43   openedlist.h
  44 */
  45
  46 #ifndef OPENEDLIST_H
  47 #define OPENEDLIST_H
  48
  49 #include <qstring.h>
  50
  51 #include "location.h"
  52
  53 QT_BEGIN_NAMESPACE
  54
  55 class OpenedList
  56 {
  57 public:
  58     enum Style { Bullet, Tag, Value, Numeric, UpperAlpha, LowerAlpha,
  59                  UpperRoman, LowerRoman };
  60
  61     OpenedList()
  62         : sty( Bullet ), ini( 1 ), nex( 0 ) { }
  63     OpenedList( Style style );
  64     OpenedList( const Location& location, const QString& hint );
  65
  66     void next() { nex++; }
  67
  68     bool isStarted() const { return nex >= ini; }
  69     Style style() const { return sty; }
  70     QString styleString() const;
  71     int number() const { return nex; }
  72     QString numberString() const;
  73     QString prefix() const { return pref; }
  74     QString suffix() const { return suff; }
  75
  76 private:
  77     static QString toAlpha( int n );
  78     static int fromAlpha( const QString& str );
  79     static QString toRoman( int n );
  80     static int fromRoman( const QString& str );
  81
  82     Style sty;
  83     int ini;
  84     int nex;
  85     QString pref;
  86     QString suff;
  87 };
  88
  89 QT_END_NAMESPACE
  90
  91 #endif