MWAWPosition Class Reference

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

#include <MWAWPosition.hxx>

Public Types

enum  AnchorTo {
  Char, CharBaseLine, Frame, Paragraph,
  Page, Cell, Unknown
}
 a list of enum used to defined the anchor More...
 
enum  Wrapping {
  WNone, WBackground, WDynamic, WForeground,
  WParallel, WRunThrough
}
 an enum used to define the wrapping: none, ... 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

 MWAWPosition (MWAWVec2f const &orig=MWAWVec2f(), MWAWVec2f const &sz=MWAWVec2f(), librevenge::RVNGUnit theUnit=librevenge::RVNG_INCH)
 constructor More...
 
 MWAWPosition (MWAWPosition const &)=default
 
MWAWPositionoperator= (MWAWPosition const &)=default
 
 ~MWAWPosition ()
 destructor More...
 
bool operator== (MWAWPosition const &f) const
 basic operator== More...
 
bool operator!= (MWAWPosition const &f) const
 basic operator!= More...
 
bool operator< (MWAWPosition const &f) const
 basic operator< More...
 
int page () const
 returns the frame page More...
 
const MWAWVec2forigin () const
 return the frame origin More...
 
const MWAWVec2fsize () const
 returns the frame size More...
 
const MWAWVec2fnaturalSize () const
 returns the natural size (if known) More...
 
const MWAWVec2fleftTopClipping () const
 returns the left top clipping More...
 
const MWAWVec2frightBottomClipping () const
 returns the right bottom clipping More...
 
librevenge::RVNGUnit unit () const
 returns the unit More...
 
float getInvUnitScale (librevenge::RVNGUnit fromUnit) 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 (MWAWVec2f const &orig)
 sets the frame origin More...
 
void setSize (MWAWVec2f const &sz)
 sets the frame size More...
 
void setNaturalSize (MWAWVec2f const &naturalSz)
 sets the natural size (if known) More...
 
void setUnit (librevenge::RVNGUnit newUnit)
 sets the dimension unit More...
 
void setPagePos (int pg, MWAWVec2f 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...
 
void setAnchorToCell (librevenge::RVNGString const &cellName)
 sets the anchor to a cell position More...
 
void setClippingPosition (MWAWVec2f lTop, MWAWVec2f rBottom)
 sets the clipping 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 (librevenge::RVNGUnit orig, librevenge::RVNGUnit dest)
 

Public Attributes

AnchorTo m_anchorTo
 anchor position More...
 
librevenge::RVNGString m_anchorCellName
 the anchor cell name 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 (MWAWPosition const &f) const
 basic function to compare two positions More...
 

Protected Attributes

int m_page
 the page More...
 
MWAWVec2f m_orig
 the origin position in a page More...
 
MWAWVec2f m_size
 
MWAWVec2f m_naturalSize
 the natural size of the data (if known) More...
 
MWAWVec2f m_LTClip
 the left top clip position More...
 
MWAWVec2f m_RBClip
 
librevenge::RVNGUnit m_unit
 the unit used in orig, in m_size and in m_LTClip , .... Default: in inches More...
 
int m_order
 background/foward order More...
 

Friends

std::ostream & operator<< (std::ostream &o, MWAWPosition 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

◆ AnchorTo

a list of enum used to defined the anchor

Enumerator
Char 
CharBaseLine 
Frame 
Paragraph 
Page 
Cell 
Unknown 

◆ Wrapping

an enum used to define the wrapping: none, ...

Enumerator
WNone 
WBackground 
WDynamic 
WForeground 
WParallel 
WRunThrough 

◆ XPos

an enum used to define the relative X position

Enumerator
XRight 
XLeft 
XCenter 
XFull 

◆ YPos

an enum used to define the relative Y position

Enumerator
YTop 
YBottom 
YCenter 
YFull 

Constructor & Destructor Documentation

◆ MWAWPosition() [1/2]

MWAWPosition::MWAWPosition ( MWAWVec2f const &  orig = MWAWVec2f(),
MWAWVec2f const &  sz = MWAWVec2f(),
librevenge::RVNGUnit  theUnit = librevenge::RVNG_INCH 
)
inlineexplicit

constructor

◆ MWAWPosition() [2/2]

MWAWPosition::MWAWPosition ( MWAWPosition const &  )
default

◆ ~MWAWPosition()

MWAWPosition::~MWAWPosition ( )

destructor

Member Function Documentation

◆ cmp()

int MWAWPosition::cmp ( MWAWPosition const &  f) const
inlineprotected

basic function to compare two positions

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

◆ getInvUnitScale()

◆ getScaleFactor()

◆ leftTopClipping()

◆ naturalSize()

◆ operator!=()

bool MWAWPosition::operator!= ( MWAWPosition const &  f) const
inline

basic operator!=

◆ operator<()

bool MWAWPosition::operator< ( MWAWPosition const &  f) const
inline

basic operator<

◆ operator=()

MWAWPosition& MWAWPosition::operator= ( MWAWPosition const &  )
default

◆ operator==()

bool MWAWPosition::operator== ( MWAWPosition const &  f) const
inline

basic operator==

◆ order()

◆ origin()

◆ page()

int MWAWPosition::page ( ) const
inline

◆ rightBottomClipping()

◆ setAnchorToCell()

void MWAWPosition::setAnchorToCell ( librevenge::RVNGString const &  cellName)
inline

◆ setClippingPosition()

void MWAWPosition::setClippingPosition ( MWAWVec2f  lTop,
MWAWVec2f  rBottom 
)
inline

sets the clipping position

Referenced by NisusWrtGraph::sendPicture(), and NisusWrtText::sendText().

◆ setNaturalSize()

◆ setOrder()

◆ setOrigin()

◆ setPage()

◆ setPagePos()

void MWAWPosition::setPagePos ( int  pg,
MWAWVec2f const &  newOrig 
) const
inline

◆ setRelativePosition()

void MWAWPosition::setRelativePosition ( AnchorTo  anchor,
XPos  X = XLeft,
YPos  Y = YTop 
)
inline

sets the relative position

Referenced by ClarisDrawParser::createDocument(), MarinerWrtGraph::flushExtra(), NisusWrtGraph::flushExtra(), HanMacWrdKGraph::flushExtra(), HanMacWrdJGraph::flushExtra(), ClarisDrawGraph::flushExtra(), ClarisWksGraph::flushExtra(), MsWksGraphInternal::Zone::getPosition(), MacWrtProStructuresInternal::Block::getPosition(), CorelPainterParser::getZonePosition(), ClarisDrawParser::parse(), ClarisWksBMParser::parse(), MsWksGraphInternal::SubDocument::parse(), MWAWOLEParser::readContents(), MWAWOLEParser::readCONTENTS(), MindWrtParser::readGraphic(), MacWrtParser::readGraphic(), WriterPlsParser::readGraphic(), MWAWOLEParser::readOlePres(), WriteNowText::readTokenV2(), MacPaintParser::sendBitmap(), PixelPaintParser::sendBitmap(), BeagleWksBMParser::sendBitmap(), SuperPaintParser::sendBitmap(), MsWksTable::sendChart(), HanMacWrdKGraph::sendEmptyPicture(), HanMacWrdJGraph::sendEmptyPicture(), MWAWTable::sendExtraLines(), BeagleWksDBParser::sendFrame(), BeagleWksSSParser::sendFrame(), BeagleWksBMParser::sendFrame(), BeagleWksParser::sendFrame(), BeagleWksDRParser::sendFrame(), GreatWksGraph::sendFrame(), ActaText::sendGraphic(), FullWrtGraph::sendGraphic(), ClarisWksGraph::sendGroup(), ClarisWksGraph::sendGroupChild(), LightWayTxtGraph::sendJPEG(), MsWksGraph::sendObjects(), ClarisWksGraph::sendPageChild(), NisusWrtGraph::sendPageGraphics(), HanMacWrdKGraph::sendPageGraphics(), HanMacWrdJGraph::sendPageGraphics(), LightWayTxtGraph::sendPICT(), GreatWksBMParser::sendPicture(), MacDocParser::sendPicture(), EDocParser::sendPicture(), NisusWrtGraph::sendPicture(), TeachTxtParser::sendPicture(), DocMkrParser::sendPicture(), MarinerWrtGraph::sendPicture(), StyleParser::sendPicture(), WriteNowParser::sendPicture(), MsWrdParser::sendPicture(), MarinerWrtGraph::sendRule(), FullWrtGraph::sendSideBar(), BeagleWksSSParser::sendSpreadsheet(), NisusWrtText::sendText(), ClarisWksText::sendText(), MacWrtProParser::sendText(), GreatWksText::sendZone(), HanMacWrdJParser::sendZone(), and HanMacWrdKParser::sendZone().

◆ setSize()

◆ setUnit()

◆ size()

◆ unit()

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  o,
MWAWPosition const &  pos 
)
friend

operator<<

Member Data Documentation

◆ m_anchorCellName

◆ m_anchorTo

AnchorTo MWAWPosition::m_anchorTo

anchor position

Referenced by MWAWTextListener::_handleFrameParameters(), MWAWPresentationListener::_handleFrameParameters(), MWAWGraphicListener::_handleFrameParameters(), MWAWSpreadsheetListener::_handleFrameParameters(), cmp(), RagTime5Graph::flushExtra(), RagTime5Spreadsheet::flushExtra(), RagTimeSpreadsheet::flushExtra(), MsWksGraph::flushExtra(), RagTimeParser::flushExtra(), MWAWPresentationListener::insertFooter(), MWAWGraphicListener::insertFooter(), MWAWPresentationListener::insertHeader(), MWAWGraphicListener::insertHeader(), MWAWSpreadsheetListener::insertPicture(), MWAWTextListener::insertShape(), MWAWSpreadsheetListener::insertShape(), MWAWSpreadsheetListener::insertTextBox(), MWAWTextListener::openFrame(), MWAWSpreadsheetListener::openFrame(), MWAWTextListener::openGroup(), MWAWSpreadsheetListener::openGroup(), MWAWPresentationListener::openTable(), MWAWGraphicListener::openTable(), CricketDrawParser::send(), MacDraft5Parser::send(), MacDrawParser::send(), RagTime5Spreadsheet::send(), MsWksGraph::send(), MacDraftParser::send(), RagTimeParser::send(), MacDrawProParser::send(), CricketDrawParser::sendAll(), MsWksGraph::sendAll(), FreeHandParser::sendBackgroundPicture(), CricketDrawParser::sendBitmap(), ClarisDrawGraph::sendBitmap(), ClarisWksGraph::sendBitmap(), RagTime5ClusterManager::sendClusterMainList(), ClarisWksDatabase::sendDatabase(), HanMacWrdKGraph::sendEmptyPicture(), HanMacWrdJGraph::sendEmptyPicture(), PowerPoint7Graph::sendFrame(), PowerPoint1Parser::sendFrame(), HanMacWrdJGraph::sendFrame(), HanMacWrdKGraph::sendFrame(), PowerPoint3Parser::sendFrame(), WingzGraph::sendGraphic(), ClarisDrawGraph::sendGroup(), GreatWksGraph::sendGroup(), FreeHandParser::sendGroup(), ClarisWksGraph::sendGroup(), HanMacWrdKGraph::sendGroup(), HanMacWrdJGraph::sendGroup(), MsWksGraph::sendGroup(), GreatWksGraph::sendGroupChild(), ClarisWksGraph::sendGroupChild(), HanMacWrdKGraph::sendGroupChild(), HanMacWrdJGraph::sendGroupChild(), MsWksGraph::sendGroupChild(), MindWrtParser::sendHeaderFooter(), ClarisDrawGraph::sendMainGroupChild(), MouseWrtParser::sendMainZone(), MsWksGraph::sendObjects(), RagTime5Layout::sendPageContents(), WingzGraph::sendPageGraphics(), NisusWrtGraph::sendPicture(), FreeHandParser::sendPicture(), SuperPaintParser::sendPictures(), BeagleWksDRParser::sendPictures(), MarinerWrtGraph::sendRule(), FreeHandParser::sendShape(), PowerPoint7Graph::sendSlide(), PowerPoint1Parser::sendSlide(), PowerPoint3Parser::sendSlides(), MoreText::sendText(), FreeHandParser::sendTextbox(), GreatWksGraph::sendTextboxAsGraphic(), ClarisWksPresentation::sendZone(), ClarisWksDocument::sendZone(), setAnchorToCell(), setRelativePosition(), and ApplePictParserInternal::State::updatePosition().

◆ m_LTClip

MWAWVec2f MWAWPosition::m_LTClip
protected

the left top clip position

Referenced by cmp(), leftTopClipping(), and setClippingPosition().

◆ m_naturalSize

MWAWVec2f MWAWPosition::m_naturalSize
protected

the natural size of the data (if known)

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

◆ m_order

int MWAWPosition::m_order
mutableprotected

background/foward order

Referenced by order(), and setOrder().

◆ m_orig

MWAWVec2f MWAWPosition::m_orig
protected

the origin position in a page

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

◆ m_page

int MWAWPosition::m_page
protected

the page

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

◆ m_RBClip

MWAWVec2f MWAWPosition::m_RBClip
protected

◆ m_size

MWAWVec2f MWAWPosition::m_size
protected

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

◆ m_unit

librevenge::RVNGUnit MWAWPosition::m_unit
protected

the unit used in orig, in m_size and in m_LTClip , .... Default: in inches

Referenced by cmp(), getInvUnitScale(), setUnit(), and unit().

◆ m_wrapping

◆ m_xPos

◆ m_yPos


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

Generated on Mon Apr 25 2022 14:03:04 for libmwaw by doxygen 1.8.17