LibreOffice Module sc (master): XclImpControlHelper Class Reference

LibreOffice Module sc (master) 1

Helper base class for TBX and OCX form controls to manage spreadsheet links. More...

#include <xiescher.hxx>

Inheritance diagram for XclImpControlHelper:

Collaboration diagram for XclImpControlHelper:

Public Member Functions
	XclImpControlHelper (const XclImpRoot &rRoot, XclCtrlBindMode eBindMode)

virtual	~XclImpControlHelper ()

bool	HasCellLink () const
	Returns true, if a linked cell address is present. More...

rtl::Reference< SdrObject >	CreateSdrObjectFromShape (const css::uno::Reference< css::drawing::XShape > &rxShape, const tools::Rectangle &rAnchorRect) const
	Returns the SdrObject from the passed control shape and sets the bounding rectangle. More...

void	ProcessControl (const XclImpDrawObjBase &rDrawObj) const
	Sets additional properties to the form control model, calls virtual DoProcessControl(). More...

Protected Member Functions
void	ReadCellLinkFormula (XclImpStream &rStrm, bool bWithBoundSize)
	Reads the formula for the linked cell from the current position of the stream. More...

void	ReadSourceRangeFormula (XclImpStream &rStrm, bool bWithBoundSize)
	Reads the formula for the source range from the current position of the stream. More...

virtual void	DoProcessControl (ScfPropertySet &rPropSet) const
	Derived classes will set additional properties for the current form control. More...

void	ApplySheetLinkProps () const

Protected Attributes
css::uno::Reference< css::drawing::XShape >	mxShape

std::shared_ptr< ScAddress >	mxCellLink
	The UNO wrapper of the control shape. More...

Private Member Functions
void	ReadRangeList (ScRangeList &rScRanges, XclImpStream &rStrm)
	Linked cell in the Calc document. More...

void	ReadRangeList (ScRangeList &rScRanges, XclImpStream &rStrm, bool bWithBoundSize)
	Reads leading formula size and a list of cell ranges from a formula if the leading size is not zero. More...

Private Attributes
const XclImpRoot &	mrRoot

std::shared_ptr< ScRange >	mxSrcRange
	Not derived from XclImpRoot to allow multiple inheritance. More...

XclCtrlBindMode	meBindMode
	Source data range in the Calc document. More...

Detailed Description

Helper base class for TBX and OCX form controls to manage spreadsheet links.

Definition at line 457 of file xiescher.hxx.

Constructor & Destructor Documentation

◆ XclImpControlHelper()

XclImpControlHelper::XclImpControlHelper	(	const XclImpRoot &	rRoot,
		XclCtrlBindMode	eBindMode
	)

explicit

Definition at line 1876 of file xiescher.cxx.

◆ ~XclImpControlHelper()

XclImpControlHelper::~XclImpControlHelper ( )

virtual

Definition at line 1882 of file xiescher.cxx.

Member Function Documentation

◆ ApplySheetLinkProps()

void XclImpControlHelper::ApplySheetLinkProps ( ) const

protected

◆ CreateSdrObjectFromShape()

rtl::Reference< SdrObject > XclImpControlHelper::CreateSdrObjectFromShape	(	const css::uno::Reference< css::drawing::XShape > &	rxShape,
		const tools::Rectangle &	rAnchorRect
	)		const

Returns the SdrObject from the passed control shape and sets the bounding rectangle.

Definition at line 1886 of file xiescher.cxx.

References SdrObject::getSdrObjectFromXShape(), mxShape, and SC_LAYER_CONTROLS().

Referenced by XclImpDffConverter::CreateSdrObject().

◆ DoProcessControl()

void XclImpControlHelper::DoProcessControl ( ScfPropertySet & rPropSet ) const

protectedvirtual

Derived classes will set additional properties for the current form control.

Reimplemented in XclImpButtonObj, XclImpCheckBoxObj, XclImpOptionButtonObj, XclImpLabelObj, XclImpGroupBoxObj, XclImpDialogObj, XclImpEditObj, XclImpSpinButtonObj, XclImpScrollBarObj, XclImpListBoxObj, and XclImpDropDownObj.

Definition at line 2019 of file xiescher.cxx.

Referenced by ProcessControl().

◆ HasCellLink()

bool XclImpControlHelper::HasCellLink ( ) const

inline

Returns true, if a linked cell address is present.

Definition at line 464 of file xiescher.hxx.

References mxCellLink.

Referenced by XclImpOptionButtonObj::DoProcessControl(), XclImpListBoxObj::DoProcessControl(), and XclImpDropDownObj::DoProcessControl().

◆ ProcessControl()

void XclImpControlHelper::ProcessControl ( const XclImpDrawObjBase & rDrawObj ) const

Sets additional properties to the form control model, calls virtual DoProcessControl().

Definition at line 1974 of file xiescher.cxx.

References ApplySheetLinkProps(), DoProcessControl(), XclControlHelper::GetControlModel(), XclImpDrawObjBase::GetObjName(), XclImpDrawObjBase::IsPrintable(), XclImpDrawObjBase::IsVisible(), mxShape, ScfPropertySet::SetBoolProperty(), and ScfPropertySet::SetStringProperty().

Referenced by XclImpTbxObjBase::DoPreProcessSdrObj(), and XclImpPictureObj::DoPreProcessSdrObj().

◆ ReadCellLinkFormula()

void XclImpControlHelper::ReadCellLinkFormula	(	XclImpStream &	rStrm,
		bool	bWithBoundSize
	)

protected

Reads the formula for the linked cell from the current position of the stream.

Definition at line 1995 of file xiescher.cxx.

References ScRange::aStart, ScRangeList::empty(), ScRangeList::front(), mxCellLink, ReadRangeList(), and rStrm.

Referenced by XclImpCheckBoxObj::DoReadObj5(), XclImpOptionButtonObj::DoReadObj5(), XclImpSpinButtonObj::DoReadObj5(), XclImpScrollBarObj::DoReadObj5(), XclImpListBoxObj::DoReadObj5(), XclImpDropDownObj::DoReadObj5(), XclImpCheckBoxObj::DoReadObj8SubRec(), XclImpTbxObjScrollableBase::DoReadObj8SubRec(), and XclImpPictureObj::ReadPictFmla().

◆ ReadRangeList() [1/2]

void XclImpControlHelper::ReadRangeList	(	ScRangeList &	rScRanges,
		XclImpStream &	rStrm
	)

private

Linked cell in the Calc document.

Reads a list of cell ranges from a formula at the current stream position.

Definition at line 2023 of file xiescher.cxx.

References XclImpFormulaCompiler::CreateRangeList(), EXC_FMLATYPE_CONTROL, XclImpRoot::GetFormulaCompiler(), mrRoot, XclTokenArray::ReadArray(), XclTokenArray::ReadSize(), and rStrm.

Referenced by ReadCellLinkFormula(), ReadRangeList(), and ReadSourceRangeFormula().

◆ ReadRangeList() [2/2]

void XclImpControlHelper::ReadRangeList	(	ScRangeList &	rScRanges,
		XclImpStream &	rStrm,
		bool	bWithBoundSize
	)

private

Reads leading formula size and a list of cell ranges from a formula if the leading size is not zero.

Definition at line 2032 of file xiescher.cxx.

References ReadRangeList(), and rStrm.

◆ ReadSourceRangeFormula()

void XclImpControlHelper::ReadSourceRangeFormula	(	XclImpStream &	rStrm,
		bool	bWithBoundSize
	)

protected

Reads the formula for the source range from the current position of the stream.

Definition at line 2007 of file xiescher.cxx.

References ScRangeList::empty(), ScRangeList::front(), mxSrcRange, ReadRangeList(), and rStrm.

Referenced by XclImpTbxObjListBase::ReadLbsData(), and XclImpPictureObj::ReadPictFmla().

Member Data Documentation

◆ meBindMode

XclCtrlBindMode XclImpControlHelper::meBindMode

private

Source data range in the Calc document.

Definition at line 496 of file xiescher.hxx.

Referenced by ApplySheetLinkProps().

◆ mrRoot

const XclImpRoot& XclImpControlHelper::mrRoot

private

Definition at line 494 of file xiescher.hxx.

Referenced by ApplySheetLinkProps(), and ReadRangeList().

◆ mxCellLink

std::shared_ptr< ScAddress > XclImpControlHelper::mxCellLink

protected

The UNO wrapper of the control shape.

Definition at line 486 of file xiescher.hxx.

Referenced by ApplySheetLinkProps(), XclImpOptionButtonObj::DoProcessControl(), HasCellLink(), and ReadCellLinkFormula().

◆ mxShape

css::uno::Reference< css::drawing::XShape > XclImpControlHelper::mxShape

mutableprotected

Definition at line 485 of file xiescher.hxx.

Referenced by ApplySheetLinkProps(), XclImpTbxObjBase::ConvertLabel(), CreateSdrObjectFromShape(), XclImpOptionButtonObj::DoProcessControl(), and ProcessControl().

◆ mxSrcRange

std::shared_ptr< ScRange > XclImpControlHelper::mxSrcRange

private

Not derived from XclImpRoot to allow multiple inheritance.

Definition at line 495 of file xiescher.hxx.

Referenced by ApplySheetLinkProps(), and ReadSourceRangeFormula().

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