KoPageLayout.h

/* This file is part of the KDE project
   Copyright (C) 1998, 1999 Torben Weis <weis@kde.org>
   Copyright 2002, 2003 David Faure <faure@kde.org>
   Copyright 2003 Nicolas GOUTTE <goutte@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 KOPAGELAYOUT_H
#define KOPAGELAYOUT_H
 
#include <KoGenStyles.h>
#include <tqstringlist.h>
#include <koffice_export.h>
class TQDomElement;
 
enum KoFormat {
    PG_DIN_A3 = 0,
    PG_DIN_A4 = 1,
    PG_DIN_A5 = 2,
    PG_US_LETTER = 3,
    PG_US_LEGAL = 4,
    PG_SCREEN = 5,
    PG_CUSTOM = 6,
    PG_DIN_B5 = 7,
    PG_US_EXECUTIVE = 8,
    PG_DIN_A0 = 9,
    PG_DIN_A1 = 10,
    PG_DIN_A2 = 11,
    PG_DIN_A6 = 12,
    PG_DIN_A7 = 13,
    PG_DIN_A8 = 14,
    PG_DIN_A9 = 15,
    PG_DIN_B0 = 16,
    PG_DIN_B1 = 17,
    PG_DIN_B10 = 18,
    PG_DIN_B2 = 19,
    PG_DIN_B3 = 20,
    PG_DIN_B4 = 21,
    PG_DIN_B6 = 22,
    PG_ISO_C5 = 23,
    PG_US_COMM10 = 24,
    PG_ISO_DL = 25,
    PG_US_FOLIO = 26,
    PG_US_LEDGER = 27,
    PG_US_TABLOID = 28,
    // update the number below and the static arrays if you add more values to the enum
    PG_LAST_FORMAT = PG_US_TABLOID // used by koPageLayout.cpp
};
 
enum KoOrientation {
    PG_PORTRAIT = 0,
    PG_LANDSCAPE = 1
};
 
namespace KoPageFormat
{
    KOFFICECORE_EXPORT int /*KPrinter::PageSize*/ printerPageSize( KoFormat format );
 
    KOFFICECORE_EXPORT double width( KoFormat format, KoOrientation orientation );
 
    KOFFICECORE_EXPORT double height( KoFormat format, KoOrientation orientation );
 
    KOFFICECORE_EXPORT TQString formatString( KoFormat format );
 
    KOFFICECORE_EXPORT KoFormat formatFromString( const TQString & string );
 
    KOFFICECORE_EXPORT KoFormat defaultFormat();
 
    KOFFICECORE_EXPORT TQString name( KoFormat format );
 
    KOFFICECORE_EXPORT TQStringList allFormats();
 
    KOFFICECORE_EXPORT KoFormat guessFormat( double width, double height );
}
 
 
enum KoHFType {
    HF_SAME = 0,            
    HF_FIRST_EO_DIFF = 1,   
    HF_FIRST_DIFF = 2,      
    HF_EO_DIFF = 3          
};
 
struct KoPageLayout
{
    KoFormat format;
    KoOrientation orientation;
 
    double ptWidth;
    double ptHeight;
    double ptLeft;
    double ptRight;
    double ptTop;
    double ptBottom;
    double ptPageEdge;
    double ptBindingSide;
 
    bool operator==( const KoPageLayout& l ) const {
       return ( ptWidth == l.ptWidth &&
                ptHeight == l.ptHeight &&
                ptLeft == l.ptLeft &&
                ptRight == l.ptRight &&
                ptTop == l.ptTop &&
                ptBottom == l.ptBottom &&
                ptPageEdge == l.ptPageEdge &&
                ptBindingSide == l.ptBindingSide);
    }
    bool operator!=( const KoPageLayout& l ) const {
        return !( (*this) == l );
    }
 
    KOFFICECORE_EXPORT KoGenStyle saveOasis() const;
 
    KOFFICECORE_EXPORT void loadOasis(const TQDomElement &style);
 
    static KOFFICECORE_EXPORT KoPageLayout standardLayout();
};
 
struct KoHeadFoot
{
    TQString headLeft;
    TQString headMid;
    TQString headRight;
    TQString footLeft;
    TQString footMid;
    TQString footRight;
};
 
struct KoColumns
{
    int columns;
    double ptColumnSpacing;
    bool operator==( const KoColumns& rhs ) const {
        return columns == rhs.columns &&
               TQABS(ptColumnSpacing - rhs.ptColumnSpacing) <= 1E-10;
    }
    bool operator!=( const KoColumns& rhs ) const {
        return columns != rhs.columns ||
               TQABS(ptColumnSpacing - rhs.ptColumnSpacing) > 1E-10;
    }
};
 
struct KoKWHeaderFooter
{
    KoHFType header;
    KoHFType footer;
    double ptHeaderBodySpacing;
    double ptFooterBodySpacing;
    double ptFootNoteBodySpacing;
    bool operator==( const KoKWHeaderFooter& rhs ) const {
        return header == rhs.header && footer == rhs.footer &&
               TQABS(ptHeaderBodySpacing - rhs.ptHeaderBodySpacing) <= 1E-10 &&
               TQABS(ptFooterBodySpacing - rhs.ptFooterBodySpacing) <= 1E-10 &&
               TQABS(ptFootNoteBodySpacing - rhs.ptFootNoteBodySpacing) <= 1E-10;
    }
    bool operator!=( const KoKWHeaderFooter& rhs ) const {
        return !( *this == rhs );
    }
};
 
#endif /* KOPAGELAYOUT_H */