KoParagLayout.h

/* This file is part of the KDE project
   Copyright (C) 2001 David Faure <faure@kde.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.
*/
 
#ifndef koparaglayout_h
#define koparaglayout_h
 
#include <KoRuler.h> // for KoTabulatorList
#include <tqdom.h>
#include "KoBorder.h"
#include <koffice_export.h>
class KoSavingContext;
class KoGenStyle;
class KoParagCounter;
class KoParagStyle;
class KoOasisContext;
class TQColor;

class KOTEXT_EXPORT KoParagLayout
{
public:
    KoParagLayout();
    KoParagLayout( const KoParagLayout &layout ) { operator=( layout ); }
 
    ~KoParagLayout();

    enum { Alignment = 1,
           BulletNumber = 2, // TODO: we can use Counter now :)
           Margins = 4,
           LineSpacing = 8,
           Borders = 16,
           Tabulator = 32,
           PageBreaking = 64,
           BackgroundColor = 128,
           /* Style is maybe missing */
           All = Alignment | BulletNumber | Margins | LineSpacing |
                 Borders | Tabulator | PageBreaking | BackgroundColor
    } Flags;

    enum {
        BreakBetweenLines = 0, // default
        KeepLinesTogether = 1,
        HardFrameBreakBefore = 2,      // incompatible with KeepWithPrevious
        HardFrameBreakAfter = 4,       // incompatible with KeepWithNext
        KeepWithPrevious = 8,          // incompatible with HardFrameBreakBefore
        KeepWithNext = 16              // incompatible with HardFrameBreakAfter
    };
 
    // This class is used as a struct, which explains the public vars :)
    double margins[5];
    enum SpacingType { LS_SINGLE = 0, LS_ONEANDHALF = -1, LS_DOUBLE = -2,
                       LS_CUSTOM = -3, LS_AT_LEAST = -4, LS_MULTIPLE = -5, LS_FIXED = -6 };
    SpacingType lineSpacingType;
    double lineSpacingValue() const { return lineSpacing;}
    void setLineSpacingValue(double _value) { lineSpacing = _value;}
 
    static TQString* shadowCssCompat; // used for compat with koffice-1.2 when loading
 
    bool joinBorder:1;
    bool unused:7;          // for future use
    char pageBreaking;    // Page breaking flags
    char direction;       // TQChar::Direction
    char alignment; // TQt::AlignmentFlags
    KoBorder leftBorder, rightBorder, topBorder, bottomBorder;


    TQColor backgroundColor;

    KoParagCounter* counter;
 
    KoParagStyle* style;
 
    bool hasBorder() const { return topBorder.penWidth() > 0
                                 || bottomBorder.penWidth() > 0
                                 || leftBorder.penWidth() > 0
                                 || rightBorder.penWidth() > 0; }
 
    void setTabList( const KoTabulatorList & tabList ) { m_tabList = tabList; }
    const KoTabulatorList& tabList() const { return m_tabList; }


    void operator=( const KoParagLayout & );

    int compare( const KoParagLayout & layout ) const;

    void saveParagLayout( TQDomElement & parentElem, int alignment ) const;

    static void loadParagLayout( KoParagLayout& layout, const TQDomElement& parentElem, int docVersion = 2 );

    static void loadOasisParagLayout( KoParagLayout& layout, KoOasisContext& context );
    void saveOasis( KoGenStyle& gs, KoSavingContext& context, bool savingStyle ) const;

    static TQt::AlignmentFlags loadOasisAlignment( const TQCString& str );
    static TQCString saveOasisAlignment( TQt::AlignmentFlags alignment );
 
private:
    static int getAttribute(const TQDomElement &element, const char *attributeName, int defaultValue) {
        TQString value = element.attribute( attributeName );
        return value.isNull() ? defaultValue : value.toInt();
    }
 
    static double getAttribute(const TQDomElement &element, const char *attributeName, double defaultValue) {
        TQString value = element.attribute( attributeName );
        return value.isNull() ? defaultValue : value.toDouble();
    }
 
private:
    KoTabulatorList m_tabList;
    double lineSpacing;
    class Private;
    Private *d;

    void initialise();
};
 
#endif