Class to define the position of an object (textbox, picture, ..) in the document. More...
#include <WPSPosition.h>
Public Types | |
enum | AnchorTo { Char, CharBaseLine, Paragraph, Page } |
a list of enum used to defined the anchor More... | |
enum | Wrapping { WNone, WDynamic, WRunThrough } |
an enum used to define the wrapping More... | |
enum | XPos { XRight, XLeft, XCenter, XFull } |
an enum used to define the relative X position More... | |
enum | YPos { YTop, YBottom, YCenter, YFull } |
an enum used to define the relative Y position More... |
Public Member Functions | |
WPSPosition (Vec2f const &orig=Vec2f(), Vec2f const &sz=Vec2f(), WPXUnit unt=WPX_INCH) | |
constructor | |
virtual | ~WPSPosition () |
bool | operator== (WPSPosition const &f) const |
basic operator== | |
bool | operator!= (WPSPosition const &f) const |
basic operator!= | |
bool | operator< (WPSPosition const &f) const |
basic operator< | |
int | page () const |
returns the frame page | |
Vec2f const & | origin () const |
return the frame origin | |
Vec2f const & | size () const |
returns the frame size | |
Vec2f const & | naturalSize () const |
returns the natural size (if known) | |
WPXUnit | unit () const |
returns the unit | |
float | getInvUnitScale (WPXUnit unt) const |
returns a float which can be used to scale some data in object unit | |
void | setPage (int pg) const |
sets the page | |
void | setOrigin (Vec2f const &orig) |
sets the frame origin | |
void | setSize (Vec2f const &sz) |
sets the frame size | |
void | setNaturalSize (Vec2f const &natSize) |
sets the natural size (if known) | |
void | setUnit (WPXUnit unt) |
sets the dimension unit | |
void | setPagePos (int pg, Vec2f const &newOrig) const |
sets/resets the page and the origin | |
void | setRelativePosition (AnchorTo anchor, XPos X=XLeft, YPos Y=YTop) |
sets the relative position | |
int | order () const |
returns background/foward order | |
void | setOrder (int ord) const |
set background/foward order |
Static Public Member Functions | |
static float | getScaleFactor (WPXUnit orig, WPXUnit dest) |
returns a float which can be used to convert between to unit |
Public Attributes | |
AnchorTo | m_anchorTo |
anchor position | |
XPos | m_xPos |
X relative position. | |
YPos | m_yPos |
Y relative position. | |
Wrapping | m_wrapping |
Wrapping. |
Protected Member Functions | |
int | cmp (WPSPosition const &f) const |
basic function to compare two positions |
Protected Attributes | |
int | m_page |
the page | |
Vec2f | m_orig |
the origin position in a page | |
Vec2f | m_size |
Vec2f | m_naturalSize |
the natural size of the data (if known) | |
WPXUnit | m_unit |
the unit used in orig and in m_size. Default: in inches | |
int | m_order |
background/foward order |
Friends | |
std::ostream & | operator<< (std::ostream &o, WPSPosition const &pos) |
operator<< |
Class to define the position of an object (textbox, picture, ..) in the document.
Stores the page, object position, object size, anchor, wrapping, ...
enum WPSPosition::XPos |
enum WPSPosition::YPos |
|
inline |
constructor
|
inlinevirtual |
|
inlineprotected |
basic function to compare two positions
Referenced by operator!=(), operator<(), and operator==().
|
inline |
returns a float which can be used to scale some data in object unit
Referenced by WPSContentListener::_handleFrameParameters(), WPSOLEParser::parse(), and WPS4Graph::readObject().
|
inlinestatic |
returns a float which can be used to convert between to unit
Referenced by getInvUnitScale(), and WPSContentListener::openSection().
|
inline |
returns the natural size (if known)
Referenced by WPSContentListener::_handleFrameParameters(), WPSOLEParser::parse(), and WPS4Graph::readObject().
|
inline |
basic operator!=
|
inline |
basic operator<
|
inline |
basic operator==
|
inline |
returns background/foward order
|
inline |
return the frame origin
Referenced by WPSContentListener::_handleFrameParameters().
|
inline |
returns the frame page
Referenced by WPSContentListener::_handleFrameParameters(), and cmp().
|
inline |
sets the natural size (if known)
Referenced by WPSOLEParser::parse(), WPSOLEParser::readContents(), WPSOLEParser::readCONTENTS(), WPSOLEParser::readOlePres(), and WPS4Graph::sendObject().
|
inline |
set background/foward order
|
inline |
sets the frame origin
|
inline |
sets the page
|
inline |
sets/resets the page and the origin
sets the relative position
Referenced by WPS4Text::readText(), WPS4Graph::sendObject(), and WPS4Graph::sendObjects().
|
inline |
sets the frame size
Referenced by WPSOLEParser::readContents().
|
inline |
sets the dimension unit
Referenced by WPSOLEParser::readContents(), WPSOLEParser::readCONTENTS(), and WPSOLEParser::readOlePres().
|
inline |
returns the frame size
Referenced by WPSContentListener::_handleFrameParameters(), and WPSOLEParser::parse().
|
inline |
returns the unit
Referenced by WPSContentListener::_handleFrameParameters(), and WPSOLEParser::parse().
|
friend |
operator<<
AnchorTo WPSPosition::m_anchorTo |
anchor position
Referenced by WPSContentListener::_handleFrameParameters(), WPSContentListener::_openFrame(), cmp(), and setRelativePosition().
|
protected |
the natural size of the data (if known)
Referenced by cmp(), naturalSize(), and setNaturalSize().
|
mutableprotected |
background/foward order
Referenced by order(), and setOrder().
|
protected |
the origin position in a page
Referenced by cmp(), origin(), setOrigin(), and setPagePos().
|
protected |
the page
Referenced by page(), setPage(), and setPagePos().
|
protected |
the unit used in orig and in m_size. Default: in inches
Referenced by cmp(), getInvUnitScale(), setUnit(), and unit().
Wrapping WPSPosition::m_wrapping |
Wrapping.
Referenced by WPSContentListener::_handleFrameParameters(), WPS4Text::readText(), WPS4Graph::sendObject(), and WPS4Graph::sendObjects().
XPos WPSPosition::m_xPos |
X relative position.
Referenced by WPSContentListener::_handleFrameParameters(), cmp(), and setRelativePosition().
YPos WPSPosition::m_yPos |
Y relative position.
Referenced by WPSContentListener::_handleFrameParameters(), cmp(), and setRelativePosition().