kword
KWPage Class Reference
#include <KWPage.h>
Detailed Description
This class represents a printed page of the document.
Definition at line 30 of file KWPage.h.
Public Types | |
Left | |
Right | |
enum | PageSideEnum { Left, Right } |
Public Member Functions | |
void | setWidth (const double &x) |
void | setHeight (const double &y) |
void | setTopMargin (const double &x) |
void | setBottomMargin (const double &y) |
void | setPageEdgeMargin (const double &x) |
void | setMarginClosestBinding (const double &y) |
void | setLeftMargin (const double &l) |
void | setRightMargin (const double &r) |
double | width () const |
double | height () const |
double | topMargin () const |
double | bottomMargin () const |
double | leftMargin () const |
double | rightMargin () const |
double | pageEdgeMargin () const |
double | marginClosestBinding () const |
double | offsetInDocument () const |
PageSideEnum | pageSide () const |
void | setPageSide (PageSideEnum ps) |
int | pageNumber () const |
QRect | zoomedRect (KoZoomHandler *zoomHandler) |
const KoRect | rect () const |
Friends | |
class | KWPageManager |
Member Enumeration Documentation
enum KWPage::PageSideEnum |
Member Function Documentation
double KWPage::bottomMargin | ( | ) | const |
double KWPage::height | ( | ) | const |
double KWPage::leftMargin | ( | ) | const |
double KWPage::marginClosestBinding | ( | ) | const |
return width of the margin that is the closest to the binding, i.e. right for even pages
Definition at line 122 of file KWPage.cpp.
double KWPage::offsetInDocument | ( | ) | const |
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.
Definition at line 128 of file KWPage.cpp.
double KWPage::pageEdgeMargin | ( | ) | const |
return width of the margin that is the closest to the page edge, i.e. left for even pages
Definition at line 117 of file KWPage.cpp.
int KWPage::pageNumber | ( | ) | const [inline] |
PageSideEnum KWPage::pageSide | ( | ) | const [inline] |
const KoRect KWPage::rect | ( | ) | const |
return a KoRect with the (pt) sizes of this page. Margins are ignored for this function.
Definition at line 137 of file KWPage.cpp.
double KWPage::rightMargin | ( | ) | const |
void KWPage::setBottomMargin | ( | const double & | y | ) |
void KWPage::setHeight | ( | const double & | y | ) |
void KWPage::setLeftMargin | ( | const double & | l | ) |
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.
Definition at line 72 of file KWPage.cpp.
void KWPage::setMarginClosestBinding | ( | const double & | y | ) |
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.
Definition at line 67 of file KWPage.cpp.
void KWPage::setPageEdgeMargin | ( | const double & | x | ) |
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.
Definition at line 62 of file KWPage.cpp.
void KWPage::setPageSide | ( | PageSideEnum | ps | ) | [inline] |
void KWPage::setRightMargin | ( | const double & | r | ) |
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.
Definition at line 79 of file KWPage.cpp.
void KWPage::setTopMargin | ( | const double & | x | ) |
void KWPage::setWidth | ( | const double & | x | ) |
double KWPage::topMargin | ( | ) | const |
double KWPage::width | ( | ) | const |
QRect KWPage::zoomedRect | ( | KoZoomHandler * | zoomHandler | ) |
return a QRect with the size of this page in pixels.
- Parameters:
-
zoomHandler the zoomhandler knows the current zoom levels. The KWDocument currently implements that interface.
Definition at line 132 of file KWPage.cpp.
The documentation for this class was generated from the following files: