LibreOffice Module oox (master)  1
Public Member Functions | Private Attributes | List of all members
oox::ole::EmbeddedControl Class Reference

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

#include <axcontrol.hxx>

Public Member Functions

 EmbeddedControl (const OUString &rName)
 
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...
 
ControlModelBasecreateModelFromGuid (const OUString &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 ControlModelBasegetModel () const
 Returns read-only access to the internal control model. More...
 
ControlModelBasegetModel ()
 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

oox::ole::EmbeddedControl::EmbeddedControl ( const OUString &  rName)
explicit

Definition at line 2656 of file axcontrol.cxx.

Member Function Documentation

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

Definition at line 2710 of file axcontrol.cxx.

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

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 2688 of file axcontrol.cxx.

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

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

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.

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.

ControlModelBase * oox::ole::EmbeddedControl::createModelFromGuid ( const OUString &  rClassId)
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.

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.

OUString oox::ole::EmbeddedControl::getServiceName ( ) const

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

Definition at line 2683 of file axcontrol.cxx.

References mxModel.

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

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

OUString oox::ole::EmbeddedControl::maName
private

Name of the control.

Definition at line 935 of file axcontrol.hxx.

Referenced by convertFromProperties(), and convertProperties().

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: