LibreOffice Module oox (master) 1
Public Member Functions | Public Attributes | Protected Attributes | List of all members
oox::ole::ControlModelBase Class Referenceabstract

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

#include <axcontrol.hxx>

Inheritance diagram for oox::ole::ControlModelBase:
[legend]

Public Member Functions

 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...
 

Public Attributes

AxPairData maSize
 Size of the control in 1/100 mm. More...
 

Protected Attributes

bool mbAwtModel
 True = AWT control model, false = form component. More...
 

Detailed Description

Base class for all models of form controls.

Definition at line 346 of file axcontrol.hxx.

Constructor & Destructor Documentation

◆ ControlModelBase()

oox::ole::ControlModelBase::ControlModelBase ( )
explicit

Definition at line 581 of file axcontrol.cxx.

References maSize.

◆ ~ControlModelBase()

oox::ole::ControlModelBase::~ControlModelBase ( )
virtual

Definition at line 587 of file axcontrol.cxx.

Member Function Documentation

◆ convertFromProperties()

void oox::ole::ControlModelBase::convertFromProperties ( PropertySet &  rPropSet,
const ControlConverter &  rConv 
)
virtual

Derived classes convert from uno control properties to equiv.

MS values.

Reimplemented in oox::ole::AxFontDataModel, oox::ole::AxCommandButtonModel, oox::ole::AxLabelModel, oox::ole::AxMorphDataModelBase, oox::ole::AxToggleButtonModel, oox::ole::AxCheckBoxModel, oox::ole::AxOptionButtonModel, oox::ole::AxTextBoxModel, oox::ole::AxNumericFieldModel, oox::ole::AxListBoxModel, oox::ole::AxComboBoxModel, oox::ole::AxSpinButtonModel, and oox::ole::AxScrollBarModel.

Definition at line 646 of file axcontrol.cxx.

◆ convertProperties()

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

Derived classes convert all control properties.

Reimplemented in oox::ole::ComCtlModelBase, oox::ole::ComCtlScrollBarModel, oox::ole::ComCtlProgressBarModel, oox::ole::AxFontDataModel, oox::ole::AxCommandButtonModel, oox::ole::AxLabelModel, oox::ole::AxImageModel, oox::ole::AxMorphDataModelBase, oox::ole::AxToggleButtonModel, oox::ole::AxCheckBoxModel, oox::ole::AxOptionButtonModel, oox::ole::AxTextBoxModel, oox::ole::AxNumericFieldModel, oox::ole::AxListBoxModel, oox::ole::AxComboBoxModel, oox::ole::AxSpinButtonModel, oox::ole::AxScrollBarModel, oox::ole::AxContainerModelBase, oox::ole::AxFrameModel, oox::ole::AxPageModel, oox::ole::AxMultiPageModel, oox::ole::AxUserFormModel, and oox::ole::HtmlSelectModel.

Definition at line 642 of file axcontrol.cxx.

Referenced by oox::ole::ComCtlModelBase::convertProperties(), oox::ole::AxFontDataModel::convertProperties(), oox::ole::AxImageModel::convertProperties(), oox::ole::AxSpinButtonModel::convertProperties(), and oox::ole::AxScrollBarModel::convertProperties().

◆ convertSize()

void oox::ole::ControlModelBase::convertSize ( PropertyMap &  rPropMap,
const ControlConverter &  rConv 
) const

Converts the control size to UNO properties.

Definition at line 650 of file axcontrol.cxx.

References oox::ole::ControlConverter::convertSize(), and maSize.

◆ exportBinaryModel()

virtual void oox::ole::ControlModelBase::exportBinaryModel ( BinaryOutputStream &  )
inlinevirtual

Derived classes export a form control model to the passed output stream.

Reimplemented in oox::ole::AxFontDataModel, oox::ole::AxCommandButtonModel, oox::ole::AxLabelModel, oox::ole::AxImageModel, oox::ole::AxMorphDataModelBase, oox::ole::AxSpinButtonModel, and oox::ole::AxScrollBarModel.

Definition at line 368 of file axcontrol.hxx.

Referenced by oox::ole::OleFormCtrlExportHelper::exportControl().

◆ exportCompObj()

virtual void oox::ole::ControlModelBase::exportCompObj ( BinaryOutputStream &  )
inlinevirtual

Derived classes export CompObjStream contents.

Reimplemented in oox::ole::AxCommandButtonModel, oox::ole::AxLabelModel, oox::ole::AxImageModel, oox::ole::AxToggleButtonModel, oox::ole::AxCheckBoxModel, oox::ole::AxOptionButtonModel, oox::ole::AxTextBoxModel, oox::ole::AxNumericFieldModel, oox::ole::AxListBoxModel, oox::ole::AxComboBoxModel, oox::ole::AxSpinButtonModel, and oox::ole::AxScrollBarModel.

Definition at line 370 of file axcontrol.hxx.

Referenced by oox::ole::OleFormCtrlExportHelper::exportCompObj().

◆ getControlType()

virtual ApiControlType oox::ole::ControlModelBase::getControlType ( ) const
pure virtual

Derived classes return the UNO control type enum value.

Implemented in oox::ole::ComCtlScrollBarModel, oox::ole::ComCtlProgressBarModel, oox::ole::AxCommandButtonModel, oox::ole::AxLabelModel, oox::ole::AxImageModel, oox::ole::AxTabStripModel, oox::ole::AxToggleButtonModel, oox::ole::AxCheckBoxModel, oox::ole::AxOptionButtonModel, oox::ole::AxTextBoxModel, oox::ole::AxNumericFieldModel, oox::ole::AxListBoxModel, oox::ole::AxComboBoxModel, oox::ole::AxSpinButtonModel, oox::ole::AxScrollBarModel, oox::ole::AxFrameModel, oox::ole::AxPageModel, oox::ole::AxMultiPageModel, and oox::ole::AxUserFormModel.

Referenced by oox::ole::VbaFormControl::finalizeEmbeddedControls(), getServiceName(), oox::ole::VbaFormControl::importStorage(), and oox::ole::VbaFormControl::moveEmbeddedToAbsoluteParent().

◆ getServiceName()

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

Returns the UNO service name used to construct the AWT control model, or the control form component.

Definition at line 591 of file axcontrol.cxx.

References oox::ole::API_CONTROL_BUTTON, oox::ole::API_CONTROL_CHECKBOX, oox::ole::API_CONTROL_COMBOBOX, oox::ole::API_CONTROL_DIALOG, oox::ole::API_CONTROL_EDIT, oox::ole::API_CONTROL_FIXEDTEXT, oox::ole::API_CONTROL_FRAME, oox::ole::API_CONTROL_GROUPBOX, oox::ole::API_CONTROL_IMAGE, oox::ole::API_CONTROL_LISTBOX, oox::ole::API_CONTROL_MULTIPAGE, oox::ole::API_CONTROL_NUMERIC, oox::ole::API_CONTROL_PAGE, oox::ole::API_CONTROL_PROGRESSBAR, oox::ole::API_CONTROL_RADIOBUTTON, oox::ole::API_CONTROL_SCROLLBAR, oox::ole::API_CONTROL_SPINBUTTON, getControlType(), and mbAwtModel.

◆ importBinaryModel()

virtual bool oox::ole::ControlModelBase::importBinaryModel ( BinaryInputStream &  rInStrm)
pure virtual

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

Implemented in oox::ole::ComCtlModelBase, oox::ole::AxFontDataModel, oox::ole::AxCommandButtonModel, oox::ole::AxLabelModel, oox::ole::AxImageModel, oox::ole::AxTabStripModel, oox::ole::AxMorphDataModelBase, oox::ole::AxSpinButtonModel, oox::ole::AxScrollBarModel, oox::ole::AxContainerModelBase, oox::ole::HtmlSelectModel, and oox::ole::HtmlTextBoxModel.

◆ importPictureData()

void oox::ole::ControlModelBase::importPictureData ( sal_Int32  nPropId,
BinaryInputStream &  rInStrm 
)
virtual

Derived classes set binary data (picture, mouse icon) at the model structure.

Reimplemented in oox::ole::AxCommandButtonModel, oox::ole::AxImageModel, and oox::ole::AxMorphDataModelBase.

Definition at line 638 of file axcontrol.cxx.

Referenced by oox::ole::AxCommandButtonModel::importPictureData(), oox::ole::AxImageModel::importPictureData(), oox::ole::AxMorphDataModelBase::importPictureData(), and oox::ole::AxControlPropertyContext::onCreateContext().

◆ importProperty()

void oox::ole::ControlModelBase::importProperty ( sal_Int32  nPropId,
const OUString &  rValue 
)
virtual

Derived classes set specific OOXML properties at the model structure.

Reimplemented in oox::ole::AxControlModelBase, oox::ole::AxFontDataModel, oox::ole::AxCommandButtonModel, oox::ole::AxLabelModel, oox::ole::AxImageModel, oox::ole::AxMorphDataModelBase, oox::ole::AxSpinButtonModel, oox::ole::AxScrollBarModel, and oox::ole::AxContainerModelBase.

Definition at line 634 of file axcontrol.cxx.

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

◆ setAwtModelMode()

void oox::ole::ControlModelBase::setAwtModelMode ( )
inline

Sets this control model to AWT model mode.

Definition at line 353 of file axcontrol.hxx.

Referenced by oox::ole::AxContainerModelBase::AxContainerModelBase().

◆ setFormComponentMode()

void oox::ole::ControlModelBase::setFormComponentMode ( )
inline

Sets this control model to form component mode.

Definition at line 355 of file axcontrol.hxx.

Member Data Documentation

◆ maSize

AxPairData oox::ole::ControlModelBase::maSize

Size of the control in 1/100 mm.

Definition at line 382 of file axcontrol.hxx.

Referenced by oox::ole::AxContainerModelBase::AxContainerModelBase(), oox::ole::AxSpinButtonModel::convertProperties(), oox::ole::AxScrollBarModel::convertProperties(), convertSize(), oox::ole::AxCommandButtonModel::exportBinaryModel(), oox::ole::AxLabelModel::exportBinaryModel(), oox::ole::AxImageModel::exportBinaryModel(), oox::ole::AxMorphDataModelBase::exportBinaryModel(), oox::ole::AxSpinButtonModel::exportBinaryModel(), oox::ole::AxScrollBarModel::exportBinaryModel(), oox::ole::OleFormCtrlExportHelper::exportControl(), oox::ole::AxCommandButtonModel::importBinaryModel(), oox::ole::AxLabelModel::importBinaryModel(), oox::ole::AxImageModel::importBinaryModel(), oox::ole::AxTabStripModel::importBinaryModel(), oox::ole::AxMorphDataModelBase::importBinaryModel(), oox::ole::AxSpinButtonModel::importBinaryModel(), oox::ole::AxScrollBarModel::importBinaryModel(), oox::ole::AxContainerModelBase::importBinaryModel(), oox::ole::AxControlModelBase::importProperty(), and oox::ole::ComCtlModelBase::importSizePart().

◆ mbAwtModel

bool oox::ole::ControlModelBase::mbAwtModel
protected

True = AWT control model, false = form component.

Definition at line 385 of file axcontrol.hxx.

Referenced by oox::ole::AxTextBoxModel::convertFromProperties(), oox::ole::AxNumericFieldModel::convertFromProperties(), oox::ole::AxComboBoxModel::convertFromProperties(), oox::ole::AxSpinButtonModel::convertFromProperties(), oox::ole::AxScrollBarModel::convertFromProperties(), oox::ole::ComCtlScrollBarModel::convertProperties(), oox::ole::AxToggleButtonModel::convertProperties(), oox::ole::AxCheckBoxModel::convertProperties(), oox::ole::AxOptionButtonModel::convertProperties(), oox::ole::AxTextBoxModel::convertProperties(), oox::ole::AxNumericFieldModel::convertProperties(), oox::ole::AxComboBoxModel::convertProperties(), oox::ole::AxSpinButtonModel::convertProperties(), oox::ole::AxScrollBarModel::convertProperties(), oox::ole::AxFrameModel::getControlType(), and getServiceName().

The documentation for this class was generated from the following files:
Generated on Sun Jul 30 2023 04:44:32 for LibreOffice Module oox (master) by doxygen 1.9.3