Document protection restrictions. More...

#include <DocumentProtection.hxx>

Inheritance diagram for writerfilter::dmapper::DocumentProtection:

Collaboration diagram for writerfilter::dmapper::DocumentProtection:

Public Member Functions
	DocumentProtection ()

virtual	~DocumentProtection () override

css::uno::Sequence< css::beans::PropertyValue >	toSequence () const

bool	getProtectForm () const

bool	getRedlineProtection () const

bool	getReadOnly () const

bool	getEnforcement () const

Public Member Functions inherited from writerfilter::LoggedProperties
	LoggedProperties (const std::string &sPrefix)

virtual	~LoggedProperties () override

void	attribute (Id name, Value &val) override
	Receives an attribute. More...

void	sprm (Sprm &sprm) override
	Receives a SPRM. More...

virtual void	attribute (Id name, Value &val)=0
	Receives an attribute. More...

virtual void	sprm (Sprm &sprm)=0
	Receives a SPRM. More...

Public Member Functions inherited from SvRefBase
	SvRefBase ()

	SvRefBase (const SvRefBase &)

SvRefBase &	operator= (const SvRefBase &)

void	RestoreNoDelete ()

void	AddNextRef ()

void	AddFirstRef ()

void	ReleaseRef ()

unsigned int	GetRefCount () const

Private Member Functions
virtual void	lcl_attribute (Id Name, Value &val) override

virtual void	lcl_sprm (Sprm &sprm) override

bool	enabled () const

bool	isNone () const

Private Attributes
sal_Int32	m_nEdit
	Document Editing Restrictions. More...

bool	m_bProtectForm

bool	m_bRedlineProtection

OUString	m_sRedlineProtectionKey

bool	m_bReadOnly

bool	m_bEnforcement

bool	m_bFormatting

sal_Int32	m_nCryptProviderType
	Provider type. More...

OUString	m_sCryptAlgorithmClass

OUString	m_sCryptAlgorithmType

OUString	m_sCryptAlgorithmSid

sal_Int32	m_CryptSpinCount

OUString	m_sHash

OUString	m_sSalt

Additional Inherited Members
virtual void	lcl_attribute (Id name, Value &val)=0

virtual void	lcl_sprm (Sprm &sprm)=0

Protected Member Functions inherited from writerfilter::Properties
	~Properties () override

Protected Member Functions inherited from SvRefBase
virtual	~SvRefBase () COVERITY_NOEXCEPT_FALSE

Detailed Description

Document protection restrictions.

This element specifies the set of document protection restrictions which have been applied to the contents of a WordprocessingML document.These restrictions should be enforced by applications editing this document when the enforcement attribute is turned on, and ignored(but persisted) otherwise.Document protection is a set of restrictions used to prevent unintentional changes to all or part of a WordprocessingML document.

Definition at line 35 of file DocumentProtection.hxx.

Constructor & Destructor Documentation

◆ DocumentProtection()

writerfilter::dmapper::DocumentProtection::DocumentProtection ( )

Definition at line 29 of file DocumentProtection.cxx.

References m_bReadOnly.

◆ ~DocumentProtection()

writerfilter::dmapper::DocumentProtection::~DocumentProtection ( )

overridevirtual

Definition at line 46 of file DocumentProtection.cxx.

Member Function Documentation

◆ enabled()

bool writerfilter::dmapper::DocumentProtection::enabled ( ) const

inlineprivate

Definition at line 72 of file DocumentProtection.hxx.

References isNone().

Referenced by toSequence().

◆ getEnforcement()

bool writerfilter::dmapper::DocumentProtection::getEnforcement ( ) const

inline

Definition at line 84 of file DocumentProtection.hxx.

References m_bEnforcement.

◆ getProtectForm()

bool writerfilter::dmapper::DocumentProtection::getProtectForm ( ) const

inline

Definition at line 81 of file DocumentProtection.hxx.

References m_bProtectForm.

◆ getReadOnly()

bool writerfilter::dmapper::DocumentProtection::getReadOnly ( ) const

inline

Definition at line 83 of file DocumentProtection.hxx.

References m_bReadOnly.

◆ getRedlineProtection()

bool writerfilter::dmapper::DocumentProtection::getRedlineProtection ( ) const

inline

Definition at line 82 of file DocumentProtection.hxx.

References m_bRedlineProtection.

◆ isNone()

bool writerfilter::dmapper::DocumentProtection::isNone ( ) const

inlineprivate

Definition at line 73 of file DocumentProtection.hxx.

References m_nEdit.

Referenced by enabled().

◆ lcl_attribute()

void writerfilter::dmapper::DocumentProtection::lcl_attribute	(	Id	Name,
		Value &	val
	)

overrideprivatevirtual

◆ lcl_sprm()

void writerfilter::dmapper::DocumentProtection::lcl_sprm ( Sprm & sprm )

overrideprivatevirtual

Implements writerfilter::LoggedProperties.

Definition at line 115 of file DocumentProtection.cxx.

◆ toSequence()

uno::Sequence< beans::PropertyValue > writerfilter::dmapper::DocumentProtection::toSequence ( ) const

Definition at line 117 of file DocumentProtection.cxx.

References comphelper::containerToSequence(), writerfilter::TagLogger::element(), enabled(), writerfilter::TagLogger::getInstance(), m_bEnforcement, m_bFormatting, m_CryptSpinCount, m_nCryptProviderType, m_nEdit, m_sCryptAlgorithmClass, m_sCryptAlgorithmSid, m_sCryptAlgorithmType, m_sHash, and m_sSalt.

Member Data Documentation

◆ m_bEnforcement

bool writerfilter::dmapper::DocumentProtection::m_bEnforcement

private

Definition at line 52 of file DocumentProtection.hxx.

Referenced by getEnforcement(), lcl_attribute(), and toSequence().

◆ m_bFormatting

bool writerfilter::dmapper::DocumentProtection::m_bFormatting

private

Definition at line 53 of file DocumentProtection.hxx.

Referenced by lcl_attribute(), and toSequence().

◆ m_bProtectForm

bool writerfilter::dmapper::DocumentProtection::m_bProtectForm

private

Definition at line 48 of file DocumentProtection.hxx.

Referenced by getProtectForm(), and lcl_attribute().

◆ m_bReadOnly

bool writerfilter::dmapper::DocumentProtection::m_bReadOnly

private

Definition at line 51 of file DocumentProtection.hxx.

Referenced by getReadOnly(), and lcl_attribute().

◆ m_bRedlineProtection

bool writerfilter::dmapper::DocumentProtection::m_bRedlineProtection

private

Definition at line 49 of file DocumentProtection.hxx.

Referenced by getRedlineProtection(), and lcl_attribute().

◆ m_CryptSpinCount

sal_Int32 writerfilter::dmapper::DocumentProtection::m_CryptSpinCount

private

Definition at line 65 of file DocumentProtection.hxx.

Referenced by lcl_attribute(), and toSequence().

◆ m_nCryptProviderType

sal_Int32 writerfilter::dmapper::DocumentProtection::m_nCryptProviderType

private

Provider type.

Possible values: "rsaAES" - NS_ooxml::LN_Value_doc_ST_CryptProv_rsaAES "rsaFull" - NS_ooxml::LN_Value_doc_ST_CryptProv_rsaFull

Definition at line 61 of file DocumentProtection.hxx.

Referenced by lcl_attribute(), and toSequence().

◆ m_nEdit

sal_Int32 writerfilter::dmapper::DocumentProtection::m_nEdit

private

Document Editing Restrictions.

Possible values:

NS_ooxml::LN_Value_doc_ST_DocProtect_none
NS_ooxml::LN_Value_doc_ST_DocProtect_readOnly
NS_ooxml::LN_Value_doc_ST_DocProtect_comments
NS_ooxml::LN_Value_doc_ST_DocProtect_trackedChanges
NS_ooxml::LN_Value_doc_ST_DocProtect_forms

Definition at line 47 of file DocumentProtection.hxx.

Referenced by isNone(), lcl_attribute(), and toSequence().

◆ m_sCryptAlgorithmClass

OUString writerfilter::dmapper::DocumentProtection::m_sCryptAlgorithmClass

private

Definition at line 62 of file DocumentProtection.hxx.

Referenced by lcl_attribute(), and toSequence().

◆ m_sCryptAlgorithmSid

OUString writerfilter::dmapper::DocumentProtection::m_sCryptAlgorithmSid

private

Definition at line 64 of file DocumentProtection.hxx.

Referenced by lcl_attribute(), and toSequence().

◆ m_sCryptAlgorithmType

OUString writerfilter::dmapper::DocumentProtection::m_sCryptAlgorithmType

private

Definition at line 63 of file DocumentProtection.hxx.

Referenced by lcl_attribute(), and toSequence().

◆ m_sHash

OUString writerfilter::dmapper::DocumentProtection::m_sHash

private

Definition at line 66 of file DocumentProtection.hxx.

Referenced by lcl_attribute(), and toSequence().

◆ m_sRedlineProtectionKey

OUString writerfilter::dmapper::DocumentProtection::m_sRedlineProtectionKey

private

Definition at line 50 of file DocumentProtection.hxx.

Referenced by lcl_attribute().

◆ m_sSalt

OUString writerfilter::dmapper::DocumentProtection::m_sSalt

private

Definition at line 67 of file DocumentProtection.hxx.

Referenced by lcl_attribute(), and toSequence().

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DocumentProtection()

◆ ~DocumentProtection()

Member Function Documentation

◆ enabled()

◆ getEnforcement()

◆ getProtectForm()

◆ getReadOnly()

◆ getRedlineProtection()

◆ isNone()

◆ lcl_attribute()

◆ lcl_sprm()

◆ toSequence()

Member Data Documentation

◆ m_bEnforcement

◆ m_bFormatting

◆ m_bProtectForm

◆ m_bReadOnly

◆ m_bRedlineProtection

◆ m_CryptSpinCount

◆ m_nCryptProviderType

◆ m_nEdit

◆ m_sCryptAlgorithmClass

◆ m_sCryptAlgorithmSid

◆ m_sCryptAlgorithmType

◆ m_sHash

◆ m_sRedlineProtectionKey

◆ m_sSalt