KoParagCounter.h

/* This file is part of the KDE project
   Copyright (C) 2001 Shaheed Haque <srhaque@iee.org>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.
 
   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.
 
   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
*/
 
#include <tqstring.h>
#include <koffice_export.h>
class TQDomElement;
class KoXmlWriter;
class KoGenStyle;
class KoTextParag;
class KoTextFormat;
class KoOasisContext;
 
#ifndef koparagcounter_h
#define koparagcounter_h

class KOTEXT_EXPORT KoParagCounter
{
public:
    KoParagCounter();

    void invalidate();

    int number( const KoTextParag *paragraph );
    TQString levelText( const KoTextParag *paragraph );
    TQString text( const KoTextParag *paragraph );

    int width( const KoTextParag *paragraph );

    int bulletX();

    void load( TQDomElement & element );
    void save( TQDomElement & element );
    void loadOasis( KoOasisContext& context, int restartNumbering, bool orderedList, bool heading, int level, bool loadingStyle = false );
    void loadOasisListStyle( const TQDomElement& listStyle,
                             const TQDomElement& listStyleProperties,
                             const TQDomElement& listStyleTextProperties,
                             int restartNumbering,
                             bool orderedList, bool heading, int level, bool loadingStyle );
    void saveOasis( KoGenStyle& listStyle, bool savingStyle = false ) const;
    void saveOasisListLevel( KoXmlWriter& listLevelWriter, bool includeLevelAndProperties, bool savingStyle = false ) const;
 
    bool operator==( const KoParagCounter & c2 ) const;
    bool operator!=( const KoParagCounter & c2 ) const { return !(*this == c2); }
 
    enum Numbering
    {
        NUM_NONE = 2,       // Unnumbered. Equivalent to there being
                            // no counter structure associated with a
                            // paragraph.
        NUM_LIST = 0,       // Numbered as a list item.
        NUM_CHAPTER = 1,    // Numbered as a heading.
        NUM_FOOTNOTE = 3   // Fixed text counter, set by the code. This is used by e.g. footnotes.
    };
    enum Style // always add to the end, the numeric values are part of the DTD
    {
        STYLE_NONE = 0,
        STYLE_NUM = 1, STYLE_ALPHAB_L = 2, STYLE_ALPHAB_U = 3,
        STYLE_ROM_NUM_L = 4, STYLE_ROM_NUM_U = 5, STYLE_CUSTOMBULLET = 6,
        STYLE_CUSTOM = 7, STYLE_CIRCLEBULLET = 8, STYLE_SQUAREBULLET = 9,
        STYLE_DISCBULLET = 10, STYLE_BOXBULLET = 11
    };

    Numbering numbering() const;
    void setNumbering( Numbering n );
 
    Style style() const;
    void setStyle( Style s );

    bool restartCounter() const;
    void setRestartCounter( bool restart );

    bool isBullet() const;
    static bool isBullet( Style style );

    unsigned int depth() const;
    void setDepth( unsigned int d );

    int displayLevels() const;
    void setDisplayLevels( int l );

    int startNumber() const;
    void setStartNumber( int s );

    TQString prefix() const;
    void setPrefix( TQString p );
    TQString suffix() const;
    void setSuffix( TQString s );

    TQChar customBulletCharacter() const;
    void setCustomBulletCharacter( TQChar c );
    TQString customBulletFont() const;
    void setCustomBulletFont( TQString f );

    TQString custom() const;
    void setCustom( TQString c );

    int alignment() const;
    void setAlignment( int a );

    static KoTextFormat* counterFormat( const KoTextParag *paragraph );
 
    static TQString makeRomanNumber( int n );
    static TQString makeAlphaUpperNumber( int n );
    static TQString makeAlphaLowerNumber( int n );
 
    static int fromRomanNumber( const TQString & );
    static int fromAlphaUpperNumber( const TQString & );
    static int fromAlphaLowerNumber( const TQString & );
 
#ifndef NDEBUG
    void printRTDebug( KoTextParag* parag );
#endif
 
private:

    KoTextParag *parent( const KoTextParag *paragraph );
 
    Numbering m_numbering:3; // Numbering (maximum value: 8)
    bool m_restartCounter:1;
    bool unused:4;
    Style m_style:8;     // Style
    char m_displayLevels; // Number of levels to display (e.g. 3 => 1.2.1)
    char m_depth;
 
    short int m_startNumber;
    TQChar m_customBulletChar;
 
    TQString m_customBulletFont;
    TQString m_custom;
    TQString m_prefix;
    TQString m_suffix;
    int m_align;
 
    class Private;
    Private *d; // define operator= and copy ctor when using this!

    struct
    {
        int number;
        TQString text;
        int width;
        KoTextParag *parent;
        KoTextFormat * counterFormat;
    } m_cache;
};
 
#endif