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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/* 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_page_h
#define kw_page_h
#include <KoRect.h>
#include "KWPageManager.h"
#include "KoPageLayout.h"
class KoZoomHandler;
/**
* This class represents a printed page of the document.
*/
class KWPage {
public:
/// An enum to define if this is a page that is printed to be a left or a right page
enum PageSideEnum {Left, Right}; //future:, PageSpread };
/// set the width of the page in pt
void setWidth(const double &x);
/// set the height of the page in pt
void setHeight(const double &y);
/// set height of the top margin in pt
void setTopMargin(const double &x);
/// set height of the bottom margin in pt
void setBottomMargin(const double &y);
/**
* set width of the margin that is the closest to the page edge, i.e. left for even pages.
* Any page should either use valid left and right margins, or valid pageedge/binding ones,
* setting this one will remove the left/right ones.
*/
void setPageEdgeMargin(const double &x);
/**
* set width of the margin that is the closest to the binding, i.e. right for even pages.
* Any page should either use valid left and right margins, or valid pageedge/binding ones,
* setting this one will remove the left/right ones.
*/
void setMarginClosestBinding(const double &y);
/**
* set width of the left margin.
* Any page should either use valid left and right margins, or valid pageedge/binding ones,
* setting this one will remove the pageedge/closest-binding ones.
*/
void setLeftMargin(const double &l);
/**
* set width of the right margin.
* Any page should either use valid left and right margins, or valid pageedge/binding ones,
* setting this one will remove the pageedge/closest-binding ones.
*/
void setRightMargin(const double &r);
/// return the width of this page (in pt)
double width() const;
/// return the height of this page (in pt)
double height() const;
/// return the height of the margin at top (in pt);
double topMargin() const;
/// return the height of the margin at bottom (in pt);
double bottomMargin() const;
/// return the width of the margin at left (in pt);
double leftMargin() const;
/// return the width of the margin at left (in pt);
double rightMargin() const;
/// return width of the margin that is the closest to the page edge, i.e. left for even pages
double pageEdgeMargin() const;
/// return width of the margin that is the closest to the binding, i.e. right for even pages
double marginClosestBinding() const;
// the y coordinate
/**
* All Pages are in a document-wide coordinate system that simply puts every page under
* the next page and keeps the Y coordinate counting throughout the doc. The X coordinate
* off each page in the document is zero, i.e. aligned to the left.
* This method returns the offset of this page in the whole document which means it will
* add the height of all the pages that come before this one.
*/
double offsetInDocument() const;
/// Return the pageSide of this page, see the PageSideEnum
PageSideEnum pageSide() const { return m_pageSide; }
/// set the pageSide of this page, see the PageSideEnum
void setPageSide(PageSideEnum ps) { m_pageSide = ps; }
/// returns the number of this page as it will be shown to the user.
int pageNumber() const { return m_pageNum; }
/**
* return a TQRect with the size of this page in pixels.
* @param zoomHandler the zoomhandler knows the current zoom levels. The KWDocument currently
* implements that interface.
*/
TQRect zoomedRect(KoZoomHandler *zoomHandler);
/// return a KoRect with the (pt) sizes of this page. Margins are ignored for this function.
const KoRect rect() const;
private:
/** private constructor, only for our friends
* @param parent the KWPageManager that we belong to.
* @param pageNum the number of the page as the user will see it.
*/
KWPage(KWPageManager *parent, int pageNum);
int m_pageNum;
PageSideEnum m_pageSide;
KoPageLayout m_pageLayout;
KWPageManager *m_parent;
friend class KWPageManager;
};
#endif
|
