oox::ole::EmbeddedControl Class Reference

A form control embedded in a document draw page. More...

#include <axcontrol.hxx>

Public Member Functions
	EmbeddedControl (OUString aName)
template<typename ModelType >
ModelType &	createModel ()
	Creates and returns the internal control model of the specified type. More...
template<typename ModelType , typename ParamType >
ModelType &	createModel (const ParamType &rParam)
	Creates and returns the internal control model of the specified type. More...
ControlModelBase *	createModelFromGuid (std::u16string_view rClassId)
	Creates and returns the internal control model according to the passed MS class identifier. More...
bool	hasModel () const
	Returns true, if the internal control model exists. More...
const ControlModelBase *	getModel () const
	Returns read-only access to the internal control model. More...
ControlModelBase *	getModel ()
	Returns read/write access to the internal control model. More...
OUString	getServiceName () const
	Returns the UNO service name needed to construct the control model. More...
bool	convertProperties (const css::uno::Reference< css::awt::XControlModel > &rxCtrlModel, const ControlConverter &rConv) const
	Converts all control properties and inserts them into the passed model. More...
void	convertFromProperties (const css::uno::Reference< css::awt::XControlModel > &rxCtrlModel, const ControlConverter &rConv)

Private Attributes
ControlModelRef	mxModel
	Control model containing the properties. More...
OUString	maName
	Name of the control. More...

Detailed Description

A form control embedded in a document draw page.

Contains a specific model structure according to the type of the control.

Definition at line 897 of file axcontrol.hxx.

Constructor & Destructor Documentation

EmbeddedControl()

oox::ole::EmbeddedControl::EmbeddedControl ( OUString  aName )

explicit

Definition at line 2658 of file axcontrol.cxx.

References aName.

Member Function Documentation

convertFromProperties()

void oox::ole::EmbeddedControl::convertFromProperties	(	const css::uno::Reference< css::awt::XControlModel > &	rxCtrlModel,
		const ControlConverter &	rConv
	)

Definition at line 2712 of file axcontrol.cxx.

References oox::PropertySet::getProperty(), maName, and mxModel.

convertProperties()

bool oox::ole::EmbeddedControl::convertProperties	(	const css::uno::Reference< css::awt::XControlModel > &	rxCtrlModel,
		const ControlConverter &	rConv
	)		const

Converts all control properties and inserts them into the passed model.

Definition at line 2690 of file axcontrol.cxx.

References Exception, maName, mxModel, oox::PropertySet::setProperties(), oox::PropertyMap::setProperty(), and TOOLS_WARN_EXCEPTION.

Referenced by oox::ole::EmbeddedForm::convertAndInsert().

createModel() [1/2]

template<typename ModelType >

ModelType & oox::ole::EmbeddedControl::createModel

inline

Creates and returns the internal control model of the specified type.

Definition at line 940 of file axcontrol.hxx.

References mxModel, and xModel.

createModel() [2/2]

template<typename ModelType , typename ParamType >

ModelType & oox::ole::EmbeddedControl::createModel ( const ParamType &  rParam )

inline

Creates and returns the internal control model of the specified type.

Definition at line 949 of file axcontrol.hxx.

References mxModel, and xModel.

createModelFromGuid()

ControlModelBase * oox::ole::EmbeddedControl::createModelFromGuid

(

std::u16string_view

rClassId

)

Creates and returns the internal control model according to the passed MS class identifier.

Definition at line 2663 of file axcontrol.cxx.

References AX_GUID_CHECKBOX, AX_GUID_COMBOBOX, AX_GUID_COMMANDBUTTON, AX_GUID_FRAME, AX_GUID_IMAGE, AX_GUID_LABEL, AX_GUID_LISTBOX, AX_GUID_OPTIONBUTTON, AX_GUID_SCROLLBAR, AX_GUID_SPINBUTTON, AX_GUID_TEXTBOX, AX_GUID_TOGGLEBUTTON, COMCTL_GUID_SCROLLBAR_60, oox::ole::COMCTL_VERSION_60, o3tl::equalsIgnoreAsciiCase(), HTML_GUID_SELECT, HTML_GUID_TEXTBOX, mxModel, and u.

Referenced by oox::ole::AxControlFragment::onCreateContext().

getModel() [1/2]

ControlModelBase * oox::ole::EmbeddedControl::getModel ( )

inline

Returns read/write access to the internal control model.

Definition at line 919 of file axcontrol.hxx.

References mxModel.

getModel() [2/2]

const ControlModelBase * oox::ole::EmbeddedControl::getModel ( ) const

inline

Returns read-only access to the internal control model.

Definition at line 917 of file axcontrol.hxx.

References mxModel.

getServiceName()

OUString oox::ole::EmbeddedControl::getServiceName

(

)

const

Returns the UNO service name needed to construct the control model.

Definition at line 2685 of file axcontrol.cxx.

References mxModel.

Referenced by oox::ole::EmbeddedForm::convertAndInsert().

hasModel()

bool oox::ole::EmbeddedControl::hasModel ( ) const

inline

Returns true, if the internal control model exists.

Definition at line 915 of file axcontrol.hxx.

References mxModel.

Referenced by oox::ole::EmbeddedForm::convertAndInsert().

Member Data Documentation

maName

OUString oox::ole::EmbeddedControl::maName

private

Name of the control.

Definition at line 935 of file axcontrol.hxx.

Referenced by convertFromProperties(), and convertProperties().

mxModel

ControlModelRef oox::ole::EmbeddedControl::mxModel

private

Control model containing the properties.

Definition at line 934 of file axcontrol.hxx.

Referenced by convertFromProperties(), convertProperties(), createModel(), createModelFromGuid(), and getServiceName().

---

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

• axcontrol.hxx
• axcontrol.cxx