This is an abstract base class for implementations of the service com.sun.star.ucb.Content. More...

#include <contenthelper.hxx>

Inheritance diagram for ucbhelper::ContentImplHelper:

Collaboration diagram for ucbhelper::ContentImplHelper:

Public Member Functions
	ContentImplHelper (css::uno::Reference< css::uno::XComponentContext > xContext, rtl::Reference< ContentProviderImplHelper > xProvider, css::uno::Reference< css::ucb::XContentIdentifier > Identifier)
	Constructor. More...

virtual	~ContentImplHelper () override
	Destructor. More...

virtual css::uno::Any SAL_CALL	queryInterface (const css::uno::Type &rType) override

virtual void SAL_CALL	acquire () noexcept override

virtual void SAL_CALL	release () noexcept override

virtual css::uno::Sequence< sal_Int8 > SAL_CALL	getImplementationId () override

virtual css::uno::Sequence< css::uno::Type > SAL_CALL	getTypes () override

virtual OUString SAL_CALL	getImplementationName () override=0

virtual sal_Bool SAL_CALL	supportsService (const OUString &ServiceName) override

virtual css::uno::Sequence< OUString > SAL_CALL	getSupportedServiceNames () override=0

virtual void SAL_CALL	dispose () override

virtual void SAL_CALL	addEventListener (const css::uno::Reference< css::lang::XEventListener > &Listener) override

virtual void SAL_CALL	removeEventListener (const css::uno::Reference< css::lang::XEventListener > &Listener) override

virtual css::uno::Reference< css::ucb::XContentIdentifier > SAL_CALL	getIdentifier () override

virtual OUString SAL_CALL	getContentType () override=0

virtual void SAL_CALL	addContentEventListener (const css::uno::Reference< css::ucb::XContentEventListener > &Listener) override

virtual void SAL_CALL	removeContentEventListener (const css::uno::Reference< css::ucb::XContentEventListener > &Listener) override

virtual sal_Int32 SAL_CALL	createCommandIdentifier () override

virtual css::uno::Any SAL_CALL	execute (const css::ucb::Command &aCommand, sal_Int32 CommandId, const css::uno::Reference< css::ucb::XCommandEnvironment > &Environment) override=0

virtual void SAL_CALL	abort (sal_Int32 CommandId) override=0

virtual void SAL_CALL	addPropertiesChangeListener (const css::uno::Sequence< OUString > &PropertyNames, const css::uno::Reference< css::beans::XPropertiesChangeListener > &Listener) override

virtual void SAL_CALL	removePropertiesChangeListener (const css::uno::Sequence< OUString > &PropertyNames, const css::uno::Reference< css::beans::XPropertiesChangeListener > &Listener) override

virtual void SAL_CALL	addCommandInfoChangeListener (const css::uno::Reference< css::ucb::XCommandInfoChangeListener > &Listener) override

virtual void SAL_CALL	removeCommandInfoChangeListener (const css::uno::Reference< css::ucb::XCommandInfoChangeListener > &Listener) override

virtual void SAL_CALL	addProperty (const OUString &Name, sal_Int16 Attributes, const css::uno::Any &DefaultValue) override
	This method adds a property to the content according to the interface specification. More...

virtual void SAL_CALL	removeProperty (const OUString &Name) override
	This method removes a property from the content according to the interface specification. More...

virtual void SAL_CALL	addPropertySetInfoChangeListener (const css::uno::Reference< css::beans::XPropertySetInfoChangeListener > &Listener) override

virtual void SAL_CALL	removePropertySetInfoChangeListener (const css::uno::Reference< css::beans::XPropertySetInfoChangeListener > &Listener) override

virtual css::uno::Reference< css::uno::XInterface > SAL_CALL	getParent () override
	This method returns the content representing the parent of a content, if such a parent exists. More...

virtual void SAL_CALL	setParent (const css::uno::Reference< css::uno::XInterface > &Parent) override
	The implementation of this method always throws a NoSupportException. More...

const rtl::Reference< ContentProviderImplHelper > &	getProvider () const
	This method returns the provider of the content. More...

Public Member Functions inherited from cppu::OWeakObject
	OWeakObject ()

	OWeakObject (const OWeakObject &)

OWeakObject &SAL_CALL	operator= (const OWeakObject &)

virtual css::uno::Any SAL_CALL	queryInterface (const css::uno::Type &rType) SAL_OVERRIDE

virtual void SAL_CALL	acquire () SAL_NOEXCEPT SAL_OVERRIDE

virtual void SAL_CALL	release () SAL_NOEXCEPT SAL_OVERRIDE

virtual css::uno::Reference< css::uno::XAdapter > SAL_CALL	queryAdapter () SAL_OVERRIDE

SAL_CALL	operator css::uno::Reference< css::uno::XInterface > ()

Protected Member Functions
css::uno::Reference< css::beans::XPropertySetInfo >	getPropertySetInfo (const css::uno::Reference< css::ucb::XCommandEnvironment > &xEnv, bool bCache=true)
	This method returns complete meta data for the properties ( including Additional Core Properties supplied via XPropertyContainer interface ) supported by the content. More...

css::uno::Reference< css::ucb::XCommandInfo >	getCommandInfo (const css::uno::Reference< css::ucb::XCommandEnvironment > &xEnv, bool bCache=true)
	This method returns complete meta data for the commands supported by the content. More...

void	notifyPropertiesChange (const css::uno::Sequence< css::beans::PropertyChangeEvent > &evt) const
	This method can be used to propagate changes of property values. More...

void	notifyPropertySetInfoChange (const css::beans::PropertySetInfoChangeEvent &evt) const
	This method can be used to propagate changes of the propertyset info of your content (i.e. More...

void	notifyContentEvent (const css::ucb::ContentEvent &evt) const
	This method can be used to propagate content events. More...

void	inserted ()
	Use this method to announce the insertion of this content at the end of your implementation of the command "insert". More...

void	deleted ()
	Use this method to announce the destruction of this content at the end of your implementation of the command "delete". More...

bool	exchange (const css::uno::Reference< css::ucb::XContentIdentifier > &rNewId)
	Use this method to change the identity of a content. More...

css::uno::Reference< css::ucb::XPersistentPropertySet >	getAdditionalPropertySet (bool bCreate)
	Use this method to get access to the Additional Core Properties of the content ( added using content's XPropertyContainer interface ). More...

bool	renameAdditionalPropertySet (const OUString &rOldKey, const OUString &rNewKey)
	This method renames the propertyset containing the Additional Core Properties of the content. More...

bool	copyAdditionalPropertySet (const OUString &rSourceKey, const OUString &rTargetKey)
	This method copies the propertyset containing the Additional Core Properties of the content. More...

bool	removeAdditionalPropertySet ()
	This method removes the propertyset containing the Additional Core Properties of the content. More...

Protected Member Functions inherited from cppu::OWeakObject
virtual	~OWeakObject () COVERITY_NOEXCEPT_FALSE

void	disposeWeakConnectionPoint ()

Protected Attributes
osl::Mutex	m_aMutex

css::uno::Reference< css::uno::XComponentContext >	m_xContext

css::uno::Reference< css::ucb::XContentIdentifier >	m_xIdentifier

rtl::Reference< ContentProviderImplHelper >	m_xProvider

sal_uInt32	m_nCommandId

Protected Attributes inherited from cppu::OWeakObject
oslInterlockedCount	m_refCount

Private Member Functions
virtual UCBHELPER_DLLPRIVATE css::uno::Sequence< css::beans::Property >	getProperties (const css::uno::Reference< css::ucb::XCommandEnvironment > &xEnv)=0
	Your implementation of this method must return a sequence containing the meta data of the properties supported by the content. More...

virtual UCBHELPER_DLLPRIVATE css::uno::Sequence< css::ucb::CommandInfo >	getCommands (const css::uno::Reference< css::ucb::XCommandEnvironment > &xEnv)=0
	Your implementation of this method must return a sequence containing the meta data of the commands supported by the content. More...

virtual UCBHELPER_DLLPRIVATE OUString	getParentURL ()=0
	The implementation of this method shall return the URL of the parent of your content. More...

Private Attributes
std::unique_ptr< ucbhelper_impl::ContentImplHelper_Impl >	m_pImpl

Friends
class	PropertySetInfo

class	CommandProcessorInfo

Detailed Description

This is an abstract base class for implementations of the service com.sun.star.ucb.Content.

Implementations derived from this class are objects provided by implementations derived from class ucb::ContentProviderImplHelper.

Features of the base class implementation:

standard interfaces ( XInterface, XTypeProvider, XServiceInfo )
all required interfaces for service css::ucb::Content
all required listener containers ( XComponent, XPropertiesChangeNotifier, XPropertySetInfoChangeNotifier, XCommandInfoChangeNotifier )
XPropertyContainer implementation ( persistence is implemented using service com.sun.star.ucb.Store )
complete XPropertySetInfo implementation ( including Additional Core Properties supplied via XPropertyContainer interface ) -> protected method: getPropertySetInfo
complete XCommandInfo implementation -> protected method: getCommandInfo

Definition at line 81 of file contenthelper.hxx.

Constructor & Destructor Documentation

◆ ContentImplHelper()

ucbhelper::ContentImplHelper::ContentImplHelper	(	css::uno::Reference< css::uno::XComponentContext >	xContext,
		rtl::Reference< ContentProviderImplHelper >	xProvider,
		css::uno::Reference< css::ucb::XContentIdentifier >	Identifier
	)

Constructor.

Note that the implementation of this ctor registers itself at its content provider. The provider implementation inserts the content in a hash map. So it easily can be found and reused when the provider is asked for a content.

Parameters

rxContext	is a Service Manager.
rxProvider	is the provider for the content.
Identifier	is the content identifier for the content.

Definition at line 127 of file contenthelper.cxx.

References Identifier, m_pImpl, and m_xContext.

◆ ~ContentImplHelper()

ucbhelper::ContentImplHelper::~ContentImplHelper ( )

overridevirtual

Destructor.

Note that the implementation of this dtor deregisters itself from its content provider. The provider implementation removes the content from a hash map.

Definition at line 141 of file contenthelper.cxx.

Member Function Documentation

◆ abort()

virtual void SAL_CALL ucbhelper::ContentImplHelper::abort ( sal_Int32 CommandId )

overridepure virtual

◆ acquire()

virtual void SAL_CALL ucbhelper::ContentImplHelper::acquire ( )

inlineoverridevirtualnoexcept

Reimplemented from cppu::OWeakObject.

Definition at line 311 of file contenthelper.hxx.

References cppu::OWeakObject::acquire().

◆ addCommandInfoChangeListener()

void SAL_CALL ucbhelper::ContentImplHelper::addCommandInfoChangeListener ( const css::uno::Reference< css::ucb::XCommandInfoChangeListener > & Listener )

overridevirtual

Definition at line 357 of file contenthelper.cxx.

References m_aMutex, and m_pImpl.

◆ addContentEventListener()

void SAL_CALL ucbhelper::ContentImplHelper::addContentEventListener ( const css::uno::Reference< css::ucb::XContentEventListener > & Listener )

overridevirtual

Definition at line 270 of file contenthelper.cxx.

References m_aMutex, and m_pImpl.

◆ addEventListener()

void SAL_CALL ucbhelper::ContentImplHelper::addEventListener ( const css::uno::Reference< css::lang::XEventListener > & Listener )

overridevirtual

Definition at line 240 of file contenthelper.cxx.

References m_aMutex, and m_pImpl.

◆ addPropertiesChangeListener()

void SAL_CALL ucbhelper::ContentImplHelper::addPropertiesChangeListener	(	const css::uno::Sequence< OUString > &	PropertyNames,
		const css::uno::Reference< css::beans::XPropertiesChangeListener > &	Listener
	)

overridevirtual

Definition at line 302 of file contenthelper.cxx.

References m_aMutex, and m_pImpl.

◆ addProperty()

void SAL_CALL ucbhelper::ContentImplHelper::addProperty	(	const OUString &	Name,
		sal_Int16	Attributes,
		const css::uno::Any &	DefaultValue
	)

overridevirtual

This method adds a property to the content according to the interface specification.

The properties will be stored using the service com.sun.star.ucb.Store.

Note: You may provide your own implementation of this method, for instance, if your data source supports adding/removing of properties. Don't forget to return the meta data for these properties in your implementation of getPropertyInfoTable.

Definition at line 380 of file contenthelper.cxx.

References getAdditionalPropertySet(), getPropertySetInfo(), m_aMutex, m_pImpl, Name, and notifyPropertySetInfoChange().

◆ addPropertySetInfoChangeListener()

void SAL_CALL ucbhelper::ContentImplHelper::addPropertySetInfoChangeListener ( const css::uno::Reference< css::beans::XPropertySetInfoChangeListener > & Listener )

overridevirtual

Definition at line 563 of file contenthelper.cxx.

References m_aMutex, and m_pImpl.

◆ copyAdditionalPropertySet()

bool ucbhelper::ContentImplHelper::copyAdditionalPropertySet	(	const OUString &	rSourceKey,
		const OUString &	rTargetKey
	)

protected

This method copies the propertyset containing the Additional Core Properties of the content.

Parameters

rSourceKey	is the key of the source propertyset.
rTargetKey	is the key of the target propertyset.

Returns: True, if the operation succeeded - False, otherwise.

Definition at line 630 of file contenthelper.cxx.

References m_xProvider.

◆ createCommandIdentifier()

sal_Int32 SAL_CALL ucbhelper::ContentImplHelper::createCommandIdentifier ( )

overridevirtual

Definition at line 293 of file contenthelper.cxx.

References m_aMutex, and m_nCommandId.

◆ deleted()

void ucbhelper::ContentImplHelper::deleted ( )

protected

Use this method to announce the destruction of this content at the end of your implementation of the command "delete".

The implementation of is method propagates a ContentEvent( DELETED ) and a ContentEvent( REMOVED ) at the parent of the deleted content, if a parent exists.

Definition at line 763 of file contenthelper.cxx.

References getIdentifier(), getParentURL(), m_xProvider, and notifyContentEvent().

◆ dispose()

void SAL_CALL ucbhelper::ContentImplHelper::dispose ( void )

overridevirtual

Definition at line 193 of file contenthelper.cxx.

References m_aMutex, and m_pImpl.

◆ exchange()

bool ucbhelper::ContentImplHelper::exchange ( const css::uno::Reference< css::ucb::XContentIdentifier > & rNewId )

protected

Use this method to change the identity of a content.

The implementation of this method will replace the content identifier of the content and propagate the appropriate ContentEvent( EXCHANGED ).

Parameters

rNewId is the new content identifier for the content.

Returns: a success indicator.

Definition at line 792 of file contenthelper.cxx.

References getIdentifier(), m_aMutex, m_xIdentifier, m_xProvider, and notifyContentEvent().

◆ execute()

virtual css::uno::Any SAL_CALL ucbhelper::ContentImplHelper::execute	(	const css::ucb::Command &	aCommand,
		sal_Int32	CommandId,
		const css::uno::Reference< css::ucb::XCommandEnvironment > &	Environment
	)

overridepure virtual

◆ getAdditionalPropertySet()

uno::Reference< css::ucb::XPersistentPropertySet > ucbhelper::ContentImplHelper::getAdditionalPropertySet ( bool bCreate )

protected

Use this method to get access to the Additional Core Properties of the content ( added using content's XPropertyContainer interface ).

If you supply your own XPropertyContainer implementation, this method will always return an empty propertyset.

Parameters

bCreate indicates whether a new propertyset shall be created if it does not exist.

Returns: the implementation of the service com.sun.star.ucb.PersistentPropertySet.

Definition at line 615 of file contenthelper.cxx.

References m_xIdentifier, and m_xProvider.

Referenced by addProperty(), and removeProperty().

◆ getCommandInfo()

uno::Reference< css::ucb::XCommandInfo > ucbhelper::ContentImplHelper::getCommandInfo	(	const css::uno::Reference< css::ucb::XCommandEnvironment > &	xEnv,
		bool	bCache = `true`
	)

protected

This method returns complete meta data for the commands supported by the content.

To implement the required command "getCommandInfo" simply return the return value of this method.

Parameters

xEnv	is an environment to use for example, for interactions.
bCache	indicates, whether the implementation should use cached data, if exist.

Returns: an XCommandInfo implementation object containing meta data for the commands supported by this content.

Definition at line 830 of file contenthelper.cxx.

References CommandProcessorInfo, m_aMutex, and m_pImpl.

◆ getCommands()

virtual UCBHELPER_DLLPRIVATE css::uno::Sequence< css::ucb::CommandInfo > ucbhelper::ContentImplHelper::getCommands ( const css::uno::Reference< css::ucb::XCommandEnvironment > & xEnv )

privatepure virtual

Your implementation of this method must return a sequence containing the meta data of the commands supported by the content.

Parameters

xEnv	is an environment to use for example, for interactions.

Returns: a sequence containing the command meta data.

Referenced by ucbhelper::CommandProcessorInfo::getCommandsImpl().

◆ getContentType()

virtual OUString SAL_CALL ucbhelper::ContentImplHelper::getContentType ( )

overridepure virtual

◆ getIdentifier()

uno::Reference< css::ucb::XContentIdentifier > SAL_CALL ucbhelper::ContentImplHelper::getIdentifier ( )

overridevirtual

Definition at line 264 of file contenthelper.cxx.

References m_xIdentifier.

Referenced by deleted(), exchange(), and ucbhelper::ContentProviderImplHelper::removeContent().

◆ getImplementationId()

virtual css::uno::Sequence< sal_Int8 > SAL_CALL ucbhelper::ContentImplHelper::getImplementationId ( )

overridevirtual

◆ getImplementationName()

virtual OUString SAL_CALL ucbhelper::ContentImplHelper::getImplementationName ( )

overridepure virtual

◆ getParent()

uno::Reference< uno::XInterface > SAL_CALL ucbhelper::ContentImplHelper::getParent ( )

overridevirtual

This method returns the content representing the parent of a content, if such a parent exists.

The implementation of this method uses your implementation of getParentURL.

Definition at line 586 of file contenthelper.cxx.

References aURL, getParentURL(), and m_xProvider.

◆ getParentURL()

virtual UCBHELPER_DLLPRIVATE OUString ucbhelper::ContentImplHelper::getParentURL ( )

privatepure virtual

The implementation of this method shall return the URL of the parent of your content.

Returns: the URL of the parent content or an empty string. Note that not all contents must have one parent. There may be contents with no parent. In that case an empty string must be returned. If your content has more than one parent you may return the URL of one "preferred" parent or an empty string.

References inserted(), and queryInterface().

Referenced by deleted(), getParent(), and inserted().

◆ getProperties()

virtual UCBHELPER_DLLPRIVATE css::uno::Sequence< css::beans::Property > ucbhelper::ContentImplHelper::getProperties ( const css::uno::Reference< css::ucb::XCommandEnvironment > & xEnv )

privatepure virtual

Your implementation of this method must return a sequence containing the meta data of the properties supported by the content.

Note: If you wish to provide your own implementation of the interface XPropertyContainer ( completely override addContent and removeContent implementation of this base class in this case ), you can supply the meta data for your Additional Core Properties here to get a fully featured getPropertySetInfo method ( see below ).

Parameters

xEnv	is an environment to use for example, for interactions.

Returns: a sequence containing the property meta data.

◆ getPropertySetInfo()

uno::Reference< beans::XPropertySetInfo > ucbhelper::ContentImplHelper::getPropertySetInfo	(	const css::uno::Reference< css::ucb::XCommandEnvironment > &	xEnv,
		bool	bCache = `true`
	)

protected

This method returns complete meta data for the properties ( including Additional Core Properties supplied via XPropertyContainer interface ) supported by the content.

To implement the required command "getPropertySetInfo" simply return the return value of this method.

Parameters

xEnv	is an environment to use for example, for interactions.
bCache	indicates, whether the implementation should use cached data, if exist.

Returns: an XPropertySetInfo implementation object containing meta data for the properties supported by this content.

Definition at line 846 of file contenthelper.cxx.

References m_aMutex, m_pImpl, and PropertySetInfo.

Referenced by addProperty(), and removeProperty().

◆ getProvider()

const rtl::Reference< ContentProviderImplHelper > & ucbhelper::ContentImplHelper::getProvider ( ) const

inline

This method returns the provider of the content.

Returns: the provider of the content.

Definition at line 440 of file contenthelper.hxx.

◆ getSupportedServiceNames()

virtual css::uno::Sequence< OUString > SAL_CALL ucbhelper::ContentImplHelper::getSupportedServiceNames ( )

overridepure virtual

◆ getTypes()

virtual css::uno::Sequence< css::uno::Type > SAL_CALL ucbhelper::ContentImplHelper::getTypes ( )

overridevirtual

◆ inserted()

void ucbhelper::ContentImplHelper::inserted ( )

protected

Use this method to announce the insertion of this content at the end of your implementation of the command "insert".

The implementation of is method propagates a ContentEvent( INSERTED ).

Definition at line 741 of file contenthelper.cxx.

References getParentURL(), and m_xProvider.

◆ notifyContentEvent()

void ucbhelper::ContentImplHelper::notifyContentEvent ( const css::ucb::ContentEvent & evt ) const

protected

This method can be used to propagate content events.

Parameters

evt	is a sequence of content events.

Definition at line 731 of file contenthelper.cxx.

References m_pImpl.

Referenced by deleted(), and exchange().

◆ notifyPropertiesChange()

void ucbhelper::ContentImplHelper::notifyPropertiesChange ( const css::uno::Sequence< css::beans::PropertyChangeEvent > & evt ) const

protected

This method can be used to propagate changes of property values.

Parameters

evt	is a sequence of property change events.

Definition at line 644 of file contenthelper.cxx.

References aListeners, first, cppu::OInterfaceIteratorHelper::hasMoreElements(), m_pImpl, nCount, cppu::OInterfaceIteratorHelper::next(), and p.

◆ notifyPropertySetInfoChange()

void ucbhelper::ContentImplHelper::notifyPropertySetInfoChange ( const css::beans::PropertySetInfoChangeEvent & evt ) const

protected

This method can be used to propagate changes of the propertyset info of your content (i.e.

this happens if a new property is added to your content via its XPropertyContainer interface). This base class automatically generates events when the propertyset info changes. If you provide your own implementations of addproperty and removeProperty, then you must call "notifyPropertySetInfoChange" by yourself.

Parameters

evt	is a sequence of property change events.

Definition at line 721 of file contenthelper.cxx.

References m_pImpl.

Referenced by addProperty(), and removeProperty().

◆ queryInterface()

uno::Any SAL_CALL ucbhelper::ContentImplHelper::queryInterface ( const css::uno::Type & rType )

overridevirtual

Reimplemented from cppu::OWeakObject.

Definition at line 157 of file contenthelper.cxx.

References cppu::OWeakObject::queryInterface(), and cppu::queryInterface().

◆ release()

void SAL_CALL ucbhelper::ContentImplHelper::release ( )

overridevirtualnoexcept

Reimplemented from cppu::OWeakObject.

Definition at line 145 of file contenthelper.cxx.

References m_xProvider.

◆ removeAdditionalPropertySet()

bool ucbhelper::ContentImplHelper::removeAdditionalPropertySet ( )

protected

This method removes the propertyset containing the Additional Core Properties of the content.

Propertysets for children described by rOldKey are removed too.

Returns: True, if the operation succeeded - False, otherwise.

Definition at line 638 of file contenthelper.cxx.

References m_xIdentifier, and m_xProvider.

◆ removeCommandInfoChangeListener()

void SAL_CALL ucbhelper::ContentImplHelper::removeCommandInfoChangeListener ( const css::uno::Reference< css::ucb::XCommandInfoChangeListener > & Listener )

overridevirtual

Definition at line 370 of file contenthelper.cxx.

References m_aMutex, and m_pImpl.

◆ removeContentEventListener()

void SAL_CALL ucbhelper::ContentImplHelper::removeContentEventListener ( const css::uno::Reference< css::ucb::XContentEventListener > & Listener )

overridevirtual

Definition at line 283 of file contenthelper.cxx.

References m_aMutex, and m_pImpl.

◆ removeEventListener()

void SAL_CALL ucbhelper::ContentImplHelper::removeEventListener ( const css::uno::Reference< css::lang::XEventListener > & Listener )

overridevirtual

Definition at line 253 of file contenthelper.cxx.

References m_aMutex, and m_pImpl.

◆ removePropertiesChangeListener()

void SAL_CALL ucbhelper::ContentImplHelper::removePropertiesChangeListener	(	const css::uno::Sequence< OUString > &	PropertyNames,
		const css::uno::Reference< css::beans::XPropertiesChangeListener > &	Listener
	)

overridevirtual

Definition at line 330 of file contenthelper.cxx.

References m_aMutex, and m_pImpl.

◆ removeProperty()

void SAL_CALL ucbhelper::ContentImplHelper::removeProperty ( const OUString & Name )

overridevirtual

This method removes a property from the content according to the interface specification.

The properties will be stored using the service com.sun.star.ucb.Store.

Note: You may provide your own implementation of this method, for instance, if your data source supports adding/removing of properties. Don't forget to return the meta data for these properties in your implementation of getPropertyInfoTable.

Definition at line 467 of file contenthelper.cxx.

References getAdditionalPropertySet(), getPropertySetInfo(), m_aMutex, m_pImpl, Name, and notifyPropertySetInfoChange().

◆ removePropertySetInfoChangeListener()

void SAL_CALL ucbhelper::ContentImplHelper::removePropertySetInfoChangeListener ( const css::uno::Reference< css::beans::XPropertySetInfoChangeListener > & Listener )

overridevirtual

Definition at line 576 of file contenthelper.cxx.

References m_aMutex, and m_pImpl.

◆ renameAdditionalPropertySet()

bool ucbhelper::ContentImplHelper::renameAdditionalPropertySet	(	const OUString &	rOldKey,
		const OUString &	rNewKey
	)

protected

This method renames the propertyset containing the Additional Core Properties of the content.

Parameters

rOldKey	is the old key of the propertyset.
rNewKey	is the new key for the propertyset.

Returns: True, if the operation succeeded - False, otherwise.

Definition at line 622 of file contenthelper.cxx.

References m_xProvider.

◆ setParent()

void SAL_CALL ucbhelper::ContentImplHelper::setParent ( const css::uno::Reference< css::uno::XInterface > & Parent )

overridevirtual

The implementation of this method always throws a NoSupportException.

Definition at line 608 of file contenthelper.cxx.

◆ supportsService()

sal_Bool SAL_CALL ucbhelper::ContentImplHelper::supportsService ( const OUString & ServiceName )

overridevirtual

Definition at line 186 of file contenthelper.cxx.

References ServiceName, and cppu::supportsService().

Friends And Related Function Documentation

◆ CommandProcessorInfo

friend class CommandProcessorInfo

friend

Definition at line 95 of file contenthelper.hxx.

Referenced by getCommandInfo().

◆ PropertySetInfo

friend class PropertySetInfo

friend

Definition at line 94 of file contenthelper.hxx.

Referenced by getPropertySetInfo().

Member Data Documentation

◆ m_aMutex

osl::Mutex ucbhelper::ContentImplHelper::m_aMutex

protected

Definition at line 100 of file contenthelper.hxx.

Referenced by addCommandInfoChangeListener(), addContentEventListener(), addEventListener(), addPropertiesChangeListener(), addProperty(), addPropertySetInfoChangeListener(), createCommandIdentifier(), dispose(), exchange(), getCommandInfo(), getPropertySetInfo(), removeCommandInfoChangeListener(), removeContentEventListener(), removeEventListener(), removePropertiesChangeListener(), removeProperty(), and removePropertySetInfoChangeListener().

◆ m_nCommandId

sal_uInt32 ucbhelper::ContentImplHelper::m_nCommandId

protected

Definition at line 107 of file contenthelper.hxx.

Referenced by createCommandIdentifier().

◆ m_pImpl

std::unique_ptr<ucbhelper_impl::ContentImplHelper_Impl> ucbhelper::ContentImplHelper::m_pImpl

private

◆ m_xContext

css::uno::Reference< css::uno::XComponentContext > ucbhelper::ContentImplHelper::m_xContext

protected

Definition at line 102 of file contenthelper.hxx.

◆ m_xIdentifier

css::uno::Reference< css::ucb::XContentIdentifier > ucbhelper::ContentImplHelper::m_xIdentifier

protected

Definition at line 104 of file contenthelper.hxx.

Referenced by exchange(), getAdditionalPropertySet(), getIdentifier(), and removeAdditionalPropertySet().

◆ m_xProvider

rtl::Reference< ContentProviderImplHelper > ucbhelper::ContentImplHelper::m_xProvider

protected

Definition at line 106 of file contenthelper.hxx.

Referenced by copyAdditionalPropertySet(), deleted(), exchange(), getAdditionalPropertySet(), getParent(), inserted(), release(), removeAdditionalPropertySet(), and renameAdditionalPropertySet().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ContentImplHelper()

◆ ~ContentImplHelper()

Member Function Documentation

◆ abort()

◆ acquire()

◆ addCommandInfoChangeListener()

◆ addContentEventListener()

◆ addEventListener()

◆ addPropertiesChangeListener()

◆ addProperty()

◆ addPropertySetInfoChangeListener()

◆ copyAdditionalPropertySet()

◆ createCommandIdentifier()

◆ deleted()

◆ dispose()

◆ exchange()

◆ execute()

◆ getAdditionalPropertySet()

◆ getCommandInfo()

◆ getCommands()

◆ getContentType()

◆ getIdentifier()

◆ getImplementationId()

◆ getImplementationName()

◆ getParent()

◆ getParentURL()

◆ getProperties()

◆ getPropertySetInfo()

◆ getProvider()

◆ getSupportedServiceNames()

◆ getTypes()

◆ inserted()

◆ notifyContentEvent()

◆ notifyPropertiesChange()

◆ notifyPropertySetInfoChange()

◆ queryInterface()

◆ release()

◆ removeAdditionalPropertySet()

◆ removeCommandInfoChangeListener()

◆ removeContentEventListener()

◆ removeEventListener()

◆ removePropertiesChangeListener()

◆ removeProperty()

◆ removePropertySetInfoChangeListener()

◆ renameAdditionalPropertySet()

◆ setParent()

◆ supportsService()

Friends And Related Function Documentation

◆ CommandProcessorInfo

◆ PropertySetInfo

Member Data Documentation

◆ m_aMutex

◆ m_nCommandId

◆ m_pImpl

◆ m_xContext

◆ m_xIdentifier

◆ m_xProvider