Warning, file /office/calligra/libs/textlayout/KoTextLayoutRootArea.h was not indexed or was modified since last indexation (in which case cross-reference links may be missing, inaccurate or erroneous).
0001 /* This file is part of the KDE project 0002 * Copyright (C) 2011 C. Boemann <cbo@kogmbh.com> 0003 * 0004 * This library is free software; you can redistribute it and/or 0005 * modify it under the terms of the GNU Library General Public 0006 * License as published by the Free Software Foundation; either 0007 * version 2 of the License, or (at your option) any later version. 0008 * 0009 * This library is distributed in the hope that it will be useful, 0010 * but WITHOUT ANY WARRANTY; without even the implied warranty of 0011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 0012 * Library General Public License for more details. 0013 * 0014 * You should have received a copy of the GNU Library General Public License 0015 * along with this library; see the file COPYING.LIB. If not, write to 0016 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 0017 * Boston, MA 02110-1301, USA. 0018 */ 0019 0020 #ifndef KOTEXTLAYOUTROOTAREA_H 0021 #define KOTEXTLAYOUTROOTAREA_H 0022 0023 #include "kotextlayout_export.h" 0024 0025 #include "KoTextLayoutArea.h" 0026 0027 class KoShape; 0028 class KoTextPage; 0029 0030 /** 0031 * When laying out text it happens in areas that can occupy space of various size. 0032 */ 0033 class KOTEXTLAYOUT_EXPORT KoTextLayoutRootArea : public KoTextLayoutArea 0034 { 0035 public: 0036 /// constructor 0037 explicit KoTextLayoutRootArea(KoTextDocumentLayout *documentLayout); 0038 ~KoTextLayoutRootArea() override; 0039 0040 /// Layouts as much as it can 0041 /// Returns true if it has reached the end of the frame 0042 bool layoutRoot(FrameIterator *cursor); 0043 0044 /// Sets an associated shape which can be retrieved with associatedShape() 0045 /// KoTextLayoutRootArea doesn't use it for anything. 0046 void setAssociatedShape(KoShape *shape); 0047 0048 /// Retruns the shape set with setAssociatedShape() 0049 KoShape *associatedShape() const; 0050 0051 /** 0052 * Set the \p page this root area is on. 0053 * 0054 * The root-area takes over the ownership of the KoTextPage and will take 0055 * care to delete the KoTextPage if not needed any longer. 0056 */ 0057 void setPage(KoTextPage *textpage); 0058 0059 /// Returns the page this root area is on. 0060 KoTextPage *page() const; 0061 0062 void setDirty(); 0063 0064 bool isDirty() const; 0065 0066 /// Returns the cursor position of the following root frame 0067 FrameIterator *nextStartOfArea() const; 0068 0069 KoText::Direction parentTextDirection() const override; 0070 0071 void setBottom(qreal b); 0072 0073 private: 0074 class Private; 0075 Private * const d; 0076 }; 0077 0078 #endif