Base class for all models of ComCtl form controls. More...

#include <axcontrol.hxx>

Inheritance diagram for oox::ole::ComCtlModelBase:

Collaboration diagram for oox::ole::ComCtlModelBase:

Public Member Functions
	ComCtlModelBase (sal_uInt32 nDataPartId5, sal_uInt32 nDataPartId6, sal_uInt16 nVersion)

virtual bool	importBinaryModel (BinaryInputStream &rInStrm) override
	Derived classes import a form control model from the passed input stream. More...

virtual void	convertProperties (PropertyMap &rPropMap, const ControlConverter &rConv) const override
	Derived classes convert all control properties. More...

Public Member Functions inherited from oox::ole::ControlModelBase
	ControlModelBase ()

virtual	~ControlModelBase ()

void	setAwtModelMode ()
	Sets this control model to AWT model mode. More...

void	setFormComponentMode ()
	Sets this control model to form component mode. More...

OUString	getServiceName () const
	Returns the UNO service name used to construct the AWT control model, or the control form component. More...

virtual void	importProperty (sal_Int32 nPropId, const OUString &rValue)
	Derived classes set specific OOXML properties at the model structure. More...

virtual void	importPictureData (sal_Int32 nPropId, BinaryInputStream &rInStrm)
	Derived classes set binary data (picture, mouse icon) at the model structure. More...

virtual bool	importBinaryModel (BinaryInputStream &rInStrm)=0
	Derived classes import a form control model from the passed input stream. More...

virtual void	exportBinaryModel (BinaryOutputStream &)
	Derived classes export a form control model to the passed output stream. More...

virtual void	exportCompObj (BinaryOutputStream &)
	Derived classes export CompObjStream contents. More...

virtual ApiControlType	getControlType () const =0
	Derived classes return the UNO control type enum value. More...

virtual void	convertProperties (PropertyMap &rPropMap, const ControlConverter &rConv) const
	Derived classes convert all control properties. More...

virtual void	convertFromProperties (PropertySet &rPropSet, const ControlConverter &rConv)
	Derived classes convert from uno control properties to equiv. More...

void	convertSize (PropertyMap &rPropMap, const ControlConverter &rConv) const
	Converts the control size to UNO properties. More...

Protected Member Functions
virtual void	importControlData (BinaryInputStream &rInStrm)=0

Protected Attributes
StdFontInfo	maFontData
	Font formatting. More...

StreamDataSequence	maMouseIcon
	Binary picture stream for mouse icon. More...

sal_uInt32	mnFlags
	Common flags for ComCtl controls. More...

const sal_uInt16	mnVersion
	Current version of the ComCtl control model. More...

Protected Attributes inherited from oox::ole::ControlModelBase
bool	mbAwtModel
	True = AWT control model, false = form component. More...

Private Member Functions
sal_uInt32	getDataPartId () const
	Returns the data part identifier according to the model version. More...

bool	importSizePart (BinaryInputStream &rInStrm)

bool	importCommonPart (BinaryInputStream &rInStrm, sal_uInt32 nPartSize)

bool	importComplexPart (BinaryInputStream &rInStrm)

Static Private Member Functions
static bool	readPartHeader (BinaryInputStream &rInStrm, sal_uInt32 nExpPartId, sal_uInt16 nExpMajor=SAL_MAX_UINT16, sal_uInt16 nExpMinor=SAL_MAX_UINT16)

Private Attributes
sal_uInt32	mnDataPartId5
	Identifier for version 5.0 control data. More...

sal_uInt32	mnDataPartId6
	Identifier for version 6.0 control data. More...

bool	mbCommonPart
	True = the COMCTL_COMMONDATA part exists. More...

bool	mbComplexPart
	True = the COMCTL_COMPLEXDATA part exists. More...

Additional Inherited Members
Public Attributes inherited from oox::ole::ControlModelBase
AxPairData	maSize
	Size of the control in 1/100 mm. More...

Detailed Description

Base class for all models of ComCtl form controls.

Definition at line 392 of file axcontrol.hxx.

Constructor & Destructor Documentation

◆ ComCtlModelBase()

oox::ole::ComCtlModelBase::ComCtlModelBase	(	sal_uInt32	nDataPartId5,
		sal_uInt32	nDataPartId6,
		sal_uInt16	nVersion
	)

explicit

Definition at line 655 of file axcontrol.cxx.

References mnFlags, and nVersion.

Member Function Documentation

◆ convertProperties()

void oox::ole::ComCtlModelBase::convertProperties	(	PropertyMap &	rPropMap,
		const ControlConverter &	rConv
	)		const

overridevirtual

Derived classes convert all control properties.

Reimplemented from oox::ole::ControlModelBase.

Reimplemented in oox::ole::ComCtlScrollBarModel, and oox::ole::ComCtlProgressBarModel.

Definition at line 689 of file axcontrol.cxx.

References oox::ole::ControlModelBase::convertProperties(), oox::getFlag(), mbCommonPart, mnFlags, and oox::PropertyMap::setProperty().

Referenced by oox::ole::ComCtlScrollBarModel::convertProperties(), and oox::ole::ComCtlProgressBarModel::convertProperties().

◆ getDataPartId()

sal_uInt32 oox::ole::ComCtlModelBase::getDataPartId ( ) const

private

Returns the data part identifier according to the model version.

Definition at line 696 of file axcontrol.cxx.

References oox::ole::COMCTL_VERSION_50, oox::ole::COMCTL_VERSION_60, mnDataPartId5, mnDataPartId6, mnVersion, and SAL_MAX_UINT32.

Referenced by importBinaryModel().

◆ importBinaryModel()

bool oox::ole::ComCtlModelBase::importBinaryModel ( BinaryInputStream & rInStrm )

overridevirtual

Derived classes import a form control model from the passed input stream.

Implements oox::ole::ControlModelBase.

Definition at line 667 of file axcontrol.cxx.

References getDataPartId(), importCommonPart(), importComplexPart(), importControlData(), importSizePart(), oox::BinaryStreamBase::isEof(), mbCommonPart, mbComplexPart, mnVersion, readPartHeader(), and oox::BinaryInputStream::readuInt32().

◆ importCommonPart()

bool oox::ole::ComCtlModelBase::importCommonPart	(	BinaryInputStream &	rInStrm,
		sal_uInt32	nPartSize
	)

private

Definition at line 731 of file axcontrol.cxx.

References oox::BinaryStreamBase::isEof(), mnFlags, readPartHeader(), oox::BinaryInputStream::readuInt32(), oox::BinaryStreamBase::seek(), oox::BinaryInputStream::skip(), and oox::BinaryStreamBase::tell().

Referenced by importBinaryModel().

◆ importComplexPart()

bool oox::ole::ComCtlModelBase::importComplexPart ( BinaryInputStream & rInStrm )

private

Definition at line 744 of file axcontrol.cxx.

References oox::getFlag(), oox::ole::OleHelper::importStdFont(), oox::ole::OleHelper::importStdPic(), oox::BinaryStreamBase::isEof(), maFontData, maMouseIcon, readPartHeader(), and oox::BinaryInputStream::readuInt32().

Referenced by importBinaryModel().

◆ importControlData()

virtual void oox::ole::ComCtlModelBase::importControlData ( BinaryInputStream & rInStrm )

protectedpure virtual

Implemented in oox::ole::ComCtlScrollBarModel, and oox::ole::ComCtlProgressBarModel.

Referenced by importBinaryModel().

◆ importSizePart()

bool oox::ole::ComCtlModelBase::importSizePart ( BinaryInputStream & rInStrm )

private

Definition at line 720 of file axcontrol.cxx.

References oox::BinaryStreamBase::isEof(), oox::ole::ControlModelBase::maSize, oox::BinaryInputStream::readInt32(), and readPartHeader().

Referenced by importBinaryModel().

◆ readPartHeader()

bool oox::ole::ComCtlModelBase::readPartHeader	(	BinaryInputStream &	rInStrm,
		sal_uInt32	nExpPartId,
		sal_uInt16	nExpMajor = `SAL_MAX_UINT16`,
		sal_uInt16	nExpMinor = `SAL_MAX_UINT16`
	)

staticprivate

Definition at line 707 of file axcontrol.cxx.

References oox::BinaryStreamBase::isEof(), oox::BinaryInputStream::readuInt16(), oox::BinaryInputStream::readuInt32(), and SAL_MAX_UINT16.

Referenced by importBinaryModel(), importCommonPart(), importComplexPart(), and importSizePart().

Member Data Documentation

◆ maFontData

StdFontInfo oox::ole::ComCtlModelBase::maFontData

protected

Font formatting.

Definition at line 418 of file axcontrol.hxx.

Referenced by importComplexPart().

◆ maMouseIcon

StreamDataSequence oox::ole::ComCtlModelBase::maMouseIcon

protected

Binary picture stream for mouse icon.

Definition at line 419 of file axcontrol.hxx.

Referenced by importComplexPart().

◆ mbCommonPart

bool oox::ole::ComCtlModelBase::mbCommonPart

private

True = the COMCTL_COMMONDATA part exists.

Definition at line 426 of file axcontrol.hxx.

Referenced by convertProperties(), and importBinaryModel().

◆ mbComplexPart

bool oox::ole::ComCtlModelBase::mbComplexPart

private

True = the COMCTL_COMPLEXDATA part exists.

Definition at line 427 of file axcontrol.hxx.

Referenced by importBinaryModel().

◆ mnDataPartId5

sal_uInt32 oox::ole::ComCtlModelBase::mnDataPartId5

private

Identifier for version 5.0 control data.

Definition at line 424 of file axcontrol.hxx.

Referenced by getDataPartId().

◆ mnDataPartId6

sal_uInt32 oox::ole::ComCtlModelBase::mnDataPartId6

private

Identifier for version 6.0 control data.

Definition at line 425 of file axcontrol.hxx.

Referenced by getDataPartId().

◆ mnFlags

sal_uInt32 oox::ole::ComCtlModelBase::mnFlags

protected

Common flags for ComCtl controls.

Definition at line 420 of file axcontrol.hxx.

Referenced by convertProperties(), oox::ole::ComCtlProgressBarModel::convertProperties(), and importCommonPart().

◆ mnVersion

const sal_uInt16 oox::ole::ComCtlModelBase::mnVersion

protected

Current version of the ComCtl control model.

Definition at line 421 of file axcontrol.hxx.

Referenced by getDataPartId(), importBinaryModel(), and oox::ole::ComCtlProgressBarModel::importControlData().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ComCtlModelBase()

Member Function Documentation

◆ convertProperties()

◆ getDataPartId()

◆ importBinaryModel()

◆ importCommonPart()

◆ importComplexPart()

◆ importControlData()

◆ importSizePart()

◆ readPartHeader()

Member Data Documentation

◆ maFontData

◆ maMouseIcon

◆ mbCommonPart

◆ mbComplexPart

◆ mnDataPartId5

◆ mnDataPartId6

◆ mnFlags

◆ mnVersion