Style for all frame objects. More...

#include <xfframestyle.hxx>

Inheritance diagram for XFFrameStyle:

Collaboration diagram for XFFrameStyle:

Public Member Functions
	XFFrameStyle ()

virtual	~XFFrameStyle () override

void	SetWrapType (enumXFWrap wrap)

void	SetMargins (double left, double right, double top, double bottom)
	@descr: space between frame and paragraph text. More...

void	SetPadding (double left, double right, double top, double bottom)
	@descr: space between frame and text inside frame. More...

void	SetBorders (std::unique_ptr< XFBorders > pBorders)
	@descr: set the border property of the frame. More...

void	SetColumns (XFColumns *pColumns)
	@descr: set the column property of the frame. More...

void	SetShadow (XFShadow *pShadow)
	@descr: set the shadow object the frame. More...

void	SetBackImage (std::unique_ptr< XFBGImage > &rImage)
	@descr: set the background image of the frame. More...

void	SetBackColor (XFColor const &color)
	@descr: set the background color of the frame. More...

void	SetProtect (bool content, bool size, bool pos)
	@descr Set whether frame is protected. More...

void	SetTextDir (enumXFTextDir dir)
	@descr Set text dir. More...

void	SetXPosType (enumXFFrameXPos pos, enumXFFrameXRel rel)
	@descr Set horizontal position type. More...

void	SetYPosType (enumXFFrameYPos pos, enumXFFrameYRel rel)
	@descr Set vertical position type. More...

void	SetTransparency (sal_Int16 nTransparency)

virtual enumXFStyle	GetStyleFamily () override
	@descr get style family. 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

Protected Attributes
enumXFWrap	m_eWrap

XFPadding	m_aPad

XFMargins	m_aMargins

std::unique_ptr< XFBorders >	m_pBorders

std::unique_ptr< XFColumns >	m_pColumns

std::unique_ptr< XFShadow >	m_pShadow

std::unique_ptr< XFBGImage >	m_pBGImage

XFColor	m_aBackColor

bool	m_bProtectContent

bool	m_bProtectSize

bool	m_bProtectPos

sal_Int16	m_nTransparency

enumXFTextDir	m_eTextDir

enumXFFrameXPos	m_eXPos

enumXFFrameXRel	m_eXRel

enumXFFrameYPos	m_eYPos

enumXFFrameYRel	m_eYRel

Protected Attributes inherited from XFStyle
OUString	m_strStyleName

OUString	m_strParentStyleName

Detailed Description

Style for all frame objects.

Definition at line 79 of file xfframestyle.hxx.

Constructor & Destructor Documentation

◆ XFFrameStyle()

XFFrameStyle::XFFrameStyle ( )

Definition at line 67 of file xfframestyle.cxx.

◆ ~XFFrameStyle()

XFFrameStyle::~XFFrameStyle ( )

overridevirtual

Definition at line 80 of file xfframestyle.cxx.

Member Function Documentation

◆ GetStyleFamily()

enumXFStyle XFFrameStyle::GetStyleFamily ( )

overridevirtual

@descr get style family.

Reimplemented from XFStyle.

Definition at line 104 of file xfframestyle.cxx.

References enumXFStyleGraphics.

◆ SetBackColor()

void XFFrameStyle::SetBackColor ( XFColor const & color )

inline

@descr: set the background color of the frame.

Definition at line 200 of file xfframestyle.hxx.

References m_aBackColor.

Referenced by LwpFrame::ApplyBackColor(), and LwpFrame::ApplyWrapType().

◆ SetBackImage()

void XFFrameStyle::SetBackImage ( std::unique_ptr< XFBGImage > & rImage )

@descr: set the background image of the frame.

Definition at line 99 of file xfframestyle.cxx.

References m_pBGImage.

Referenced by LwpFrame::ApplyPatternFill(), and LwpFrame::ApplyWatermark().

◆ SetBorders()

void XFFrameStyle::SetBorders ( std::unique_ptr< XFBorders > pBorders )

@descr: set the border property of the frame.

Definition at line 84 of file xfframestyle.cxx.

References m_pBorders.

Referenced by LwpFrame::ApplyBorders().

◆ SetColumns()

void XFFrameStyle::SetColumns ( XFColumns * pColumns )

@descr: set the column property of the frame.

Definition at line 89 of file xfframestyle.cxx.

References m_pColumns.

Referenced by LwpFrame::ApplyColumns().

◆ SetMargins()

void XFFrameStyle::SetMargins	(	double	left,
		double	right,
		double	top,
		double	bottom
	)

inline

@descr: space between frame and paragraph text.

Definition at line 176 of file xfframestyle.hxx.

References bottom, left, m_aMargins, right, XFMargins::SetBottom(), XFMargins::SetLeft(), XFMargins::SetRight(), XFMargins::SetTop(), and top.

Referenced by LwpFrame::ApplyMargins().

◆ SetPadding()

void XFFrameStyle::SetPadding	(	double	left,
		double	right,
		double	top,
		double	bottom
	)

inline

@descr: space between frame and text inside frame.

Definition at line 188 of file xfframestyle.hxx.

References bottom, left, m_aPad, right, XFPadding::SetBottom(), XFPadding::SetLeft(), XFPadding::SetRight(), XFPadding::SetTop(), and top.

Referenced by LwpFrame::ApplyPadding().

◆ SetProtect()

void XFFrameStyle::SetProtect	(	bool	content,
		bool	size,
		bool	pos
	)

inline

@descr Set whether frame is protected.

There are three properties that can be protected, content,size and position.

Definition at line 210 of file xfframestyle.hxx.

References m_bProtectContent, m_bProtectPos, m_bProtectSize, pos, and size.

Referenced by LwpFrame::ApplyProtect().

◆ SetShadow()

void XFFrameStyle::SetShadow ( XFShadow * pShadow )

@descr: set the shadow object the frame.

Definition at line 94 of file xfframestyle.cxx.

References m_pShadow.

Referenced by LwpFrame::ApplyShadow().

◆ SetTextDir()

void XFFrameStyle::SetTextDir ( enumXFTextDir dir )

inline

@descr Set text dir.

Definition at line 205 of file xfframestyle.hxx.

References m_eTextDir.

Referenced by LwpFrame::ApplyTextDir().

◆ SetTransparency()

void XFFrameStyle::SetTransparency ( sal_Int16 nTransparency )

inline

Definition at line 229 of file xfframestyle.hxx.

References m_nTransparency.

Referenced by LwpFrame::ApplyWatermark(), and LwpFrame::ApplyWrapType().

◆ SetWrapType()

void XFFrameStyle::SetWrapType ( enumXFWrap wrap )

inline

Definition at line 171 of file xfframestyle.hxx.

References m_eWrap.

Referenced by LwpFrame::ApplyWrapType().

◆ SetXPosType()

void XFFrameStyle::SetXPosType	(	enumXFFrameXPos	pos,
		enumXFFrameXRel	rel
	)

inline

@descr Set horizontal position type.

Definition at line 217 of file xfframestyle.hxx.

References m_eXPos, m_eXRel, and pos.

Referenced by LwpFrame::ApplyPosType().

◆ SetYPosType()

void XFFrameStyle::SetYPosType	(	enumXFFrameYPos	pos,
		enumXFFrameYRel	rel
	)

inline

@descr Set vertical position type.

Definition at line 223 of file xfframestyle.hxx.

References m_eYPos, m_eYRel, and pos.

Referenced by LwpFrame::ApplyPosType().

◆ ToXml()

void XFFrameStyle::ToXml ( IXFStream * pStrm )

overridevirtual

Member Data Documentation

◆ m_aBackColor

XFColor XFFrameStyle::m_aBackColor

protected

Definition at line 158 of file xfframestyle.hxx.

Referenced by SetBackColor(), ToXml(), and XFImageStyle::ToXml().

◆ m_aMargins

XFMargins XFFrameStyle::m_aMargins

protected

Definition at line 153 of file xfframestyle.hxx.

Referenced by SetMargins(), ToXml(), and XFImageStyle::ToXml().

◆ m_aPad

XFPadding XFFrameStyle::m_aPad

protected

Definition at line 152 of file xfframestyle.hxx.

Referenced by SetPadding(), ToXml(), and XFImageStyle::ToXml().

◆ m_bProtectContent

bool XFFrameStyle::m_bProtectContent

protected

Definition at line 159 of file xfframestyle.hxx.

Referenced by SetProtect(), ToXml(), and XFImageStyle::ToXml().

◆ m_bProtectPos

bool XFFrameStyle::m_bProtectPos

protected

Definition at line 161 of file xfframestyle.hxx.

Referenced by SetProtect(), ToXml(), and XFImageStyle::ToXml().

◆ m_bProtectSize

bool XFFrameStyle::m_bProtectSize

protected

Definition at line 160 of file xfframestyle.hxx.

Referenced by SetProtect(), ToXml(), and XFImageStyle::ToXml().

◆ m_eTextDir

enumXFTextDir XFFrameStyle::m_eTextDir

protected

Definition at line 164 of file xfframestyle.hxx.

Referenced by SetTextDir(), and ToXml().

◆ m_eWrap

enumXFWrap XFFrameStyle::m_eWrap

protected

Definition at line 151 of file xfframestyle.hxx.

Referenced by SetWrapType(), ToXml(), and XFImageStyle::ToXml().

◆ m_eXPos

enumXFFrameXPos XFFrameStyle::m_eXPos

protected

Definition at line 165 of file xfframestyle.hxx.

Referenced by SetXPosType(), ToXml(), and XFImageStyle::ToXml().

◆ m_eXRel

enumXFFrameXRel XFFrameStyle::m_eXRel

protected

Definition at line 166 of file xfframestyle.hxx.

Referenced by SetXPosType(), ToXml(), and XFImageStyle::ToXml().

◆ m_eYPos

enumXFFrameYPos XFFrameStyle::m_eYPos

protected

Definition at line 167 of file xfframestyle.hxx.

Referenced by SetYPosType(), ToXml(), and XFImageStyle::ToXml().

◆ m_eYRel

enumXFFrameYRel XFFrameStyle::m_eYRel

protected

Definition at line 168 of file xfframestyle.hxx.

Referenced by SetYPosType(), ToXml(), and XFImageStyle::ToXml().

◆ m_nTransparency

sal_Int16 XFFrameStyle::m_nTransparency

protected

Definition at line 162 of file xfframestyle.hxx.

Referenced by SetTransparency(), and ToXml().

◆ m_pBGImage

std::unique_ptr<XFBGImage> XFFrameStyle::m_pBGImage

protected

Definition at line 157 of file xfframestyle.hxx.

Referenced by SetBackImage(), and ToXml().

◆ m_pBorders

std::unique_ptr<XFBorders> XFFrameStyle::m_pBorders

protected

Definition at line 154 of file xfframestyle.hxx.

Referenced by SetBorders(), ToXml(), and XFImageStyle::ToXml().

◆ m_pColumns

std::unique_ptr<XFColumns> XFFrameStyle::m_pColumns

protected

Definition at line 155 of file xfframestyle.hxx.

Referenced by SetColumns(), and ToXml().

◆ m_pShadow

std::unique_ptr<XFShadow> XFFrameStyle::m_pShadow

protected

Definition at line 156 of file xfframestyle.hxx.

Referenced by SetShadow(), ToXml(), and XFImageStyle::ToXml().

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ XFFrameStyle()

◆ ~XFFrameStyle()

Member Function Documentation

◆ GetStyleFamily()

◆ SetBackColor()

◆ SetBackImage()

◆ SetBorders()

◆ SetColumns()

◆ SetMargins()

◆ SetPadding()

◆ SetProtect()

◆ SetShadow()

◆ SetTextDir()

◆ SetTransparency()

◆ SetWrapType()

◆ SetXPosType()

◆ SetYPosType()

◆ ToXml()

Member Data Documentation

◆ m_aBackColor

◆ m_aMargins

◆ m_aPad

◆ m_bProtectContent

◆ m_bProtectPos

◆ m_bProtectSize

◆ m_eTextDir

◆ m_eWrap

◆ m_eXPos

◆ m_eXRel

◆ m_eYPos

◆ m_eYRel

◆ m_nTransparency

◆ m_pBGImage

◆ m_pBorders

◆ m_pColumns

◆ m_pShadow