basic::SfxLibrary Class Reference

#include <namecont.hxx>

Inheritance diagram for basic::SfxLibrary:

Collaboration diagram for basic::SfxLibrary:

Classes
struct	LibraryContainerAccess

Public Member Functions
	SfxLibrary (ModifiableHelper &_rModifiable, const css::uno::Type &aType, const css::uno::Reference< css::ucb::XSimpleFileAccess3 > &xSFI)
	SfxLibrary (ModifiableHelper &_rModifiable, const css::uno::Type &aType, const css::uno::Reference< css::ucb::XSimpleFileAccess3 > &xSFI, OUString aLibInfoFileURL, OUString aStorageURL, bool ReadOnly)
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::Type SAL_CALL	getElementType () override
virtual sal_Bool SAL_CALL	hasElements () override
virtual css::uno::Any SAL_CALL	getByName (const OUString &aName) override
virtual css::uno::Sequence< OUString > SAL_CALL	getElementNames () override
virtual sal_Bool SAL_CALL	hasByName (const OUString &aName) override
virtual void SAL_CALL	replaceByName (const OUString &aName, const css::uno::Any &aElement) override
virtual void SAL_CALL	insertByName (const OUString &aName, const css::uno::Any &aElement) override
virtual void SAL_CALL	removeByName (const OUString &Name) override
css::uno::Sequence< css::uno::Type > SAL_CALL	getTypes () override
css::uno::Sequence< sal_Int8 > SAL_CALL	getImplementationId () override
virtual void SAL_CALL	addContainerListener (const css::uno::Reference< css::container::XContainerListener > &xListener) override
virtual void SAL_CALL	removeContainerListener (const css::uno::Reference< css::container::XContainerListener > &xListener) override
virtual void SAL_CALL	addChangesListener (const css::uno::Reference< css::util::XChangesListener > &xListener) override
virtual void SAL_CALL	removeChangesListener (const css::uno::Reference< css::util::XChangesListener > &xListener) override
void	removeElementWithoutChecks (const OUString &_rElementName, LibraryContainerAccess)
Public Member Functions inherited from comphelper::WeakComponentImplHelper<>
virtual void SAL_CALL	acquire () noexcept override
virtual void SAL_CALL	release () noexcept override
virtual void SAL_CALL	dispose () noexcept final override
virtual void SAL_CALL	addEventListener (css::uno::Reference< css::lang::XEventListener > const &rxListener) final override
virtual void SAL_CALL	removeEventListener (css::uno::Reference< css::lang::XEventListener > const &rxListener) final override
virtual css::uno::Any SAL_CALL	queryInterface (css::uno::Type const &rType) override
virtual css::uno::Sequence< css::uno::Type > SAL_CALL	getTypes () override
virtual css::uno::Sequence< sal_Int8 > SAL_CALL	getImplementationId () override
Public Member Functions inherited from comphelper::WeakComponentImplHelperBase
virtual	~WeakComponentImplHelperBase () override
virtual void SAL_CALL	dispose () override
virtual void SAL_CALL	addEventListener (css::uno::Reference< css::lang::XEventListener > const &rxListener) override
virtual void SAL_CALL	removeEventListener (css::uno::Reference< css::lang::XEventListener > const &rxListener) override
virtual css::uno::Any SAL_CALL	queryInterface (css::uno::Type const &rType) override
virtual void	disposing (std::unique_lock< std::mutex > &)
Public Member Functions inherited from comphelper::UnoImplBase
virtual	~UnoImplBase ()

Protected Member Functions
bool	implIsModified () const
void	implSetModified (bool _bIsModified)
virtual bool	isLoadedStorable ()
virtual bool	isLibraryElementValid (const css::uno::Any &rElement) const =0
Protected Member Functions inherited from comphelper::WeakComponentImplHelperBase
void	throwIfDisposed (std::unique_lock< std::mutex > &)

Protected Attributes
bool	mbPasswordProtected
Protected Attributes inherited from comphelper::WeakComponentImplHelperBase
comphelper::OInterfaceContainerHelper4< css::lang::XEventListener >	maEventListeners
Protected Attributes inherited from comphelper::UnoImplBase
std::mutex	m_aMutex
bool	m_bDisposed

Private Member Functions
virtual bool	isModified ()=0
virtual void	storeResources ()=0
virtual void	storeResourcesAsURL (const OUString &URL, const OUString &NewName)=0
virtual void	storeResourcesToURL (const OUString &URL, const css::uno::Reference< css::task::XInteractionHandler > &xHandler)=0
virtual void	storeResourcesToStorage (const css::uno::Reference< css::embed::XStorage > &xStorage)=0
void	impl_checkReadOnly ()
	checks whether the lib is readonly, or a readonly link, throws an IllegalArgumentException if so More...
void	impl_checkLoaded ()
	checks whether the library is loaded, throws a LibraryNotLoadedException (wrapped in a WrappedTargetException), if not. More...
void	impl_removeWithoutChecks (const OUString &_rElementName)

Private Attributes
css::uno::Reference< css::ucb::XSimpleFileAccess3 >	mxSFI
ModifiableHelper &	mrModifiable
rtl::Reference< NameContainer >	maNameContainer
bool	mbLoaded
bool	mbIsModified
bool	mbInitialised
OUString	maLibElementFileExtension
OUString	maLibInfoFileURL
OUString	maStorageURL
OUString	maUnexpandedStorageURL
OUString	maOriginalStorageURL
bool	mbLink
bool	mbReadOnly
bool	mbReadOnlyLink
bool	mbPreload
bool	mbPasswordVerified
bool	mbDoc50Password
OUString	maPassword
bool	mbSharedIndexFile
bool	mbExtension

Friends
class	SfxLibraryContainer
class	SfxDialogLibraryContainer
class	SfxScriptLibraryContainer

Detailed Description

Definition at line 468 of file namecont.hxx.

Constructor & Destructor Documentation

SfxLibrary() [1/2]

basic::SfxLibrary::SfxLibrary	(	ModifiableHelper &	_rModifiable,
		const css::uno::Type &	aType,
		const css::uno::Reference< css::ucb::XSimpleFileAccess3 > &	xSFI
	)

SfxLibrary() [2/2]

basic::SfxLibrary::SfxLibrary	(	ModifiableHelper &	_rModifiable,
		const css::uno::Type &	aType,
		const css::uno::Reference< css::ucb::XSimpleFileAccess3 > &	xSFI,
		OUString	aLibInfoFileURL,
		OUString	aStorageURL,
		bool	ReadOnly
	)

Member Function Documentation

acquire()

virtual void SAL_CALL basic::SfxLibrary::acquire ( )

inlineoverridevirtualnoexcept

Reimplemented from comphelper::WeakComponentImplHelper<>.

Definition at line 552 of file namecont.hxx.

addChangesListener()

void SAL_CALL basic::SfxLibrary::addChangesListener ( const css::uno::Reference< css::util::XChangesListener > &  xListener )

overridevirtual

Definition at line 3170 of file namecont.cxx.

References maNameContainer.

addContainerListener()

void SAL_CALL basic::SfxLibrary::addContainerListener ( const css::uno::Reference< css::container::XContainerListener > &  xListener )

overridevirtual

Definition at line 3158 of file namecont.cxx.

References maNameContainer.

getByName()

Any basic::SfxLibrary::getByName ( const OUString &  aName )

overridevirtual

Definition at line 3028 of file namecont.cxx.

References aName, Any, impl_checkLoaded(), and maNameContainer.

getElementNames()

Sequence< OUString > basic::SfxLibrary::getElementNames ( )

overridevirtual

Definition at line 3036 of file namecont.cxx.

References maNameContainer.

Referenced by basic::SfxScriptLibraryContainer::changeLibraryPassword(), basic::SfxLibraryContainer::exportLibrary(), basic::SfxLibraryContainer::loadLibrary(), basic::SfxLibraryContainer::removeLibrary(), and basic::SfxLibraryContainer::storeLibraries_Impl().

getElementType()

Type basic::SfxLibrary::getElementType ( )

overridevirtual

Definition at line 3016 of file namecont.cxx.

References maNameContainer.

getImplementationId()

Sequence< sal_Int8 > basic::SfxLibrary::getImplementationId ( )

overridevirtual

Reimplemented from comphelper::WeakComponentImplHelper<>.

Definition at line 3152 of file namecont.cxx.

getTypes()

Sequence< Type > basic::SfxLibrary::getTypes ( )

overridevirtual

Reimplemented from comphelper::WeakComponentImplHelper<>.

Definition at line 3140 of file namecont.cxx.

References cppu::OTypeCollection::getTypes().

hasByName()

sal_Bool basic::SfxLibrary::hasByName ( const OUString &  aName )

overridevirtual

Definition at line 3041 of file namecont.cxx.

References aName, and maNameContainer.

Referenced by basic::SfxLibraryContainer::loadLibrary().

hasElements()

sal_Bool basic::SfxLibrary::hasElements ( )

overridevirtual

Definition at line 3021 of file namecont.cxx.

References maNameContainer.

Referenced by basic::SfxLibraryContainer::isModified().

impl_checkLoaded()

void basic::SfxLibrary::impl_checkLoaded ( )

private

checks whether the library is loaded, throws a LibraryNotLoadedException (wrapped in a WrappedTargetException), if not.

Definition at line 3059 of file namecont.cxx.

References Any, and mbLoaded.

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

impl_checkReadOnly()

void basic::SfxLibrary::impl_checkReadOnly ( )

private

checks whether the lib is readonly, or a readonly link, throws an IllegalArgumentException if so

Definition at line 3047 of file namecont.cxx.

References mbLink, mbReadOnly, and mbReadOnlyLink.

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

impl_removeWithoutChecks()

void basic::SfxLibrary::impl_removeWithoutChecks ( const OUString &  _rElementName )

private

Definition at line 3103 of file namecont.cxx.

References INetURLObject::All, DBG_UNHANDLED_EXCEPTION, Exception, INetURLObject::GetMainURL(), implSetModified(), INetURLObject::insertName(), INetURLObject::LAST_SEGMENT, maLibElementFileExtension, maNameContainer, maStorageURL, mxSFI, INetURLObject::NONE, and INetURLObject::setExtension().

Referenced by removeByName(), and removeElementWithoutChecks().

implIsModified()

bool basic::SfxLibrary::implIsModified ( ) const

inlineprotected

Definition at line 520 of file namecont.hxx.

References mbIsModified.

Referenced by basic::SfxDialogLibrary::isModified(), basic::SfxScriptLibrary::isModified(), and basic::SfxLibraryContainer::storeLibraries_Impl().

implSetModified()

void basic::SfxLibrary::implSetModified ( bool  _bIsModified )

protected

Definition at line 2984 of file namecont.cxx.

References mbIsModified, mrModifiable, and basic::ModifiableHelper::setModified().

Referenced by basic::SfxScriptLibraryContainer::changeLibraryPassword(), impl_removeWithoutChecks(), basic::SfxLibraryContainer::init_Impl(), insertByName(), basic::SfxLibraryContainer::loadLibrary(), basic::SfxLibraryContainer::renameLibrary(), replaceByName(), basic::SfxLibraryContainer::setLibraryReadOnly(), basic::SfxLibraryContainer::storeLibraries_Impl(), and basic::SfxScriptLibraryContainer::verifyLibraryPassword().

insertByName()

void basic::SfxLibrary::insertByName ( const OUString &  aName, const css::uno::Any &  aElement  )

overridevirtual

Definition at line 3090 of file namecont.cxx.

References aName, impl_checkLoaded(), impl_checkReadOnly(), implSetModified(), isLibraryElementValid(), maNameContainer, and SAL_WARN_IF.

isLibraryElementValid()

virtual bool basic::SfxLibrary::isLibraryElementValid ( const css::uno::Any &  rElement ) const

protectedpure virtual

Implemented in basic::SfxDialogLibrary, and basic::SfxScriptLibrary.

Referenced by insertByName(), and replaceByName().

isLoadedStorable()

bool basic::SfxLibrary::isLoadedStorable ( )

protectedvirtual

Reimplemented in basic::SfxScriptLibrary.

Definition at line 2979 of file namecont.cxx.

References mbLoaded, mbPasswordProtected, and mbPasswordVerified.

Referenced by basic::SfxScriptLibrary::isLoadedStorable(), and basic::SfxLibraryContainer::storeLibraries_Impl().

isModified()

virtual bool basic::SfxLibrary::isModified ( )

privatepure virtual

Implemented in basic::SfxDialogLibrary, and basic::SfxScriptLibrary.

Referenced by basic::SfxLibraryContainer::isModified().

queryInterface()

Any SAL_CALL basic::SfxLibrary::queryInterface ( const css::uno::Type &  rType )

overridevirtual

Reimplemented from comphelper::WeakComponentImplHelper<>.

Definition at line 2998 of file namecont.cxx.

References Any.

release()

virtual void SAL_CALL basic::SfxLibrary::release ( )

inlineoverridevirtualnoexcept

Reimplemented from comphelper::WeakComponentImplHelper<>.

Definition at line 553 of file namecont.hxx.

removeByName()

void basic::SfxLibrary::removeByName ( const OUString &  Name )

overridevirtual

Definition at line 3132 of file namecont.cxx.

References impl_checkLoaded(), impl_checkReadOnly(), impl_removeWithoutChecks(), and Name.

removeChangesListener()

void SAL_CALL basic::SfxLibrary::removeChangesListener ( const css::uno::Reference< css::util::XChangesListener > &  xListener )

overridevirtual

Definition at line 3176 of file namecont.cxx.

References maNameContainer.

removeContainerListener()

void SAL_CALL basic::SfxLibrary::removeContainerListener ( const css::uno::Reference< css::container::XContainerListener > &  xListener )

overridevirtual

Definition at line 3164 of file namecont.cxx.

References maNameContainer.

removeElementWithoutChecks()

void basic::SfxLibrary::removeElementWithoutChecks ( const OUString &  _rElementName, LibraryContainerAccess    )

inline

Definition at line 589 of file namecont.hxx.

References impl_removeWithoutChecks().

Referenced by basic::SfxLibraryContainer::removeLibrary().

replaceByName()

void basic::SfxLibrary::replaceByName ( const OUString &  aName, const css::uno::Any &  aElement  )

overridevirtual

Definition at line 3075 of file namecont.cxx.

References aName, impl_checkLoaded(), impl_checkReadOnly(), implSetModified(), isLibraryElementValid(), maNameContainer, and SAL_WARN_IF.

storeResources()

virtual void basic::SfxLibrary::storeResources ( )

privatepure virtual

Implemented in basic::SfxDialogLibrary, and basic::SfxScriptLibrary.

storeResourcesAsURL()

virtual void basic::SfxLibrary::storeResourcesAsURL ( const OUString &  URL, const OUString &  NewName  )

privatepure virtual

Implemented in basic::SfxDialogLibrary, and basic::SfxScriptLibrary.

Referenced by basic::SfxLibraryContainer::renameLibrary().

storeResourcesToStorage()

virtual void basic::SfxLibrary::storeResourcesToStorage ( const css::uno::Reference< css::embed::XStorage > &  xStorage )

privatepure virtual

Implemented in basic::SfxDialogLibrary, and basic::SfxScriptLibrary.

storeResourcesToURL()

virtual void basic::SfxLibrary::storeResourcesToURL ( const OUString &  URL, const css::uno::Reference< css::task::XInteractionHandler > &  xHandler  )

privatepure virtual

Implemented in basic::SfxDialogLibrary, and basic::SfxScriptLibrary.

Friends And Related Function Documentation

SfxDialogLibraryContainer

friend class SfxDialogLibraryContainer

friend

Definition at line 475 of file namecont.hxx.

SfxLibraryContainer

friend class SfxLibraryContainer

friend

Definition at line 474 of file namecont.hxx.

SfxScriptLibraryContainer

friend class SfxScriptLibraryContainer

friend

Definition at line 476 of file namecont.hxx.

Member Data Documentation

maLibElementFileExtension

OUString basic::SfxLibrary::maLibElementFileExtension

private

Definition at line 489 of file namecont.hxx.

Referenced by impl_removeWithoutChecks().

maLibInfoFileURL

OUString basic::SfxLibrary::maLibInfoFileURL

private

Definition at line 490 of file namecont.hxx.

Referenced by basic::SfxLibraryContainer::getLibraryLinkURL(), basic::SfxLibraryContainer::init_Impl(), basic::SfxLibraryContainer::removeLibrary(), basic::SfxLibraryContainer::renameLibrary(), and basic::SfxLibraryContainer::storeLibraries_Impl().

maNameContainer

rtl::Reference<NameContainer> basic::SfxLibrary::maNameContainer

private

Definition at line 481 of file namecont.hxx.

Referenced by addChangesListener(), addContainerListener(), getByName(), getElementNames(), getElementType(), hasByName(), hasElements(), impl_removeWithoutChecks(), insertByName(), basic::SfxLibraryContainer::loadLibrary(), removeChangesListener(), removeContainerListener(), and replaceByName().

maOriginalStorageURL

OUString basic::SfxLibrary::maOriginalStorageURL

private

Definition at line 493 of file namecont.hxx.

Referenced by basic::SfxLibraryContainer::getOriginalLibraryLinkURL().

maPassword

OUString basic::SfxLibrary::maPassword

private

Definition at line 505 of file namecont.hxx.

Referenced by basic::SfxScriptLibraryContainer::changeLibraryPassword(), basic::SfxScriptLibraryContainer::setLibraryPassword(), and basic::SfxScriptLibraryContainer::verifyLibraryPassword().

maStorageURL

OUString basic::SfxLibrary::maStorageURL

private

Definition at line 491 of file namecont.hxx.

Referenced by impl_removeWithoutChecks(), basic::SfxLibraryContainer::init_Impl(), basic::SfxLibraryContainer::loadLibrary(), and basic::SfxLibraryContainer::renameLibrary().

maUnexpandedStorageURL

OUString basic::SfxLibrary::maUnexpandedStorageURL

private

Definition at line 492 of file namecont.hxx.

Referenced by basic::SfxLibraryContainer::init_Impl(), basic::SfxLibraryContainer::renameLibrary(), and basic::SfxLibraryContainer::storeLibraries_Impl().

mbDoc50Password

bool basic::SfxLibrary::mbDoc50Password

private

Definition at line 504 of file namecont.hxx.

Referenced by basic::SfxScriptLibraryContainer::changeLibraryPassword(), basic::SfxScriptLibraryContainer::setLibraryPassword(), and basic::SfxScriptLibraryContainer::verifyLibraryPassword().

mbExtension

bool basic::SfxLibrary::mbExtension

private

Definition at line 508 of file namecont.hxx.

Referenced by basic::SfxLibraryContainer::storeLibraries_Impl().

mbInitialised

bool basic::SfxLibrary::mbInitialised

private

Definition at line 485 of file namecont.hxx.

Referenced by basic::SfxLibraryContainer::init_Impl().

mbIsModified

bool basic::SfxLibrary::mbIsModified

private

Definition at line 484 of file namecont.hxx.

Referenced by implIsModified(), and implSetModified().

mbLink

bool basic::SfxLibrary::mbLink

private

Definition at line 495 of file namecont.hxx.

Referenced by basic::SfxScriptLibraryContainer::changeLibraryPassword(), basic::SfxLibraryContainer::getLibraryLinkURL(), basic::SfxLibraryContainer::getOriginalLibraryLinkURL(), impl_checkReadOnly(), basic::SfxLibraryContainer::init_Impl(), basic::SfxLibraryContainer::isLibraryLink(), basic::SfxLibraryContainer::isLibraryReadOnly(), basic::SfxLibraryContainer::loadLibrary(), basic::SfxLibraryContainer::removeLibrary(), basic::SfxLibraryContainer::renameLibrary(), basic::SfxLibraryContainer::setLibraryReadOnly(), and basic::SfxLibraryContainer::storeLibraries_Impl().

mbLoaded

bool basic::SfxLibrary::mbLoaded

private

Definition at line 483 of file namecont.hxx.

Referenced by basic::SfxScriptLibraryContainer::changeLibraryPassword(), impl_checkLoaded(), basic::SfxScriptLibraryContainer::implLoadPasswordLibrary(), basic::SfxLibraryContainer::init_Impl(), basic::SfxLibraryContainer::isLibraryLoaded(), isLoadedStorable(), basic::SfxLibraryContainer::loadLibrary(), basic::SfxScriptLibraryContainer::setLibraryPassword(), and basic::SfxScriptLibraryContainer::verifyLibraryPassword().

mbPasswordProtected

bool basic::SfxLibrary::mbPasswordProtected

protected

Definition at line 501 of file namecont.hxx.

Referenced by basic::SfxScriptLibraryContainer::changeLibraryPassword(), basic::SfxLibraryContainer::exportLibrary(), basic::SfxScriptLibraryContainer::isLibraryPasswordProtected(), basic::SfxScriptLibraryContainer::isLibraryPasswordVerified(), isLoadedStorable(), basic::SfxScriptLibrary::isLoadedStorable(), basic::SfxLibraryContainer::loadLibrary(), basic::SfxLibraryContainer::renameLibrary(), basic::SfxScriptLibraryContainer::setLibraryPassword(), basic::SfxLibraryContainer::storeLibraries_Impl(), and basic::SfxScriptLibraryContainer::verifyLibraryPassword().

mbPasswordVerified

bool basic::SfxLibrary::mbPasswordVerified

private

Definition at line 503 of file namecont.hxx.

Referenced by basic::SfxScriptLibraryContainer::changeLibraryPassword(), basic::SfxScriptLibraryContainer::isLibraryPasswordVerified(), isLoadedStorable(), basic::SfxLibraryContainer::renameLibrary(), and basic::SfxScriptLibraryContainer::verifyLibraryPassword().

mbPreload

bool basic::SfxLibrary::mbPreload

private

Definition at line 498 of file namecont.hxx.

Referenced by basic::SfxLibraryContainer::init_Impl(), and basic::SfxLibraryContainer::storeLibraries_Impl().

mbReadOnly

bool basic::SfxLibrary::mbReadOnly

private

Definition at line 496 of file namecont.hxx.

Referenced by basic::SfxScriptLibraryContainer::changeLibraryPassword(), basic::SfxLibraryContainer::exportLibrary(), impl_checkReadOnly(), basic::SfxDialogLibraryContainer::implCreateStringResource(), basic::SfxLibraryContainer::init_Impl(), basic::SfxLibraryContainer::isLibraryReadOnly(), basic::SfxLibraryContainer::removeLibrary(), basic::SfxLibraryContainer::setLibraryReadOnly(), and basic::SfxLibraryContainer::storeLibraries_Impl().

mbReadOnlyLink

bool basic::SfxLibrary::mbReadOnlyLink

private

Definition at line 497 of file namecont.hxx.

Referenced by impl_checkReadOnly(), basic::SfxLibraryContainer::isLibraryReadOnly(), basic::SfxLibraryContainer::setLibraryReadOnly(), and basic::SfxLibraryContainer::storeLibraries_Impl().

mbSharedIndexFile

bool basic::SfxLibrary::mbSharedIndexFile

private

Definition at line 507 of file namecont.hxx.

Referenced by basic::SfxLibraryContainer::init_Impl(), and basic::SfxLibraryContainer::storeLibraries_Impl().

mrModifiable

ModifiableHelper& basic::SfxLibrary::mrModifiable

private

Definition at line 480 of file namecont.hxx.

Referenced by implSetModified().

mxSFI

css::uno::Reference< css::ucb::XSimpleFileAccess3 > basic::SfxLibrary::mxSFI

private

Definition at line 478 of file namecont.hxx.

Referenced by impl_removeWithoutChecks().

---

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

• namecont.hxx
• namecont.cxx