1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
|
/* This file is part of the KDE project
* Copyright (C) 2011 Casper Boemann <cbo@kogmbh.com>
*
* 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 KOTEXTLAYOUTROOTAREAPROVIDER_H
#define KOTEXTLAYOUTROOTAREAPROVIDER_H
#include "textlayout_export.h"
#include <QSizeF>
#include <QRectF>
#include <QList>
class KoTextLayoutRootArea;
class KoTextDocumentLayout;
class KoTextLayoutObstruction;
/**
* When laying out text we need an area where upon the text will be placed.
* A KoTextLayoutRootAreaProvider provides the layout process with such areas
*/
class TEXTLAYOUT_EXPORT KoTextLayoutRootAreaProvider
{
public:
/// constructor
explicit KoTextLayoutRootAreaProvider();
virtual ~KoTextLayoutRootAreaProvider();
/// Provides an new root area
virtual KoTextLayoutRootArea *provide(KoTextDocumentLayout *documentLayout) = 0;
/// Release all root areas that are after the "afterThis" root area
/// If afterThis == 0 all should be released
virtual void releaseAllAfter(KoTextLayoutRootArea *afterThis) = 0;
/// This method allows the provider to do any post processing like
/// - painting it
/// - changing it's size
/// - do other things to other structures (eg resizing the textshape)
virtual void doPostLayout(KoTextLayoutRootArea *rootArea, bool isNewRootArea) = 0;
/// Returns a suggested a size for the root area
virtual QSizeF suggestSize(KoTextLayoutRootArea *rootArea) = 0;
/// Return a list of obstructions intersecting root area
virtual QList<KoTextLayoutObstruction *> relevantObstructions(KoTextLayoutRootArea *rootArea) = 0;
};
#endif
|