WPSPosition Class Reference

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 More...
virtual | ~WPSPosition ()
bool | operator== (WPSPosition const &f) const
| basic operator== More...
bool | operator!= (WPSPosition const &f) const
| basic operator!= More...
bool | operator< (WPSPosition const &f) const
| basic operator< More...
int | page () const
| returns the frame page More...
Vec2f const & | origin () const
| return the frame origin More...
Vec2f const & | size () const
| returns the frame size More...
Vec2f const & | naturalSize () const
| returns the natural size (if known) More...
WPXUnit | unit () const
| returns the unit More...
float | getInvUnitScale (WPXUnit unt) const
| returns a float which can be used to scale some data in object unit More...
void | setPage (int pg) const
| sets the page More...
void | setOrigin (Vec2f const &orig)
| sets the frame origin More...
void | setSize (Vec2f const &sz)
| sets the frame size More...
void | setNaturalSize (Vec2f const &natSize)
| sets the natural size (if known) More...
void | setUnit (WPXUnit unt)
| sets the dimension unit More...
void | setPagePos (int pg, Vec2f const &newOrig) const
| sets/resets the page and the origin More...
void | setRelativePosition (AnchorTo anchor, XPos X=XLeft, YPos Y=YTop)
| sets the relative position More...
int | order () const
| returns background/foward order More...
void | setOrder (int ord) const
| set background/foward order More...

## Static Public Member Functions

static float | getScaleFactor (WPXUnit orig, WPXUnit dest)
| returns a float which can be used to convert between to unit More...

## Public Attributes

AnchorTo | m_anchorTo
| anchor position More...
XPos | m_xPos
| X relative position. More...
YPos | m_yPos
| Y relative position. More...
Wrapping | m_wrapping
| Wrapping. More...

## Protected Member Functions

int | cmp (WPSPosition const &f) const
| basic function to compare two positions More...

## Protected Attributes

int | m_page
| the page More...
Vec2f | m_orig
| the origin position in a page More...
Vec2f | m_size
Vec2f | m_naturalSize
| the natural size of the data (if known) More...
WPXUnit | m_unit
| the unit used in orig and in m_size. Default: in inches More...
int | m_order
| background/foward order More...

## Friends

std::ostream & | operator<< (std::ostream &o, WPSPosition const &pos)
| operator<< More...

## Detailed Description

Class to define the position of an object (textbox, picture, ..) in the document.

Stores the page, object position, object size, anchor, wrapping, ...

## Member Enumeration Documentation

enum WPSPosition::AnchorTo

a list of enum used to defined the anchor

Enumerator
Char |
CharBaseLine |
Paragraph |
Page |

enum WPSPosition::Wrapping

an enum used to define the wrapping

Enumerator
WNone |
WDynamic |
WRunThrough |

enum WPSPosition::XPos

an enum used to define the relative X position

Enumerator
XRight |
XLeft |
XCenter |
XFull |

enum WPSPosition::YPos

an enum used to define the relative Y position

Enumerator
YTop |
YBottom |
YCenter |
YFull |

## Constructor & Destructor Documentation

WPSPosition::WPSPosition | ( | Vec2f const & | orig = `Vec2f()`,
|  | Vec2f const & | sz = `Vec2f()`,
|  | WPXUnit | unt = `WPX_INCH`
| ) |  |

inline

constructor

virtual WPSPosition::~WPSPosition | ( |  | ) |

inline virtual

## Member Function Documentation

int WPSPosition::cmp | ( | WPSPosition const & | f | ) | const

inline protected

basic function to compare two positions

Referenced by operator!=(), operator<(), and operator==().

float WPSPosition::getInvUnitScale | ( | WPXUnit | unt | ) | const

inline

returns a float which can be used to scale some data in object unit

Referenced by WPSContentListener::_handleFrameParameters(), WPSOLEParser::parse(), and WPS4Graph::readObject().

static float WPSPosition::getScaleFactor | ( | WPXUnit | orig,
|  | WPXUnit | dest
| ) |  |

inline static

returns a float which can be used to convert between to unit

Referenced by getInvUnitScale(), and WPSContentListener::openSection().

Vec2f const& WPSPosition::naturalSize | ( |  | ) | const

inline

returns the natural size (if known)

Referenced by WPSContentListener::_handleFrameParameters(), WPSOLEParser::parse(), and WPS4Graph::readObject().

bool WPSPosition::operator!= | ( | WPSPosition const & | f | ) | const

inline

basic operator!=

bool WPSPosition::operator< | ( | WPSPosition const & | f | ) | const

inline

basic operator<

bool WPSPosition::operator== | ( | WPSPosition const & | f | ) | const

inline

basic operator==

int WPSPosition::order | ( |  | ) | const

inline

returns background/foward order

Vec2f const& WPSPosition::origin | ( |  | ) | const

inline

return the frame origin

Referenced by WPSContentListener::_handleFrameParameters(), and WPS8Parser::sendPageFrames().

int WPSPosition::page | ( |  | ) | const

inline

returns the frame page

Referenced by WPSContentListener::_handleFrameParameters(), cmp(), and WPS8ParserInternal::operator<<().

void WPSPosition::setNaturalSize | ( | Vec2f const & | natSize | ) |

inline

sets the natural size (if known)

Referenced by WPSOLEParser::parse(), WPSOLEParser::readContents(), WPSOLEParser::readCONTENTS(), WPSOLEParser::readOlePres(), WPS4Graph::sendObject(), and WPS8Graph::sendObjects().

void WPSPosition::setOrder | ( | int | ord | ) | const

inline

set background/foward order

void WPSPosition::setOrigin | ( | Vec2f const & | orig | ) |

inline

sets the frame origin

Referenced by WPS8Parser::sendPageFrames().

void WPSPosition::setPage | ( | int | pg | ) | const

inline

sets the page

Referenced by WPS8ParserInternal::Frame::Frame().

void WPSPosition::setPagePos | ( | int | pg,
|  | Vec2f const & | newOrig
| ) |  | const

inline

sets/resets the page and the origin

void WPSPosition::setRelativePosition | ( | AnchorTo | anchor,
|  | XPos | X = `XLeft`,
|  | YPos | Y = `YTop`
| ) |  |

inline

sets the relative position

Referenced by WPS8ParserInternal::Frame::Frame(), WPS4Text::readText(), WPS8Graph::sendBorder(), WPS4Graph::sendObject(), WPS8Parser::sendObject(), WPS8Graph::sendObjects(), and WPS4Graph::sendObjects().

void WPSPosition::setSize | ( | Vec2f const & | sz | ) |

inline

sets the frame size

Referenced by WPSOLEParser::readContents(), WPS8Graph::sendBorder(), and WPS8Graph::sendObject().

void WPSPosition::setUnit | ( | WPXUnit | unt | ) |

inline

sets the dimension unit

Referenced by WPSOLEParser::readContents(), WPSOLEParser::readCONTENTS(), and WPSOLEParser::readOlePres().

Vec2f const& WPSPosition::size | ( |  | ) | const

inline

returns the frame size

Referenced by WPSContentListener::_handleFrameParameters(), WPSOLEParser::parse(), and WPS8Graph::sendObject().

WPXUnit WPSPosition::unit | ( |  | ) | const

inline

returns the unit

Referenced by WPSContentListener::_handleFrameParameters(), and WPSOLEParser::parse().

## Friends And Related Function Documentation

std::ostream& operator<< | ( | std::ostream & | o,
|  | WPSPosition const & | pos
| ) |  |

friend

operator<<

## Member Data Documentation

AnchorTo WPSPosition::m_anchorTo

anchor position

Referenced by WPSContentListener::_handleFrameParameters(), WPSContentListener::_openFrame(), cmp(), WPS8Parser::sendPageFrames(), WPS8Table::sendTable(), WPS8Parser::sendTable(), and setRelativePosition().

Vec2f WPSPosition::m_naturalSize

protected

the natural size of the data (if known)

Referenced by cmp(), naturalSize(), and setNaturalSize().

int WPSPosition::m_order

mutable protected

background/foward order

Referenced by order(), and setOrder().

Vec2f WPSPosition::m_orig

protected

the origin position in a page

Referenced by cmp(), origin(), setOrigin(), and setPagePos().

int WPSPosition::m_page

protected

the page

Referenced by page(), setPage(), and setPagePos().

Vec2f WPSPosition::m_size

protected

Referenced by cmp(), setSize(), and size().

WPXUnit WPSPosition::m_unit

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(), WPS8Graph::sendBorder(), WPS4Graph::sendObject(), WPS8Parser::sendObject(), WPS8Graph::sendObjects(), WPS4Graph::sendObjects(), WPS8Parser::sendPageFrames(), WPS8Table::sendTable(), and WPS8Parser::sendTable().

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().

The documentation for this class was generated from the following file:

- WPSPosition.h