LibreOffice Module sw (master)  1
Public Member Functions | Protected Member Functions | List of all members
IDocumentSettingAccess Class Referenceabstract

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

#include <IDocumentSettingAccess.hxx>

Inheritance diagram for IDocumentSettingAccess:
[legend]

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 n32DummyCompatabilityOptions1. More...
 
virtual void Setn32DummyCompatibilityOptions1 (const sal_uInt32 CompatibilityOptions1)=0
 Set the n32DummyCompatabilityOptions1. More...
 
virtual sal_uInt32 Getn32DummyCompatibilityOptions2 () const =0
 Get the n32DummyCompatabilityOptions2. More...
 
virtual void Setn32DummyCompatibilityOptions2 (const sal_uInt32 CompatibilityOptions2)=0
 Set the n32DummyCompatabilityOptions2. More...
 

Protected Member Functions

virtual ~IDocumentSettingAccess ()
 

Detailed Description

Provides access to settings of a document.

Definition at line 109 of file IDocumentSettingAccess.hxx.

Constructor & Destructor Documentation

virtual IDocumentSettingAccess::~IDocumentSettingAccess ( )
inlineprotectedvirtual

Definition at line 241 of file IDocumentSettingAccess.hxx.

Member Function Documentation

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(), SwModule::ApplyItemSet(), SwFlowFrame::CalcAddLowerSpaceAsLastInTableCell(), CalcClipRect(), CalcContent(), SwTextAdjuster::CalcFlyAdjust(), SwTabFrame::CalcFlyOffsets(), SwTextFormatter::CalcFlyWidth(), SwTextFrame::CalcHeightOfLastLine(), SwLineLayout::CalcLine(), SwTextAdjuster::CalcNewBlock(), SwTextFormatter::CalcRealHeight(), SwPostItMgr::CalcRects(), SwFlowFrame::CalcUpperSpace(), checkApplyParagraphMarkFormatToNumbering(), SwFlyFreeFrame::CheckClip(), SwAnchoredObject::ConsiderObjWrapInfluenceOnObjPos(), SwDocShell::ConvertTo(), SwLineInfo::CtorInitLineInfo(), SwTextMargin::CtorInitTextMargin(), SwFrameShell::Execute(), SwTextShell::Execute(), SwBaseShell::Execute(), SwView::ExecuteStatusLine(), SwXMLExport::exportDoc(), RtfExport::ExportDocument_Impl(), WW8Export::ExportDopTypography(), SwDocStyleSheetPool::Find(), SwStyleSheetIterator::First(), SwAttrHandler::FontChg(), SwNumberPortion::Format(), SwTextPortion::Format_(), SwOleClient::FormatChanged(), SwTextCursor::GetCharRect(), SwCompatibilityOptPage::GetDocumentOptions(), SwFntObj::GetFontLeading(), objectpositioning::SwAnchoredObjectPosition::GetInfoAboutObj(), SwTextFormatInfo::GetLineWidth(), SwDocShell::GetState(), SwTextFly::GetSurroundForTextWrap(), HTMLReader::GetTemplateName(), SwTextFly::GetTop(), SwFlowFrame::GetUpperSpaceAmountConsideredForPrevFrame(), SwFlowFrame::GetUpperSpaceAmountConsideredForPrevFrameAndPageGrid(), SwXMLExport::GetViewSettings(), SwTextGuess::Guess(), objectpositioning::SwAnchoredObjectPosition::ImplAdjustVertRelPos(), SwRootFrame::Init(), SwTextFly::InitAnchoredObjList(), sw::DocumentDrawModelManager::InitDrawModel(), SwEditShell::IsGlblDocSaveLinks(), SwEditShell::IsGlobalDoc(), SwEditShell::IsLabelDoc(), SwFlowFrame::IsPageBreak(), SwPostItMgr::LayoutPostIts(), lcl_SetDfltBoxAttr(), SwAnchoredDrawObject::MakeObjPosAnchoredAtPara(), SwTextFormatter::NewNumberPortion(), SwTextFormatter::NewPortion(), SwTextFormatter::NewTabPortion(), MSWordExportBase::OutputTextNode(), SwFrame::PaintBorderLine(), SwNoTextFrame::PaintSwFrame(), SwFrame::PaintSwFrameBackground(), WW8AttributeOutput::ParaTabStop(), SwTabPortion::PostFormat(), SwTabPortion::PreFormat(), SwPostItMgr::PrepareView(), sw::DocumentDeviceManager::PrtDataChanged(), HTMLReader::Read(), XMLReader::Read(), SwShdwCursorOptionsTabPage::Reset(), SwTextFormatInfo::ScanPortionEnd(), SwFlyAtContentFrame::SetAbsPos(), 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(), SwViewShell::SetUseVirDev(), SwContentFrame::ShouldBwdMoved(), SwView::StateTabWin(), sw_HideObj(), SwContentNotify::SwContentNotify(), SwFont::SwFont(), SwView::SwView(), SwContentFrame::UpdateAttr_(), SwTextFormatter::WhichFirstPortion(), SwContentFrame::WouldFit_(), SwWriter::Write(), WriteDop(), SwEscherEx::WriteFlyFrame(), and SwHTMLWriter::WriteStream().

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(), and SwScriptInfo::InitScriptInfo().

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().

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 SwTextGuess::Guess().

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.

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.

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().

virtual sal_uInt32 IDocumentSettingAccess::Getn32DummyCompatibilityOptions1 ( ) const
pure virtual

Get the n32DummyCompatabilityOptions1.

Implemented in sw::DocumentSettingManager.

Referenced by WriteDop().

virtual sal_uInt32 IDocumentSettingAccess::Getn32DummyCompatibilityOptions2 ( ) const
pure virtual

Get the n32DummyCompatabilityOptions2.

Implemented in sw::DocumentSettingManager.

Referenced by WriteDop().

virtual void IDocumentSettingAccess::set ( DocumentSettingId  id,
bool  value 
)
pure virtual
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().

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().

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().

virtual void IDocumentSettingAccess::setLinkUpdateMode ( sal_uInt16  nMode)
pure virtual

Set the current link update mode.

Parameters
nMode[in] the new link update mode.

Implemented in sw::DocumentSettingManager.

Referenced by SwXDocumentSettings::_setSingleValue().

virtual void IDocumentSettingAccess::Setn32DummyCompatibilityOptions1 ( const sal_uInt32  CompatibilityOptions1)
pure virtual

Set the n32DummyCompatabilityOptions1.

Implemented in sw::DocumentSettingManager.

Referenced by SwWW8ImplReader::ImportDop().

virtual void IDocumentSettingAccess::Setn32DummyCompatibilityOptions2 ( const sal_uInt32  CompatibilityOptions2)
pure virtual

Set the n32DummyCompatabilityOptions2.

Implemented in sw::DocumentSettingManager.

Referenced by SwWW8ImplReader::ImportDop().


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