KWPageManager.h

/* This file is part of the KOffice project
 * Copyright (C) 2005 Thomas Zander <zander@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; version 2.
 
 * 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 kw_pagemanager_h
#define kw_pagemanager_h
 
#include "KoPageLayout.h"
 
#include <tqptrlist.h>
 
class KWPage;
class KoPoint;
class KoRect;

class KWPageManager {
public:
    KWPageManager();

    int pageNumber(const KoRect *rect) const;
    int pageNumber(const KoRect &rect) const;
    int pageNumber(const KoPoint &point) const;
    int pageNumber(double ptY) const;
    int pageCount() const;
    int lastPageNumber() const;
    KWPage* page(int pageNumber) const;
    KWPage* page(const KoRect &rect) const;
    KWPage* page(const KoRect *frame) const;
    KWPage* page(const KoPoint &point) const;
    KWPage* page(double ptY) const;

    double topOfPage(int pageNumber) const; // in pt
    double bottomOfPage(int pageNumber) const; // in pt

    void setStartPage(int startPage);

    int startPage() const { return m_firstPage; }

    void setOnlyAllowAppend(bool appendOnly) { m_onlyAllowAppend = appendOnly; }
    bool onlyAllowAppend() { return m_onlyAllowAppend; }

    KWPage* insertPage(int pageNumber);
    KWPage* appendPage();

    void removePage(int pageNumber);
    void removePage(KWPage *page);

    const KoPageLayout pageLayout(int pageNumber) const;
 
    void setDefaultPage(const KoPageLayout &layout);

    KoPoint clipToDocument(const KoPoint &point);
 
private:
    double pageOffset(int pageNumber, bool bottom) const;
    class PageList : public TQPtrList<KWPage> {
    protected:
        virtual int compareItems(TQPtrCollection::Item a, TQPtrCollection::Item b);
    };
 
    PageList m_pageList;
    int m_firstPage;
    bool m_onlyAllowAppend; // true for WP style documents.
 
    KoPageLayout m_defaultPageLayout;
 
friend class KWPage;
};
 
#endif