Background image object. More...

#include <xfbgimage.hxx>

Inheritance diagram for XFBGImage:

Collaboration diagram for XFBGImage:

Public Member Functions
	XFBGImage ()

void	SetFileLink (const OUString &fileName)
	@descr Use file link as image source. More...

void	SetImageData (sal_uInt8 const *buf, int len)
	@descr Use base64 stream as image source. More...

void	SetPosition (enumXFAlignType horiAlign=enumXFAlignCenter, enumXFAlignType vertAlign=enumXFAlignCenter)
	@descr Set the image position type. More...

void	SetRepeate ()
	@descr Set background image repeat style. More...

void	SetStretch ()
	@descr Set whether the image should be stretched to fill the owner object. More...

virtual bool	Equal (IXFStyle *pStyle) override
	@descr decide whether there has been a style that is the same as this object. More...

virtual void	ToXml (IXFStream *pStrm) override

Public Member Functions inherited from XFStyle
	XFStyle ()

virtual	~XFStyle () override

	XFStyle (XFStyle const &)=default

	XFStyle (XFStyle &&)=default

XFStyle &	operator= (XFStyle const &)=default

XFStyle &	operator= (XFStyle &&)=default

virtual OUString	GetStyleName () override
	@descr get style name. More...

virtual void	SetStyleName (const OUString &styleName) override
	@descr set style name. More...

virtual OUString	GetParentStyleName () override
	@descr set parent style name. More...

virtual void	SetParentStyleName (const OUString &styleName) override
	@descr return parent style name. More...

virtual enumXFStyle	GetStyleFamily () override
	@descr get style family. More...

virtual bool	Equal (IXFStyle *pStyle) override
	@descr decide whether two style are equal. More...

Public Member Functions inherited from IXFStyle
	IXFStyle ()=default

	IXFStyle (IXFStyle const &)=default

	IXFStyle (IXFStyle &&)=default

IXFStyle &	operator= (IXFStyle const &)=default

IXFStyle &	operator= (IXFStyle &&)=default

virtual	~IXFStyle ()

virtual OUString	GetStyleName ()=0
	@descr: return the style name. More...

virtual void	SetStyleName (const OUString &styleName)=0
	@descr: set the name of the style. More...

virtual OUString	GetParentStyleName ()=0
	@descr return the parent style name. More...

virtual void	SetParentStyleName (const OUString &parent)=0
	@descr: Parent paragraph style. More...

virtual enumXFStyle	GetStyleFamily ()=0
	@descr: return the style family. More...

virtual bool	Equal (IXFStyle *pStyle)=0
	@descr: Compare whatever two style object are the same. More...

virtual void	ToXml (IXFStream *stream)=0

Private Attributes
OUString	m_strFileName

OUString	m_strData

bool	m_bUserFileLink

bool	m_bRepeate

bool	m_bStretch

bool	m_bPosition

enumXFAlignType	m_eHoriAlign

enumXFAlignType	m_eVertAlign

Friends
bool	operator== (XFBGImage const &img1, XFBGImage const &img2)

bool	operator!= (XFBGImage const &img1, XFBGImage const &img2)

Additional Inherited Members
Protected Attributes inherited from XFStyle
OUString	m_strStyleName

OUString	m_strParentStyleName

Detailed Description

Background image object.

Definition at line 69 of file xfbgimage.hxx.

Constructor & Destructor Documentation

◆ XFBGImage()

XFBGImage::XFBGImage ( )

Definition at line 65 of file xfbgimage.cxx.

Member Function Documentation

◆ Equal()

bool XFBGImage::Equal ( IXFStyle * pStyle )

overridevirtual

@descr decide whether there has been a style that is the same as this object.

If it use base64 stream, i'll simply return sal_False because it's too slow to compare two base64 stream.

Reimplemented from XFStyle.

Definition at line 80 of file xfbgimage.cxx.

◆ SetFileLink()

void XFBGImage::SetFileLink ( const OUString & fileName )

inline

@descr Use file link as image source.

Definition at line 123 of file xfbgimage.hxx.

References m_bUserFileLink, and m_strFileName.

◆ SetImageData()

void XFBGImage::SetImageData	(	sal_uInt8 const *	buf,
		int	len
	)

@descr Use base64 stream as image source.

Definition at line 74 of file xfbgimage.cxx.

References XFBase64::Encode(), m_bUserFileLink, and m_strData.

◆ SetPosition()

void XFBGImage::SetPosition	(	enumXFAlignType	horiAlign = `enumXFAlignCenter`,
		enumXFAlignType	vertAlign = `enumXFAlignCenter`
	)

inline

@descr Set the image position type.

Definition at line 129 of file xfbgimage.hxx.

References m_bPosition, m_bRepeate, m_bStretch, m_eHoriAlign, and m_eVertAlign.

◆ SetRepeate()

void XFBGImage::SetRepeate ( )

inline

@descr Set background image repeat style.

Definition at line 139 of file xfbgimage.hxx.

References m_bPosition, m_bRepeate, and m_bStretch.

◆ SetStretch()

void XFBGImage::SetStretch ( )

inline

@descr Set whether the image should be stretched to fill the owner object.

Definition at line 146 of file xfbgimage.hxx.

References m_bPosition, m_bRepeate, and m_bStretch.

◆ ToXml()

void XFBGImage::ToXml ( IXFStream * pStrm )

overridevirtual

Implements IXFStyle.

Definition at line 85 of file xfbgimage.cxx.

References IXFAttrList::AddAttribute(), IXFStream::Characters(), IXFAttrList::Clear(), IXFStream::EndElement(), enumXFAlignCenter, enumXFAlignEnd, enumXFAlignStart, GetAlignName(), IXFStream::GetAttrList(), m_bPosition, m_bRepeate, m_bStretch, m_bUserFileLink, m_eHoriAlign, m_eVertAlign, m_strData, m_strFileName, and IXFStream::StartElement().

Friends And Related Function Documentation

◆ operator!=

bool operator!=	(	XFBGImage const &	img1,
		XFBGImage const &	img2
	)

friend

Definition at line 157 of file xfbgimage.cxx.

◆ operator==

bool operator==	(	XFBGImage const &	img1,
		XFBGImage const &	img2
	)

friend

Definition at line 129 of file xfbgimage.cxx.

Member Data Documentation

◆ m_bPosition

bool XFBGImage::m_bPosition

private

Definition at line 118 of file xfbgimage.hxx.

Referenced by SetPosition(), SetRepeate(), SetStretch(), and ToXml().

◆ m_bRepeate

bool XFBGImage::m_bRepeate

private

Definition at line 116 of file xfbgimage.hxx.

Referenced by SetPosition(), SetRepeate(), SetStretch(), and ToXml().

◆ m_bStretch

bool XFBGImage::m_bStretch

private

Definition at line 117 of file xfbgimage.hxx.

Referenced by SetPosition(), SetRepeate(), SetStretch(), and ToXml().

◆ m_bUserFileLink

bool XFBGImage::m_bUserFileLink

private

Definition at line 115 of file xfbgimage.hxx.

Referenced by SetFileLink(), SetImageData(), and ToXml().

◆ m_eHoriAlign

enumXFAlignType XFBGImage::m_eHoriAlign

private

Definition at line 119 of file xfbgimage.hxx.

Referenced by SetPosition(), and ToXml().

◆ m_eVertAlign

enumXFAlignType XFBGImage::m_eVertAlign

private

Definition at line 120 of file xfbgimage.hxx.

Referenced by SetPosition(), and ToXml().

◆ m_strData

OUString XFBGImage::m_strData

private

Definition at line 114 of file xfbgimage.hxx.

Referenced by SetImageData(), and ToXml().

◆ m_strFileName

OUString XFBGImage::m_strFileName

private

Definition at line 113 of file xfbgimage.hxx.

Referenced by SetFileLink(), and ToXml().

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

Public Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XFBGImage()

Member Function Documentation

◆ Equal()

◆ SetFileLink()

◆ SetImageData()

◆ SetPosition()

◆ SetRepeate()

◆ SetStretch()

◆ ToXml()

Friends And Related Function Documentation

◆ operator!=

◆ operator==

Member Data Documentation

◆ m_bPosition

◆ m_bRepeate

◆ m_bStretch

◆ m_bUserFileLink

◆ m_eHoriAlign

◆ m_eVertAlign

◆ m_strData

◆ m_strFileName