Base class for all frame object,include drawing,image,text-box. More...

#include <xfframe.hxx>

Inheritance diagram for XFFrame:

Collaboration diagram for XFFrame:

Public Member Functions
	XFFrame ()

	XFFrame (bool isTextBox)

virtual	~XFFrame () override

virtual void	Add (XFContent *pContent) override
	@descr override the add function to adjust z-index. More...

void	SetAnchorType (enumXFAnchor type)
	@descr: Set the anchor type for the frame object. More...

void	SetAnchorPage (sal_Int32 page)
	@descr: if it's page anchor,set the page number. More...

void	SetName (const OUString &name)
	@descr Set frame name. More...

void	SetZIndex (sal_uInt32 zIndex)
	@descr Set z-index of the frame. More...

void	SetX (double x)
	@descr Set frame position X. More...

void	SetY (double y)
	@descr Set frame position Y. More...

void	SetWidth (double width)
	@descr Set frame width. More...

void	SetHeight (double height)
	@descr Set frame height. More...

void	SetMinHeight (double minHeight)
	@descr Set frame min-height. More...

void	SetPosition (double x, double y, double width, double height)
	@descr Set frame position. More...

void	SetPosition (const XFRect &rect)
	@descr Set frame position. More...

void	SetNextLink (const OUString &next)
	@descr: Link the text content of the two frame. More...

enumXFFrameType	GetFrameType () const
	@descr Get the frame type. More...

virtual enumXFContent	GetContentType () override
	@descr Get content type, enumXFContentFrame. More...

virtual void	ToXml (IXFStream *pStrm) override
	@descr serialize. More...

virtual void	Add (XFContent *pContent)
	@descr Add content. More...

void	Add (const OUString &text)
	@descr convenience function for add text content. More...

Public Member Functions inherited from XFContentContainer
	XFContentContainer ()

virtual	~XFContentContainer () override
	@descr Destructure, all contents will be deleted too. More...

virtual void	Add (XFContent *pContent)
	@descr Add content. More...

rtl::Reference< XFContent >	GetLastContent ()

void	RemoveLastContent ()

void	Add (const OUString &text)
	@descr convenience function for add text content. More...

int	GetCount () const
	@descr return the number of contents in the container. More...

rtl::Reference< XFContent >	GetContent (sal_uInt32 index) const
	@descr get content by index. More...

void	Reset ()
	@descr clear all contents in the container. More...

rtl::Reference< XFContent >	FindFirstContent (enumXFContent type)
	@descr helper function, find first content by type. More...

virtual enumXFContent	GetContentType () override
	@descr return the content type. More...

virtual void	ToXml (IXFStream *pStrm) override
	@descr Output to OOo model or local file. More...

bool	HierarchyContains (const XFContent *pContent) const

Public Member Functions inherited from XFContent
virtual enumXFContent	GetContentType ()
	: return the content type. More...

virtual void	SetStyleName (const OUString &style)
	: All content except XFTextContent can have a style. More...

const OUString &	GetStyleName () const
	: return the style name. More...

void	DoToXml (IXFStream *stream)

Public Member Functions inherited from salhelper::SimpleReferenceObject
	SimpleReferenceObject ()

void	acquire ()

void	release ()

Protected Attributes
enumXFAnchor	m_eAnchor

sal_Int32	m_nAnchorPage

OUString	m_strName

sal_uInt32	m_nZIndex

XFRect	m_aRect

double	m_fMinHeight

OUString	m_strNextLink

enumXFFrameType	m_eType

sal_uInt32	m_nFrameFlag

bool	m_isTextBox

Protected Attributes inherited from XFContent
OUString	m_strStyleName

Protected Attributes inherited from salhelper::SimpleReferenceObject
oslInterlockedCount	m_nCount

Private Member Functions
void	StartFrame (IXFStream *pStrm)

void	AdjustZIndex ()

Static Private Member Functions
static void	EndFrame (IXFStream *pStrm)

Additional Inherited Members
Static Public Member Functions inherited from salhelper::SimpleReferenceObject
static void *	operator new (std::size_t nSize)

static void *	operator new (std::size_t nSize, std::nothrow_t const &rNothrow)

static void	operator delete (void *pPtr)

static void	operator delete (void *pPtr, std::nothrow_t const &rNothrow)

Protected Member Functions inherited from XFContent
	XFContent ()

virtual void	ToXml (IXFStream *stream)=0

virtual	~XFContent () override

Protected Member Functions inherited from salhelper::SimpleReferenceObject
virtual	~SimpleReferenceObject () COVERITY_NOEXCEPT_FALSE

Detailed Description

Base class for all frame object,include drawing,image,text-box.

Use SetX(),SetY(),SetWidth(),SetHeight() to set position for the frame. Only if you set anchor type to enumXFAnchorPage, the SetAnchorPage functions.

Definition at line 78 of file xfframe.hxx.

Constructor & Destructor Documentation

◆ XFFrame() [1/2]

XFFrame::XFFrame ( )

Definition at line 66 of file xfframe.cxx.

◆ XFFrame() [2/2]

XFFrame::XFFrame ( bool isTextBox )

explicit

Definition at line 70 of file xfframe.cxx.

References m_eType.

◆ ~XFFrame()

XFFrame::~XFFrame ( )

overridevirtual

Definition at line 81 of file xfframe.cxx.

Member Function Documentation

◆ Add() [1/3]

void XFContentContainer::Add ( const OUString & text )

@descr convenience function for add text content.

Definition at line 97 of file xfcontentcontainer.cxx.

◆ Add() [2/3]

void XFContentContainer::Add ( XFContent * pContent )

virtual

@descr Add content.

Reimplemented from XFContentContainer.

Definition at line 90 of file xfcontentcontainer.cxx.

◆ Add() [3/3]

void XFFrame::Add ( XFContent * pContent )

overridevirtual

@descr override the add function to adjust z-index.

Reimplemented from XFContentContainer.

Definition at line 85 of file xfframe.cxx.

References XFContentContainer::Add(), enumXFContentFrame, XFContent::GetContentType(), m_nZIndex, and SetZIndex().

◆ AdjustZIndex()

void XFFrame::AdjustZIndex ( )

private

Definition at line 185 of file xfframe.cxx.

References AdjustZIndex(), enumXFContentFrame, XFContentContainer::GetContent(), XFContentContainer::GetCount(), i, and m_nZIndex.

Referenced by AdjustZIndex(), and SetZIndex().

◆ EndFrame()

void XFFrame::EndFrame ( IXFStream * pStrm )

staticprivate

Definition at line 180 of file xfframe.cxx.

References IXFStream::EndElement().

Referenced by ToXml().

◆ GetContentType()

enumXFContent XFFrame::GetContentType ( )

overridevirtual

@descr Get content type, enumXFContentFrame.

Reimplemented from XFContentContainer.

Definition at line 114 of file xfframe.cxx.

References enumXFContentFrame.

◆ GetFrameType()

enumXFFrameType XFFrame::GetFrameType ( ) const

@descr Get the frame type.

image, drawing or text-box.

Definition at line 109 of file xfframe.cxx.

References m_eType.

◆ SetAnchorPage()

void XFFrame::SetAnchorPage ( sal_Int32 page )

inline

@descr: if it's page anchor,set the page number.

Definition at line 244 of file xfframe.hxx.

References m_nAnchorPage.

Referenced by LwpFrame::Parse(), LwpFrame::ParseAnchorType(), and XFFloatFrame::ToXml().

◆ SetAnchorType()

void XFFrame::SetAnchorType ( enumXFAnchor type )

inline

@descr: Set the anchor type for the frame object.

Definition at line 188 of file xfframe.hxx.

References m_eAnchor.

Referenced by LwpFrame::ParseAnchorType(), and XFFloatFrame::XFFloatFrame().

◆ SetHeight()

void XFFrame::SetHeight ( double height )

inline

@descr Set frame height.

Be careful SetHeight and SetMinHeight will override each other.

Definition at line 213 of file xfframe.hxx.

References m_aRect, m_nFrameFlag, XFRect::SetHeight(), and XFFRAME_FLAG_HEIGHT.

Referenced by LwpFrameLayout::ApplyGraphicSize(), and LwpFrame::Parse().

◆ SetMinHeight()

void XFFrame::SetMinHeight ( double minHeight )

inline

@descr Set frame min-height.

Be careful SetHeight and SetMinHeight will override each other.

Definition at line 220 of file xfframe.hxx.

References m_fMinHeight, m_nFrameFlag, and XFFRAME_FLAG_MINHEIGHT.

Referenced by LwpFrame::Parse().

◆ SetName()

void XFFrame::SetName ( const OUString & name )

inline

@descr Set frame name.

Definition at line 193 of file xfframe.hxx.

References m_strName, and name.

Referenced by LwpFrame::Parse().

◆ SetNextLink()

void XFFrame::SetNextLink ( const OUString & next )

inline

@descr: Link the text content of the two frame.

Definition at line 239 of file xfframe.hxx.

References m_strNextLink.

Referenced by LwpFrame::Parse().

◆ SetPosition() [1/2]

void XFFrame::SetPosition ( const XFRect & rect )

inline

@descr Set frame position.

Definition at line 234 of file xfframe.hxx.

References m_aRect.

◆ SetPosition() [2/2]

void XFFrame::SetPosition	(	double	x,
		double	y,
		double	width,
		double	height
	)

inline

@descr Set frame position.

Definition at line 227 of file xfframe.hxx.

References m_aRect, m_nFrameFlag, XFRect::SetSize(), XFRect::SetStartPoint(), x, XFFRAME_FLAG_HEIGHT, and y.

Referenced by LwpDrawObj::SetPosition(), XFDrawPath::ToXml(), XFDrawPolygon::ToXml(), and XFDrawPolyline::ToXml().

◆ SetWidth()

void XFFrame::SetWidth ( double width )

inline

@descr Set frame width.

Definition at line 208 of file xfframe.hxx.

References m_aRect, and XFRect::SetWidth().

Referenced by LwpFrameLayout::ApplyGraphicSize(), and LwpFrame::Parse().

◆ SetX()

void XFFrame::SetX ( double x )

inline

@descr Set frame position X.

Definition at line 198 of file xfframe.hxx.

References m_aRect, XFRect::SetX(), and x.

Referenced by LwpFrame::ParseAnchorType().

◆ SetY()

void XFFrame::SetY ( double y )

inline

@descr Set frame position Y.

Definition at line 203 of file xfframe.hxx.

References m_aRect, XFRect::SetY(), and y.

Referenced by LwpFrame::ParseAnchorType().

◆ SetZIndex()

void XFFrame::SetZIndex ( sal_uInt32 zIndex )

@descr Set z-index of the frame.

Definition at line 101 of file xfframe.cxx.

References AdjustZIndex(), and m_nZIndex.

Referenced by Add().

◆ StartFrame()

void XFFrame::StartFrame ( IXFStream * pStrm )

private

Definition at line 128 of file xfframe.cxx.

References IXFAttrList::AddAttribute(), enumXFAnchorAsChar, enumXFAnchorChar, enumXFAnchorFrame, enumXFAnchorPage, enumXFAnchorPara, IXFStream::GetAttrList(), XFRect::GetHeight(), XFContent::GetStyleName(), XFRect::GetWidth(), XFRect::GetX(), XFRect::GetY(), m_aRect, m_eAnchor, m_fMinHeight, m_isTextBox, m_nAnchorPage, m_nFrameFlag, m_nZIndex, m_strName, m_strNextLink, IXFStream::StartElement(), XFFRAME_FLAG_MAXHEIGHT, and XFFRAME_FLAG_MINHEIGHT.

Referenced by ToXml().

◆ ToXml()

void XFFrame::ToXml ( IXFStream * pStrm )

overridevirtual

@descr serialize.

Reimplemented from XFContentContainer.

Reimplemented in XFDrawGroup, XFDrawLine, XFDrawObject, XFDrawPath, XFDrawPolygon, XFDrawPolyline, XFDrawRect, XFFloatFrame, and XFImage.

Definition at line 119 of file xfframe.cxx.

References EndFrame(), StartFrame(), and XFContentContainer::ToXml().

Referenced by XFFloatFrame::ToXml().

Member Data Documentation

◆ m_aRect

XFRect XFFrame::m_aRect

protected

Definition at line 180 of file xfframe.hxx.

Referenced by SetHeight(), SetPosition(), XFDrawRect::SetSize(), XFDrawRect::SetStartPoint(), SetWidth(), SetX(), SetY(), StartFrame(), XFDrawObject::ToXml(), XFDrawPath::ToXml(), and XFImage::ToXml().

◆ m_eAnchor

enumXFAnchor XFFrame::m_eAnchor

protected

Definition at line 176 of file xfframe.hxx.

Referenced by SetAnchorType(), StartFrame(), XFDrawLine::ToXml(), XFDrawObject::ToXml(), and XFImage::ToXml().

◆ m_eType

enumXFFrameType XFFrame::m_eType

protected

Definition at line 183 of file xfframe.hxx.

Referenced by GetFrameType(), XFDrawObject::XFDrawObject(), and XFImage::XFImage().

◆ m_fMinHeight

double XFFrame::m_fMinHeight

protected

Definition at line 181 of file xfframe.hxx.

Referenced by SetMinHeight(), and StartFrame().

◆ m_isTextBox

bool XFFrame::m_isTextBox

protected

Definition at line 185 of file xfframe.hxx.

Referenced by StartFrame().

◆ m_nAnchorPage

sal_Int32 XFFrame::m_nAnchorPage

protected

Definition at line 177 of file xfframe.hxx.

Referenced by SetAnchorPage(), StartFrame(), and XFImage::ToXml().

◆ m_nFrameFlag

sal_uInt32 XFFrame::m_nFrameFlag

protected

Definition at line 184 of file xfframe.hxx.

Referenced by SetHeight(), SetMinHeight(), SetPosition(), and StartFrame().

◆ m_nZIndex

sal_uInt32 XFFrame::m_nZIndex

protected

Definition at line 179 of file xfframe.hxx.

Referenced by Add(), AdjustZIndex(), SetZIndex(), StartFrame(), XFDrawLine::ToXml(), XFDrawObject::ToXml(), and XFImage::ToXml().

◆ m_strName

OUString XFFrame::m_strName

protected

Definition at line 178 of file xfframe.hxx.

Referenced by SetName(), StartFrame(), XFDrawLine::ToXml(), XFDrawObject::ToXml(), XFImage::ToXml(), and XFImage::XFImage().

◆ m_strNextLink

OUString XFFrame::m_strNextLink

protected

Definition at line 182 of file xfframe.hxx.

Referenced by SetNextLink(), and StartFrame().

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

Public Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XFFrame() [1/2]

◆ XFFrame() [2/2]

◆ ~XFFrame()

Member Function Documentation

◆ Add() [1/3]

◆ Add() [2/3]

◆ Add() [3/3]

◆ AdjustZIndex()

◆ EndFrame()

◆ GetContentType()

◆ GetFrameType()

◆ SetAnchorPage()

◆ SetAnchorType()

◆ SetHeight()

◆ SetMinHeight()

◆ SetName()

◆ SetNextLink()

◆ SetPosition() [1/2]

◆ SetPosition() [2/2]

◆ SetWidth()

◆ SetX()

◆ SetY()

◆ SetZIndex()

◆ StartFrame()

◆ ToXml()

Member Data Documentation

◆ m_aRect

◆ m_eAnchor

◆ m_eType

◆ m_fMinHeight

◆ m_isTextBox

◆ m_nAnchorPage

◆ m_nFrameFlag

◆ m_nZIndex

◆ m_strName

◆ m_strNextLink