Provides access to settings of a document. More...

#include <IDocumentSettingAccess.hxx>

Inheritance diagram for IDocumentSettingAccess:

Public Member Functions
virtual bool	get (DocumentSettingId id) const =0
	Return the specified document setting. More...

virtual void	set (DocumentSettingId id, bool value)=0
	Set the specified document setting. More...

virtual const css::i18n::ForbiddenCharacters *	getForbiddenCharacters (LanguageType nLang, bool bLocaleData) const =0
	Return the forbidden characters. More...

virtual void	setForbiddenCharacters (LanguageType nLang, const css::i18n::ForbiddenCharacters &rForbiddenCharacters)=0
	Set the forbidden characters. More...

virtual std::shared_ptr< SvxForbiddenCharactersTable > &	getForbiddenCharacterTable ()=0
	Get the forbidden character table and creates one if necessary. More...

virtual const std::shared_ptr< SvxForbiddenCharactersTable > &	getForbiddenCharacterTable () const =0
	Get the forbidden character table. More...

virtual sal_uInt16	getLinkUpdateMode (bool bGlobalSettings) const =0
	Get the current link update mode. More...

virtual void	setLinkUpdateMode (sal_uInt16 nMode)=0
	Set the current link update mode. More...

virtual SwFieldUpdateFlags	getFieldUpdateFlags (bool bGlobalSettings) const =0
	Get the current field update mode. More...

virtual void	setFieldUpdateFlags (SwFieldUpdateFlags nMode)=0
	Set the current field update mode. More...

virtual CharCompressType	getCharacterCompressionType () const =0
	Get the character compression type for Asian characters. More...

virtual void	setCharacterCompressionType (CharCompressType nType)=0
	Set the character compression type for Asian characters. More...

virtual sal_uInt32	Getn32DummyCompatibilityOptions1 () const =0
	Get the n32DummyCompatibilityOptions1. More...

virtual void	Setn32DummyCompatibilityOptions1 (const sal_uInt32 CompatibilityOptions1)=0
	Set the n32DummyCompatibilityOptions1. More...

virtual sal_uInt32	Getn32DummyCompatibilityOptions2 () const =0
	Get the n32DummyCompatibilityOptions2. More...

virtual void	Setn32DummyCompatibilityOptions2 (const sal_uInt32 CompatibilityOptions2)=0
	Set the n32DummyCompatibilityOptions2. More...

virtual sal_Int32	getImagePreferredDPI ()=0

virtual void	setImagePreferredDPI (sal_Int32 nValue)=0

Protected Member Functions
virtual	~IDocumentSettingAccess ()

Detailed Description

Provides access to settings of a document.

Definition at line 134 of file IDocumentSettingAccess.hxx.

Constructor & Destructor Documentation

◆ ~IDocumentSettingAccess()

virtual IDocumentSettingAccess::~IDocumentSettingAccess ( )

inlineprotectedvirtual

Definition at line 272 of file IDocumentSettingAccess.hxx.

Member Function Documentation

◆ get()

virtual bool IDocumentSettingAccess::get ( DocumentSettingId id ) const

pure virtual

Return the specified document setting.

Parameters

id	[in] the identifier of the document setting to be returned. See above for a list of valid document setting identifiers.

Returns: the value of the requested document setting.

Implemented in sw::DocumentSettingManager.

Referenced by SwXDocumentSettings::_getSingleValue(), SwFootnoteBossFrame::AppendFootnote(), SwModule::ApplyItemSet(), CalcClipRect(), SwTextAdjuster::CalcFlyAdjust(), SwTabFrame::CalcFlyOffsets(), SwTextFormatter::CalcFlyWidth(), SwDropCapCache::CalcFontSize(), SwTextFrame::CalcHeightOfLastLine(), CalcHeightWithFlys(), SwBorderAttrs::CalcLeft(), SwLineLayout::CalcLine(), SwTextAdjuster::CalcNewBlock(), SwTextFormatter::CalcRealHeight(), SwPostItMgr::CalcRects(), SwBorderAttrs::CalcRight(), SwBorderAttrs::CalcTop_(), checkApplyParagraphMarkFormatToNumbering(), SwFlyFreeFrame::CheckClip(), SwFootnoteBossFrame::CollectFootnotes_(), SwTextFrame::ConnectFootnote(), SwAnchoredObject::ConsiderObjWrapInfluenceOnObjPos(), SwDocShell::ConvertTo(), SwLineInfo::CtorInitLineInfo(), SwTextMargin::CtorInitTextMargin(), SwTextSizeInfo::CtorInitTextSizeInfo(), SwTextPainter::DrawTextLine(), SwDocShell::Edit(), SwContentTree::EditEntry(), DocxAttributeOutput::EmbedFont(), SwBaseShell::Execute(), SwFrameShell::Execute(), SwTextShell::Execute(), SwView::ExecuteStatusLine(), SwXMLExport::exportDoc(), RtfExport::ExportDocument_Impl(), WW8Export::ExportDopTypography(), SwDocStyleSheetPool::Find(), SwFrame::FindFootnoteBossFrame(), SwStyleSheetIterator::First(), SwAttrHandler::FontChg(), SwNumberPortion::Format(), SwTextPortion::Format_(), AttributeOutputBase::FormatBreak(), SwOleClient::FormatChanged(), SwCompatibilityOptPage::GetDocumentOptions(), SwBlankPortion::GetExpText(), SwFntObj::GetFontLeading(), SwTextFly::GetFrameArea(), objectpositioning::SwAnchoredObjectPosition::GetInfoAboutObj(), SwTextFormatInfo::GetLineWidth(), SwTextFrame::GetLowerMarginForFlyIntersect(), MSWordExportBase::GetParaTabStopOffset(), SwFrame::GetPrevFootnoteLeaf(), SwDocShell::GetState(), SwTextShell::GetState(), SwTextFly::GetSurroundForTextWrap(), HTMLReader::GetTemplateName(), SwTextFly::GetTop(), SwXMLExport::GetViewSettings(), SwTextGuess::Guess(), SwPaM::HasReadonlySel(), impl_borders(), IMPL_LINK_NOARG(), objectpositioning::SwAnchoredObjectPosition::ImplAdjustVertRelPos(), SwRootFrame::Init(), SwTextFly::InitAnchoredObjList(), sw::DocumentDrawModelManager::InitDrawModel(), SwAnchoredObject::IsDraggingOffPageAllowed(), SwFlyFrame::IsFlySplitAllowed(), SwCursorShell::IsFormProtected(), SwEditShell::IsGlblDocSaveLinks(), SwEditShell::IsGlobalDoc(), SwEditShell::IsLabelDoc(), SwPostItMgr::LayoutPostIts(), lcl_CalcAutoWidth(), lcl_SetDfltBoxAttr(), SwAnchoredDrawObject::MakeObjPosAnchoredAtPara(), SwTextFormatter::NewNumberPortion(), SwTextFormatter::NewTabPortion(), SwHTMLWriter::OutCSS1_FrameFormatBackground(), MSWordExportBase::OutputTextNode(), SwBlankPortion::Paint(), SwFrame::PaintBorderLine(), SwNoTextFrame::PaintSwFrame(), SwFrame::PaintSwFrameBackground(), SwFrame::PaintSwFrameShadowAndBorder(), SwTabPortion::PostFormat(), SwTabPortion::PreFormat(), SwPostItMgr::PrepareView(), sw::DocumentDeviceManager::PrtDataChanged(), HTMLReader::Read(), XMLReader::Read(), SwShdwCursorOptionsTabPage::Reset(), SwTextFormatInfo::ScanPortionEnd(), DocxAttributeOutput::SectionPageBorders(), SwViewShell::SetAddExtLeading(), SwViewShell::SetAddParaSpacingToTableCells(), SwViewShell::SetConsiderWrapOnObjPos(), SwFont::SetDiffFnt(), SwViewShell::SetDoNotJustifyLinesWithManualBreak(), SwViewShell::SetEmptyDbFieldHidesPara(), SwViewShell::SetMsWordCompTrailingBlanks(), SwViewShell::SetParaSpaceMax(), SwViewShell::SetParaSpaceMaxAtPages(), SwViewShell::SetTabCompat(), SwViewShell::SetUseFormerLineSpacing(), SwViewShell::SetUseFormerObjectPositioning(), SwViewShell::SetUseFormerTextWrapping(), SwContentFrame::ShouldBwdMoved(), SwView::StateTabWin(), SwContentNotify::SwContentNotify(), SwContentType::SwContentType(), SwFont::SwFont(), SwInsertBookmarkDlg::SwInsertBookmarkDlg(), SwView::SwView(), SwContentFrame::UpdateAttr_(), WidowsAndOrphans::WidowsAndOrphans(), SwContentFrame::WouldFit_(), WriteCompat(), WriteDop(), SwEscherEx::WriteFlyFrame(), DocxExport::WriteSettings(), and SwHTMLWriter::WriteStream().

◆ getCharacterCompressionType()

virtual CharCompressType IDocumentSettingAccess::getCharacterCompressionType ( ) const

pure virtual

Get the character compression type for Asian characters.

Returns: the current character compression mode.

Implemented in sw::DocumentSettingManager.

Referenced by SwXDocumentSettings::_getSingleValue(), WW8Export::ExportDopTypography(), and SwScriptInfo::InitScriptInfo().

◆ getFieldUpdateFlags()

virtual SwFieldUpdateFlags IDocumentSettingAccess::getFieldUpdateFlags ( bool bGlobalSettings ) const

pure virtual

Get the current field update mode.

Parameters

bGlobalSettings [in] if set, the field update mode is obtained from the module, if it is set to GLOBALSETTING

Returns: the current field update mode.

Implemented in sw::DocumentSettingManager.

Referenced by SwXDocumentSettings::_getSingleValue(), SwXDocumentSettings::_setSingleValue(), SwDDETable::ChangeContent(), and SwEditShell::GetFieldUpdateFlags().

◆ getForbiddenCharacters()

virtual const css::i18n::ForbiddenCharacters * IDocumentSettingAccess::getForbiddenCharacters	(	LanguageType	nLang,
		bool	bLocaleData
	)		const

pure virtual

Return the forbidden characters.

Parameters

nLang	[in] the language for which the forbidden character list is returned.
bLocaleData	[in] if set and there is no user defined forbidden character list for language lang, the default list for language lang will be returned.

Returns: a list of forbidden characters.

Implemented in sw::DocumentSettingManager.

Referenced by WW8Export::ExportDopTypography(), and SwTextGuess::Guess().

◆ getForbiddenCharacterTable() [1/2]

virtual const std::shared_ptr< SvxForbiddenCharactersTable > & IDocumentSettingAccess::getForbiddenCharacterTable ( ) const

pure virtual

Get the forbidden character table.

Returns: the forbidden characters table.

Implemented in sw::DocumentSettingManager.

◆ getForbiddenCharacterTable() [2/2]

virtual std::shared_ptr< SvxForbiddenCharactersTable > & IDocumentSettingAccess::getForbiddenCharacterTable ( )

pure virtual

Get the forbidden character table and creates one if necessary.

Returns: the forbidden characters table.

Implemented in sw::DocumentSettingManager.

◆ getImagePreferredDPI()

virtual sal_Int32 IDocumentSettingAccess::getImagePreferredDPI ( )

pure virtual

Implemented in sw::DocumentSettingManager.

Referenced by SwXDocumentSettings::_getSingleValue(), sw::GraphicSizeCheck::check(), SwBaseShell::GetState(), and SwFrameDlg::PageCreated().

◆ getLinkUpdateMode()

virtual sal_uInt16 IDocumentSettingAccess::getLinkUpdateMode ( bool bGlobalSettings ) const

pure virtual

Get the current link update mode.

Parameters

bGlobalSettings [in] if set, the link update mode is obtained from the module, if it is set to GLOBALSETTING

Returns: the current link update mode.

Implemented in sw::DocumentSettingManager.

Referenced by SwXDocumentSettings::_getSingleValue(), and SwEditShell::GetLinkUpdMode().

◆ Getn32DummyCompatibilityOptions1()

virtual sal_uInt32 IDocumentSettingAccess::Getn32DummyCompatibilityOptions1 ( ) const

pure virtual

Get the n32DummyCompatibilityOptions1.

Implemented in sw::DocumentSettingManager.

Referenced by WriteDop().

◆ Getn32DummyCompatibilityOptions2()

virtual sal_uInt32 IDocumentSettingAccess::Getn32DummyCompatibilityOptions2 ( ) const

pure virtual

Get the n32DummyCompatibilityOptions2.

Implemented in sw::DocumentSettingManager.

Referenced by WriteDop().

◆ set()

virtual void IDocumentSettingAccess::set	(	DocumentSettingId	id,
		bool	value
	)

pure virtual

Set the specified document setting.

Parameters

id	[in] the identifier of the document setting to be set. See above for a list of valid document setting identifiers.
value	[in] the new value of the specified document setting.

Implemented in sw::DocumentSettingManager.

◆ setCharacterCompressionType()

virtual void IDocumentSettingAccess::setCharacterCompressionType ( CharCompressType nType )

pure virtual

Set the character compression type for Asian characters.

Parameters

nMode [in] the new character compression type.

Implemented in sw::DocumentSettingManager.

Referenced by SwXDocumentSettings::_setSingleValue(), and SwWW8ImplReader::ImportDopTypography().

◆ setFieldUpdateFlags()

virtual void IDocumentSettingAccess::setFieldUpdateFlags ( SwFieldUpdateFlags nMode )

pure virtual

Set the current field update mode.

Parameters

nMode [in] the new field update mode.

Implemented in sw::DocumentSettingManager.

Referenced by SwXDocumentSettings::_setSingleValue(), and SwEditShell::SetFieldUpdateFlags().

◆ setForbiddenCharacters()

virtual void IDocumentSettingAccess::setForbiddenCharacters	(	LanguageType	nLang,
		const css::i18n::ForbiddenCharacters &	rForbiddenCharacters
	)

pure virtual

Set the forbidden characters.

Parameters

nLang	[in] the language for which the forbidden character list should be set.
rForbiddenCharacters	[in] the new list of forbidden characters for language lang.

Implemented in sw::DocumentSettingManager.

Referenced by SwWW8ImplReader::ImportDopTypography().