LibreOffice Module toolkit (master) 1
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Types | Friends | List of all members
ControlModelContainerBase Class Reference

#include <controlmodelcontainerbase.hxx>

Inheritance diagram for ControlModelContainerBase:
[legend]
Collaboration diagram for ControlModelContainerBase:
[legend]

Public Types

enum  ChildOperation {
  Insert = 0 ,
  Remove
}
 
typedef ::std::pair< css::uno::Reference< css::awt::XControlModel >, OUString > UnoControlModelHolder
 
typedef ::std::vector< css::uno::Reference< css::awt::XControlModel > > ModelGroup
 
typedef ::std::vector< ModelGroupAllGroups
 

Public Member Functions

 ControlModelContainerBase (const css::uno::Reference< css::uno::XComponentContext > &rxContext)
 
 ControlModelContainerBase (const ControlModelContainerBase &rModel)
 
virtual ~ControlModelContainerBase () override
 
rtl::Reference< UnoControlModelClone () const override
 
void SAL_CALL addContainerListener (const css::uno::Reference< css::container::XContainerListener > &xListener) override
 
void SAL_CALL removeContainerListener (const css::uno::Reference< css::container::XContainerListener > &xListener) override
 
css::uno::Type SAL_CALL getElementType () override
 
sal_Bool SAL_CALL hasElements () override
 
void SAL_CALL replaceByName (const OUString &aName, const css::uno::Any &aElement) override
 
css::uno::Any SAL_CALL getByName (const OUString &aName) override
 
css::uno::Sequence< OUString > SAL_CALL getElementNames () override
 
sal_Bool SAL_CALL hasByName (const OUString &aName) override
 
void SAL_CALL insertByName (const OUString &aName, const css::uno::Any &aElement) override
 
void SAL_CALL removeByName (const OUString &Name) override
 
css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo () override
 
css::uno::Reference< css::uno::XInterface > SAL_CALL createInstance (const OUString &aServiceSpecifier) override
 
css::uno::Reference< css::uno::XInterface > SAL_CALL createInstanceWithArguments (const OUString &ServiceSpecifier, const css::uno::Sequence< css::uno::Any > &Arguments) override
 
css::uno::Sequence< OUString > SAL_CALL getAvailableServiceNames () override
 
void SAL_CALL dispose () override
 
virtual sal_Bool SAL_CALL getGroupControl () override
 
virtual void SAL_CALL setGroupControl (sal_Bool GroupControl) override
 
virtual void SAL_CALL setControlModels (const css::uno::Sequence< css::uno::Reference< css::awt::XControlModel > > &Controls) override
 
virtual css::uno::Sequence< css::uno::Reference< css::awt::XControlModel > > SAL_CALL getControlModels () override
 
virtual void SAL_CALL setGroup (const css::uno::Sequence< css::uno::Reference< css::awt::XControlModel > > &Group, const OUString &GroupName) override
 
virtual sal_Int32 SAL_CALL getGroupCount () override
 
virtual void SAL_CALL getGroup (sal_Int32 nGroup, css::uno::Sequence< css::uno::Reference< css::awt::XControlModel > > &Group, OUString &Name) override
 
virtual void SAL_CALL getGroupByName (const OUString &Name, css::uno::Sequence< css::uno::Reference< css::awt::XControlModel > > &Group) override
 
virtual void SAL_CALL addChangesListener (const css::uno::Reference< css::util::XChangesListener > &aListener) override
 
virtual void SAL_CALL removeChangesListener (const css::uno::Reference< css::util::XChangesListener > &aListener) override
 
virtual void SAL_CALL propertyChange (const css::beans::PropertyChangeEvent &evt) override
 
virtual void SAL_CALL disposing (const css::lang::EventObject &evt) override
 
virtual void SAL_CALL initialize (const css::uno::Sequence< css::uno::Any > &rArguments) override
 
virtual ::sal_Int16 SAL_CALL getTabPageID () override
 
virtual sal_Bool SAL_CALL getEnabled () override
 
virtual void SAL_CALL setEnabled (sal_Bool _enabled) override
 
virtual OUString SAL_CALL getTitle () override
 
virtual void SAL_CALL setTitle (const OUString &_title) override
 
virtual OUString SAL_CALL getImageURL () override
 
virtual void SAL_CALL setImageURL (const OUString &_imageurl) override
 
virtual OUString SAL_CALL getToolTip () override
 
virtual void SAL_CALL setToolTip (const OUString &_tooltip) override
 
- Public Member Functions inherited from cppu::AggImplInheritanceHelper8< class BaseClass, class Ifc1, class Ifc2, class Ifc3, class Ifc4, class Ifc5, class Ifc6, class Ifc7, class Ifc8 >
 AggImplInheritanceHelper8 ()
 
virtual css::uno::Any SAL_CALL queryInterface (css::uno::Type const &rType) SAL_OVERRIDE
 
virtual css::uno::Any SAL_CALL queryAggregation (css::uno::Type const &rType) SAL_OVERRIDE
 
virtual void SAL_CALL acquire () SAL_NOEXCEPT SAL_OVERRIDE
 
virtual void SAL_CALL release () SAL_NOEXCEPT SAL_OVERRIDE
 
virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes () SAL_OVERRIDE
 
virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId () SAL_OVERRIDE
 

Protected Member Functions

void Clone_Impl (ControlModelContainerBase &_rClone) const
 
css::uno::Any ImplGetDefaultValue (sal_uInt16 nPropId) const override
 
::cppu::IPropertyArrayHelpergetInfoHelper () override
 
UnoControlModelHolderVector::iterator ImplFindElement (std::u16string_view rName)
 
void updateUserFormChildren (const css::uno::Reference< css::container::XNameContainer > &xAllChildren, const OUString &aName, ChildOperation Operation, const css::uno::Reference< css::awt::XControlModel > &xTarget)
 
void startControlListening (const css::uno::Reference< css::awt::XControlModel > &_rxChildModel)
 
void stopControlListening (const css::uno::Reference< css::awt::XControlModel > &_rxChildModel)
 
void implNotifyTabModelChange (const OUString &_rAccessor)
 
void implUpdateGroupStructure ()
 
- Protected Member Functions inherited from cppu::AggImplInheritanceHelper8< class BaseClass, class Ifc1, class Ifc2, class Ifc3, class Ifc4, class Ifc5, class Ifc6, class Ifc7, class Ifc8 >
 AggImplInheritanceHelper8 (T1 const &arg1)
 
 AggImplInheritanceHelper8 (T1 const &arg1, T2 const &arg2)
 
 AggImplInheritanceHelper8 (T1 const &arg1, T2 const &arg2, T3 const &arg3)
 
 AggImplInheritanceHelper8 (T1 const &arg1, T2 const &arg2, T3 const &arg3, T4 const &arg4)
 
 AggImplInheritanceHelper8 (T1 const &arg1, T2 const &arg2, T3 const &arg3, T4 const &arg4, T5 const &arg5)
 
 AggImplInheritanceHelper8 (T1 const &arg1, T2 const &arg2, T3 const &arg3, T4 const &arg4, T5 const &arg5, T6 const &arg6)
 

Protected Attributes

ContainerListenerMultiplexer maContainerListeners
 
::comphelper::OInterfaceContainerHelper4< css::util::XChangesListener > maChangeListeners
 
UnoControlModelHolderVector maModels
 
AllGroups maGroups
 
bool mbGroupsUpToDate
 
OUString m_sImageURL
 
OUString m_sTooltip
 
sal_Int16 m_nTabPageId
 

Private Types

typedef ::std::vector< UnoControlModelHolderUnoControlModelHolderVector
 

Friends

struct CloneControlModel
 
struct CompareControlModel
 

Detailed Description

Definition at line 59 of file controlmodelcontainerbase.hxx.

Member Typedef Documentation

◆ AllGroups

Definition at line 74 of file controlmodelcontainerbase.hxx.

◆ ModelGroup

typedef ::std::vector< css::uno::Reference< css::awt::XControlModel > > ControlModelContainerBase::ModelGroup

Definition at line 73 of file controlmodelcontainerbase.hxx.

◆ UnoControlModelHolder

typedef ::std::pair< css::uno::Reference< css::awt::XControlModel >, OUString > ControlModelContainerBase::UnoControlModelHolder

Definition at line 66 of file controlmodelcontainerbase.hxx.

◆ UnoControlModelHolderVector

Definition at line 68 of file controlmodelcontainerbase.hxx.

Member Enumeration Documentation

◆ ChildOperation

Enumerator
Insert 
Remove 

Definition at line 62 of file controlmodelcontainerbase.hxx.

Constructor & Destructor Documentation

◆ ControlModelContainerBase() [1/2]

ControlModelContainerBase::ControlModelContainerBase ( const css::uno::Reference< css::uno::XComponentContext > &  rxContext)

Referenced by Clone().

◆ ControlModelContainerBase() [2/2]

ControlModelContainerBase::ControlModelContainerBase ( const ControlModelContainerBase rModel)

Definition at line 177 of file controlmodelcontainerbase.cxx.

◆ ~ControlModelContainerBase()

ControlModelContainerBase::~ControlModelContainerBase ( )
overridevirtual

Definition at line 185 of file controlmodelcontainerbase.cxx.

References maModels, and mbGroupsUpToDate.

Member Function Documentation

◆ addChangesListener()

void SAL_CALL ControlModelContainerBase::addChangesListener ( const css::uno::Reference< css::util::XChangesListener > &  aListener)
overridevirtual

◆ addContainerListener()

void ControlModelContainerBase::addContainerListener ( const css::uno::Reference< css::container::XContainerListener > &  xListener)
override

Definition at line 408 of file controlmodelcontainerbase.cxx.

References maContainerListeners.

◆ Clone()

rtl::Reference< UnoControlModel > ControlModelContainerBase::Clone ( ) const
override

Definition at line 264 of file controlmodelcontainerbase.cxx.

References Clone_Impl(), and ControlModelContainerBase().

◆ Clone_Impl()

void ControlModelContainerBase::Clone_Impl ( ControlModelContainerBase _rClone) const
protected

◆ createInstance()

Reference< XInterface > ControlModelContainerBase::createInstance ( const OUString &  aServiceSpecifier)
override

Definition at line 279 of file controlmodelcontainerbase.cxx.

References m_xContext.

Referenced by createInstanceWithArguments().

◆ createInstanceWithArguments()

Reference< XInterface > ControlModelContainerBase::createInstanceWithArguments ( const OUString &  ServiceSpecifier,
const css::uno::Sequence< css::uno::Any > &  Arguments 
)
override

Definition at line 366 of file controlmodelcontainerbase.cxx.

References createInstance(), and ENSURE_OR_RETURN.

◆ dispose()

void SAL_CALL ControlModelContainerBase::dispose ( void  )
override

◆ disposing()

void SAL_CALL ControlModelContainerBase::disposing ( const css::lang::EventObject &  evt)
overridevirtual

Definition at line 1008 of file controlmodelcontainerbase.cxx.

◆ getAvailableServiceNames()

Sequence< OUString > ControlModelContainerBase::getAvailableServiceNames ( )
override

Definition at line 375 of file controlmodelcontainerbase.cxx.

◆ getByName()

Any ControlModelContainerBase::getByName ( const OUString &  aName)
override

◆ getControlModels()

Sequence< Reference< XControlModel > > SAL_CALL ControlModelContainerBase::getControlModels ( )
overridevirtual

◆ getElementNames()

Sequence< OUString > ControlModelContainerBase::getElementNames ( )
override

Definition at line 486 of file controlmodelcontainerbase.cxx.

References maModels.

◆ getElementType()

Type ControlModelContainerBase::getElementType ( )
override

Definition at line 419 of file controlmodelcontainerbase.cxx.

References cppu::UnoType< typename T >::get().

◆ getEnabled()

sal_Bool SAL_CALL ControlModelContainerBase::getEnabled ( )
overridevirtual

◆ getGroup()

void SAL_CALL ControlModelContainerBase::getGroup ( sal_Int32  nGroup,
css::uno::Sequence< css::uno::Reference< css::awt::XControlModel > > &  Group,
OUString &  Name 
)
overridevirtual

◆ getGroupByName()

void SAL_CALL ControlModelContainerBase::getGroupByName ( const OUString &  Name,
css::uno::Sequence< css::uno::Reference< css::awt::XControlModel > > &  Group 
)
overridevirtual

Definition at line 838 of file controlmodelcontainerbase.cxx.

References getGroup().

◆ getGroupControl()

sal_Bool SAL_CALL ControlModelContainerBase::getGroupControl ( )
overridevirtual

Reimplemented in UnoMultiPageModel, and UnoPageModel.

Definition at line 613 of file controlmodelcontainerbase.cxx.

◆ getGroupCount()

sal_Int32 SAL_CALL ControlModelContainerBase::getGroupCount ( )
overridevirtual

Definition at line 804 of file controlmodelcontainerbase.cxx.

References implUpdateGroupStructure(), and maGroups.

◆ getImageURL()

OUString SAL_CALL ControlModelContainerBase::getImageURL ( )
overridevirtual

Definition at line 758 of file controlmodelcontainerbase.cxx.

References m_sImageURL.

◆ getInfoHelper()

cppu::IPropertyArrayHelper & ControlModelContainerBase::getInfoHelper ( )
overrideprotected

Definition at line 207 of file controlmodelcontainerbase.cxx.

References aHelper.

Referenced by getPropertySetInfo().

◆ getPropertySetInfo()

Reference< XPropertySetInfo > ControlModelContainerBase::getPropertySetInfo ( )
override

Definition at line 251 of file controlmodelcontainerbase.cxx.

References getInfoHelper().

◆ getTabPageID()

sal_Int16 SAL_CALL ControlModelContainerBase::getTabPageID ( )
override

Definition at line 730 of file controlmodelcontainerbase.cxx.

References m_nTabPageId.

◆ getTitle()

OUString SAL_CALL ControlModelContainerBase::getTitle ( )
overridevirtual

◆ getToolTip()

OUString SAL_CALL ControlModelContainerBase::getToolTip ( )
overridevirtual

Definition at line 768 of file controlmodelcontainerbase.cxx.

References m_sTooltip.

◆ hasByName()

sal_Bool ControlModelContainerBase::hasByName ( const OUString &  aName)
override

Definition at line 500 of file controlmodelcontainerbase.cxx.

References aName, ImplFindElement(), and maModels.

◆ hasElements()

sal_Bool ControlModelContainerBase::hasElements ( )
override

Definition at line 425 of file controlmodelcontainerbase.cxx.

References maModels.

◆ ImplFindElement()

ControlModelContainerBase::UnoControlModelHolderVector::iterator ControlModelContainerBase::ImplFindElement ( std::u16string_view  rName)
protected

Definition at line 273 of file controlmodelcontainerbase.cxx.

References maModels.

Referenced by getByName(), hasByName(), insertByName(), removeByName(), and replaceByName().

◆ ImplGetDefaultValue()

Any ControlModelContainerBase::ImplGetDefaultValue ( sal_uInt16  nPropId) const
overrideprotected

◆ implNotifyTabModelChange()

void ControlModelContainerBase::implNotifyTabModelChange ( const OUString &  _rAccessor)
protected

◆ implUpdateGroupStructure()

void ControlModelContainerBase::implUpdateGroupStructure ( )
protected

Definition at line 880 of file controlmodelcontainerbase.cxx.

References getControlModels(), maGroups, and mbGroupsUpToDate.

Referenced by getGroup(), and getGroupCount().

◆ initialize()

void SAL_CALL ControlModelContainerBase::initialize ( const css::uno::Sequence< css::uno::Any > &  rArguments)
overridevirtual

Reimplemented in UnoControlTabPageModel.

Definition at line 718 of file controlmodelcontainerbase.cxx.

References m_nTabPageId, and nPageId.

◆ insertByName()

void ControlModelContainerBase::insertByName ( const OUString &  aName,
const css::uno::Any &  aElement 
)
override

◆ propertyChange()

void SAL_CALL ControlModelContainerBase::propertyChange ( const css::beans::PropertyChangeEvent &  evt)
overridevirtual

◆ removeByName()

void ControlModelContainerBase::removeByName ( const OUString &  Name)
override

◆ removeChangesListener()

void SAL_CALL ControlModelContainerBase::removeChangesListener ( const css::uno::Reference< css::util::XChangesListener > &  aListener)
overridevirtual

◆ removeContainerListener()

void ControlModelContainerBase::removeContainerListener ( const css::uno::Reference< css::container::XContainerListener > &  xListener)
override

Definition at line 413 of file controlmodelcontainerbase.cxx.

References maContainerListeners.

◆ replaceByName()

void ControlModelContainerBase::replaceByName ( const OUString &  aName,
const css::uno::Any &  aElement 
)
override

◆ setControlModels()

void SAL_CALL ControlModelContainerBase::setControlModels ( const css::uno::Sequence< css::uno::Reference< css::awt::XControlModel > > &  Controls)
overridevirtual

◆ setEnabled()

void SAL_CALL ControlModelContainerBase::setEnabled ( sal_Bool  _enabled)
overridevirtual

◆ setGroup()

void SAL_CALL ControlModelContainerBase::setGroup ( const css::uno::Sequence< css::uno::Reference< css::awt::XControlModel > > &  Group,
const OUString &  GroupName 
)
overridevirtual

Definition at line 708 of file controlmodelcontainerbase.cxx.

References SAL_WARN.

◆ setGroupControl()

void SAL_CALL ControlModelContainerBase::setGroupControl ( sal_Bool  GroupControl)
overridevirtual

Definition at line 619 of file controlmodelcontainerbase.cxx.

References SAL_WARN.

◆ setImageURL()

void SAL_CALL ControlModelContainerBase::setImageURL ( const OUString &  _imageurl)
overridevirtual

◆ setTitle()

void SAL_CALL ControlModelContainerBase::setTitle ( const OUString &  _title)
overridevirtual

◆ setToolTip()

void SAL_CALL ControlModelContainerBase::setToolTip ( const OUString &  _tooltip)
overridevirtual

Definition at line 772 of file controlmodelcontainerbase.cxx.

References m_sTooltip.

◆ startControlListening()

void ControlModelContainerBase::startControlListening ( const css::uno::Reference< css::awt::XControlModel > &  _rxChildModel)
protected

Definition at line 1013 of file controlmodelcontainerbase.cxx.

References getTabIndexPropertyName().

Referenced by insertByName(), and replaceByName().

◆ stopControlListening()

void ControlModelContainerBase::stopControlListening ( const css::uno::Reference< css::awt::XControlModel > &  _rxChildModel)
protected

Definition at line 1027 of file controlmodelcontainerbase.cxx.

References getTabIndexPropertyName().

Referenced by removeByName(), and replaceByName().

◆ updateUserFormChildren()

void ControlModelContainerBase::updateUserFormChildren ( const css::uno::Reference< css::container::XNameContainer > &  xAllChildren,
const OUString &  aName,
ChildOperation  Operation,
const css::uno::Reference< css::awt::XControlModel > &  xTarget 
)
protected
Exceptions
css::lang::IllegalArgumentException
css::container::ElementExistException
css::lang::WrappedTargetException
css::uno::RuntimeException

Definition at line 1772 of file controlmodelcontainerbase.cxx.

References aName, BASEPROPERTY_USERFORMCONTAINEES, GetPropertyName(), Insert, Remove, updateUserFormChildren(), and xTarget.

Referenced by insertByName(), removeByName(), replaceByName(), and updateUserFormChildren().

Friends And Related Function Documentation

◆ CloneControlModel

friend struct CloneControlModel
friend

Definition at line 76 of file controlmodelcontainerbase.hxx.

◆ CompareControlModel

friend struct CompareControlModel
friend

Definition at line 77 of file controlmodelcontainerbase.hxx.

Member Data Documentation

◆ m_nTabPageId

sal_Int16 ControlModelContainerBase::m_nTabPageId
protected

◆ m_sImageURL

OUString ControlModelContainerBase::m_sImageURL
protected

Definition at line 87 of file controlmodelcontainerbase.hxx.

Referenced by getImageURL(), and setImageURL().

◆ m_sTooltip

OUString ControlModelContainerBase::m_sTooltip
protected

Definition at line 88 of file controlmodelcontainerbase.hxx.

Referenced by getToolTip(), and setToolTip().

◆ maChangeListeners

::comphelper::OInterfaceContainerHelper4<css::util::XChangesListener> ControlModelContainerBase::maChangeListeners
protected

◆ maContainerListeners

ContainerListenerMultiplexer ControlModelContainerBase::maContainerListeners
protected

◆ maGroups

AllGroups ControlModelContainerBase::maGroups
protected

Definition at line 84 of file controlmodelcontainerbase.hxx.

Referenced by getGroup(), getGroupCount(), and implUpdateGroupStructure().

◆ maModels

UnoControlModelHolderVector ControlModelContainerBase::maModels
protected

◆ mbGroupsUpToDate

bool ControlModelContainerBase::mbGroupsUpToDate
protected

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