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

Common properties for all controls that are part of a VBA user form or of another container control in a VBA user form. More...

#include <vbacontrol.hxx>

Public Member Functions

 VbaSiteModel ()
 
 ~VbaSiteModel ()
 
void importProperty (sal_Int32 nPropId, const OUString &rValue)
 Allows to set single properties specified by XML token identifier. More...
 
bool importBinaryModel (BinaryInputStream &rInStrm)
 Imports the site model data from the passed input stream. More...
 
void moveRelative (const AxPairData &rDistance)
 Moves the control relative to its current position by the passed distance. More...
 
const OUString & getName () const
 Returns the programmatical name of the control. More...
 
const AxPairDatagetPosition () const
 Returns the position of the control in its parent. More...
 
sal_Int32 getId () const
 Returns the unique identifier of this control. More...
 
bool isContainer () const
 Returns true, if this control is a container control. More...
 
sal_uInt32 getStreamLength () const
 Returns the length of the stream data for stream based controls. More...
 
OUString getSubStorageName () const
 Returns the name of the substorage for the container control data. More...
 
sal_Int16 getTabIndex () const
 Returns the tab index of the control. More...
 
ControlModelRef createControlModel (const AxClassTable &rClassTable) const
 Tries to create the control model according to the site model. More...
 
void convertProperties (PropertyMap &rPropMap, const ControlConverter &rConv, ApiControlType eCtrlType, sal_Int32 nCtrlIndex) const
 Converts all form site properties. More...
 
const OUString & getControlSource () const
 
const OUString & getRowSource () const
 

Private Attributes

OUString maName
 Name of the control. More...
 
OUString maTag
 User defined tag. More...
 
OUString maToolTip
 Tool tip for the control. More...
 
OUString maControlSource
 Linked cell for the control value in a spreadsheet. More...
 
OUString maRowSource
 Source data for the control in a spreadsheet. More...
 
AxPairData maPos
 Position in parent container. More...
 
sal_Int32 mnId
 Control identifier. More...
 
sal_Int32 mnHelpContextId
 Help context identifier. More...
 
sal_uInt32 mnFlags
 Various flags. More...
 
sal_uInt32 mnStreamLen
 Size of control stream data. More...
 
sal_Int16 mnTabIndex
 Tab order index. More...
 
sal_uInt16 mnClassIdOrCache
 Class name identifier or GUID cache index. More...
 
sal_uInt16 mnGroupId
 Group identifier for grouped controls. More...
 

Detailed Description

Common properties for all controls that are part of a VBA user form or of another container control in a VBA user form.

Definition at line 52 of file vbacontrol.hxx.

Constructor & Destructor Documentation

oox::ole::VbaSiteModel::VbaSiteModel ( )
explicit

Definition at line 161 of file vbacontrol.cxx.

References mnFlags.

oox::ole::VbaSiteModel::~VbaSiteModel ( )

Definition at line 173 of file vbacontrol.cxx.

Member Function Documentation

void oox::ole::VbaSiteModel::convertProperties ( PropertyMap rPropMap,
const ControlConverter rConv,
ApiControlType  eCtrlType,
sal_Int32  nCtrlIndex 
) const
ControlModelRef oox::ole::VbaSiteModel::createControlModel ( const AxClassTable rClassTable) const

Tries to create the control model according to the site model.

Definition at line 238 of file vbacontrol.cxx.

References COMCTL_GUID_PROGRESSBAR_50, COMCTL_GUID_PROGRESSBAR_60, COMCTL_GUID_SCROLLBAR_60, oox::getFlag(), oox::ContainerHelper::getVectorElement(), isContainer(), and mnClassIdOrCache.

const OUString& oox::ole::VbaSiteModel::getControlSource ( ) const
inline

Definition at line 88 of file vbacontrol.hxx.

References maControlSource.

sal_Int32 oox::ole::VbaSiteModel::getId ( ) const
inline

Returns the unique identifier of this control.

Definition at line 70 of file vbacontrol.hxx.

References mnId.

const OUString& oox::ole::VbaSiteModel::getName ( ) const
inline

Returns the programmatical name of the control.

Definition at line 66 of file vbacontrol.hxx.

References maName.

const AxPairData& oox::ole::VbaSiteModel::getPosition ( ) const
inline

Returns the position of the control in its parent.

Definition at line 68 of file vbacontrol.hxx.

References maPos.

const OUString& oox::ole::VbaSiteModel::getRowSource ( ) const
inline

Definition at line 89 of file vbacontrol.hxx.

References maRowSource.

sal_uInt32 oox::ole::VbaSiteModel::getStreamLength ( ) const

Returns the length of the stream data for stream based controls.

Definition at line 219 of file vbacontrol.cxx.

References isContainer(), and mnStreamLen.

OUString oox::ole::VbaSiteModel::getSubStorageName ( ) const

Returns the name of the substorage for the container control data.

Definition at line 224 of file vbacontrol.cxx.

References aBuffer, and mnId.

sal_Int16 oox::ole::VbaSiteModel::getTabIndex ( ) const
inline

Returns the tab index of the control.

Definition at line 78 of file vbacontrol.hxx.

References mnTabIndex.

bool oox::ole::VbaSiteModel::importBinaryModel ( BinaryInputStream rInStrm)
void oox::ole::VbaSiteModel::importProperty ( sal_Int32  nPropId,
const OUString &  rValue 
)

Allows to set single properties specified by XML token identifier.

Definition at line 177 of file vbacontrol.cxx.

References oox::AttributeConversion::decodeUnsigned(), maName, maTag, and mnFlags.

bool oox::ole::VbaSiteModel::isContainer ( ) const

Returns true, if this control is a container control.

Definition at line 214 of file vbacontrol.cxx.

References oox::getFlag(), and mnFlags.

Referenced by createControlModel(), and getStreamLength().

void oox::ole::VbaSiteModel::moveRelative ( const AxPairData rDistance)

Moves the control relative to its current position by the passed distance.

Definition at line 208 of file vbacontrol.cxx.

References maPos.

Member Data Documentation

OUString oox::ole::VbaSiteModel::maControlSource
private

Linked cell for the control value in a spreadsheet.

Definition at line 94 of file vbacontrol.hxx.

Referenced by getControlSource(), and importBinaryModel().

OUString oox::ole::VbaSiteModel::maName
private

Name of the control.

Definition at line 91 of file vbacontrol.hxx.

Referenced by convertProperties(), getName(), importBinaryModel(), and importProperty().

AxPairData oox::ole::VbaSiteModel::maPos
private

Position in parent container.

Definition at line 97 of file vbacontrol.hxx.

Referenced by convertProperties(), getPosition(), importBinaryModel(), and moveRelative().

OUString oox::ole::VbaSiteModel::maRowSource
private

Source data for the control in a spreadsheet.

Definition at line 95 of file vbacontrol.hxx.

Referenced by getRowSource(), and importBinaryModel().

OUString oox::ole::VbaSiteModel::maTag
private

User defined tag.

Definition at line 92 of file vbacontrol.hxx.

Referenced by convertProperties(), importBinaryModel(), and importProperty().

OUString oox::ole::VbaSiteModel::maToolTip
private

Tool tip for the control.

Definition at line 93 of file vbacontrol.hxx.

Referenced by convertProperties(), and importBinaryModel().

sal_uInt16 oox::ole::VbaSiteModel::mnClassIdOrCache
private

Class name identifier or GUID cache index.

Definition at line 103 of file vbacontrol.hxx.

Referenced by createControlModel(), and importBinaryModel().

sal_uInt32 oox::ole::VbaSiteModel::mnFlags
private

Various flags.

Definition at line 100 of file vbacontrol.hxx.

Referenced by convertProperties(), importBinaryModel(), importProperty(), and isContainer().

sal_uInt16 oox::ole::VbaSiteModel::mnGroupId
private

Group identifier for grouped controls.

Definition at line 104 of file vbacontrol.hxx.

Referenced by importBinaryModel().

sal_Int32 oox::ole::VbaSiteModel::mnHelpContextId
private

Help context identifier.

Definition at line 99 of file vbacontrol.hxx.

Referenced by importBinaryModel().

sal_Int32 oox::ole::VbaSiteModel::mnId
private

Control identifier.

Definition at line 98 of file vbacontrol.hxx.

Referenced by getId(), getSubStorageName(), and importBinaryModel().

sal_uInt32 oox::ole::VbaSiteModel::mnStreamLen
private

Size of control stream data.

Definition at line 101 of file vbacontrol.hxx.

Referenced by getStreamLength(), and importBinaryModel().

sal_Int16 oox::ole::VbaSiteModel::mnTabIndex
private

Tab order index.

Definition at line 102 of file vbacontrol.hxx.

Referenced by getTabIndex(), and importBinaryModel().


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