libs/pageapp/KoPAMasterPage.h

0001 /* This file is part of the KDE project
0002    Copyright (C) 2006-2009 Thorsten Zachmann <zachmann@kde.org>
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 KOPAMASTERPAGE_H
0021 #define KOPAMASTERPAGE_H
0022
0023
0024 #include "KoPAPageBase.h"
0025
0026 #include <KoPageLayout.h>
0027
0028 /// Stores the masterpage's shapes and settings
0029 class KOPAGEAPP_EXPORT KoPAMasterPage : public KoPAPageBase
0030 {
0031 public:
0032     explicit KoPAMasterPage();
0033     ~KoPAMasterPage() override;
0034
0035     /// reimplemented
0036     void saveOdf( KoShapeSavingContext & context ) const override;
0037
0038     /// @return the page layout set for this masterpage
0039     KoPageLayout & pageLayout() override { return m_pageLayout; }
0040     const KoPageLayout & pageLayout() const override { return m_pageLayout; }
0041
0042     /// Set the page layout to @p layout
0043     void setPageLayout(const KoPageLayout& layout) { m_pageLayout = layout; }
0044
0045     /// reimplemented
0046     bool displayMasterShapes() override;
0047
0048     /// reimplemented
0049     void setDisplayMasterShapes( bool display ) override;
0050
0051     /// reimplemented
0052     bool displayMasterBackground() override;
0053
0054     /// reimplemented
0055     void setDisplayMasterBackground( bool display ) override;
0056
0057     /// reimplemented
0058     bool displayShape(KoShape *shape) const override;
0059
0060     /// reimplemented
0061     void pageUpdated() override;
0062
0063     /// reimplemented
0064     void paintPage( QPainter & painter, KoZoomHandler & zoomHandler ) override;
0065
0066 protected:
0067     /// Reimplemented from KoPageBase
0068     void loadOdfPageTag( const KoXmlElement &element, KoPALoadingContext &loadingContext ) override;
0069
0070     KoPageLayout m_pageLayout;
0071 };
0072
0073 #endif /* KOPAMASTERPAGE_H */