#include <pathoptions.hxx>

Inheritance diagram for SvtPathOptions:

Collaboration diagram for SvtPathOptions:

Public Types
enum class	Paths : sal_uInt16 { AddIn , AutoCorrect , AutoText , Backup , Basic , Bitmap , Config , Dictionary , Favorites , Filter , Gallery , Graphic , Help , IconSet , Linguistic , Module , Palette , Plugin , Storage , Temp , Template , UserConfig , Work , Classification , UIConfig , Fingerprint , NumberText , LAST }

Public Member Functions
	SvtPathOptions ()

virtual	~SvtPathOptions () override

const OUString &	GetAddinPath () const

const OUString &	GetAutoCorrectPath () const

const OUString &	GetAutoTextPath () const

const OUString &	GetBackupPath () const

const OUString &	GetBasicPath () const

const OUString &	GetBitmapPath () const

const OUString &	GetConfigPath () const

const OUString &	GetDictionaryPath () const

const OUString &	GetFavoritesPath () const

const OUString &	GetFilterPath () const

const OUString &	GetGalleryPath () const

const OUString &	GetGraphicPath () const

const OUString &	GetHelpPath () const

const OUString &	GetLinguisticPath () const

const OUString &	GetModulePath () const

const OUString &	GetIconsetPath () const

const OUString &	GetPalettePath () const

const OUString &	GetPluginPath () const

const OUString &	GetStoragePath () const

const OUString &	GetTempPath () const

const OUString &	GetTemplatePath () const

const OUString &	GetUserConfigPath () const

const OUString &	GetWorkPath () const

const OUString &	GetFingerprintPath () const

const OUString &	GetNumbertextPath () const

const OUString &	GetClassificationPath () const

void	SetAutoTextPath (const OUString &rPath)

void	SetBasicPath (const OUString &rPath)

void	SetTempPath (const OUString &rPath)

OUString	SubstituteVariable (const OUString &rVar) const

OUString	ExpandMacros (const OUString &rPath) const

OUString	UseVariable (const OUString &rVar) const

bool	SearchFile (OUString &rIniFile, Paths ePath=Paths::UserConfig)

Public Member Functions inherited from utl::detail::Options
	Options ()

virtual	~Options () override=0

Public Member Functions inherited from utl::ConfigurationBroadcaster
void	AddListener (utl::ConfigurationListener *pListener)

void	RemoveListener (utl::ConfigurationListener const *pListener)

void	NotifyListeners (ConfigurationHints nHint)

	ConfigurationBroadcaster ()

	ConfigurationBroadcaster (ConfigurationBroadcaster const &)

virtual	~ConfigurationBroadcaster ()

ConfigurationBroadcaster &	operator= (ConfigurationBroadcaster const &other)

virtual void	BlockBroadcasts (bool bBlock)

Public Member Functions inherited from utl::ConfigurationListener
virtual	~ConfigurationListener ()

virtual void	ConfigurationChanged (ConfigurationBroadcaster *p, ConfigurationHints nHint)=0

Private Attributes
std::shared_ptr< SvtPathOptions_Impl >	pImpl

Additional Inherited Members
Protected Member Functions inherited from utl::detail::Options
virtual void	ConfigurationChanged (::utl::ConfigurationBroadcaster *p, ConfigurationHints nHint) override

Detailed Description

Handle various defined paths

All path functions return URLs!

Definition at line 34 of file pathoptions.hxx.

Member Enumeration Documentation

◆ Paths

enum class SvtPathOptions::Paths : sal_uInt16

strong

Enumerator
AddIn
AutoCorrect
AutoText
Backup
Basic
Bitmap
Config
Dictionary
Favorites
Filter
Gallery
Graphic
Help
IconSet
Linguistic
Module
Palette
Plugin
Storage
Temp
Template
UserConfig
Work
Classification
UIConfig
Fingerprint
NumberText
LAST

Definition at line 41 of file pathoptions.hxx.

Constructor & Destructor Documentation

◆ SvtPathOptions()

SvtPathOptions::SvtPathOptions ( )

Definition at line 425 of file pathoptions.cxx.

References g_pOptions, ItemHolder1::holdConfigItem(), PathOptions, and pImpl.

◆ ~SvtPathOptions()

SvtPathOptions::~SvtPathOptions ( )

overridevirtual

Definition at line 439 of file pathoptions.cxx.

References pImpl.

Member Function Documentation

◆ ExpandMacros()

OUString SvtPathOptions::ExpandMacros ( const OUString & rPath ) const

Definition at line 597 of file pathoptions.cxx.

References pImpl.

◆ GetAddinPath()

const OUString & SvtPathOptions::GetAddinPath ( ) const

Definition at line 447 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetAutoCorrectPath()

const OUString & SvtPathOptions::GetAutoCorrectPath ( ) const

Definition at line 452 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetAutoTextPath()

const OUString & SvtPathOptions::GetAutoTextPath ( ) const

Definition at line 457 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetBackupPath()

const OUString & SvtPathOptions::GetBackupPath ( ) const

Definition at line 462 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetBasicPath()

const OUString & SvtPathOptions::GetBasicPath ( ) const

Definition at line 467 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetBitmapPath()

const OUString & SvtPathOptions::GetBitmapPath ( ) const

Definition at line 472 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetClassificationPath()

const OUString & SvtPathOptions::GetClassificationPath ( ) const

Definition at line 572 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetConfigPath()

const OUString & SvtPathOptions::GetConfigPath ( ) const

Definition at line 477 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetDictionaryPath()

const OUString & SvtPathOptions::GetDictionaryPath ( ) const

Definition at line 482 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetFavoritesPath()

const OUString & SvtPathOptions::GetFavoritesPath ( ) const

Definition at line 487 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetFilterPath()

const OUString & SvtPathOptions::GetFilterPath ( ) const

Definition at line 492 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetFingerprintPath()

const OUString & SvtPathOptions::GetFingerprintPath ( ) const

Definition at line 517 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetGalleryPath()

const OUString & SvtPathOptions::GetGalleryPath ( ) const

Definition at line 497 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetGraphicPath()

const OUString & SvtPathOptions::GetGraphicPath ( ) const

Definition at line 502 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetHelpPath()

const OUString & SvtPathOptions::GetHelpPath ( ) const

Definition at line 507 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetIconsetPath()

const OUString & SvtPathOptions::GetIconsetPath ( ) const

Definition at line 537 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetLinguisticPath()

const OUString & SvtPathOptions::GetLinguisticPath ( ) const

Definition at line 512 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetModulePath()

const OUString & SvtPathOptions::GetModulePath ( ) const

Definition at line 527 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetNumbertextPath()

const OUString & SvtPathOptions::GetNumbertextPath ( ) const

Definition at line 522 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetPalettePath()

const OUString & SvtPathOptions::GetPalettePath ( ) const

Definition at line 532 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetPluginPath()

const OUString & SvtPathOptions::GetPluginPath ( ) const

Definition at line 542 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetStoragePath()

const OUString & SvtPathOptions::GetStoragePath ( ) const

Definition at line 547 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetTemplatePath()

const OUString & SvtPathOptions::GetTemplatePath ( ) const

Definition at line 557 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetTempPath()

const OUString & SvtPathOptions::GetTempPath ( ) const

Definition at line 552 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetUserConfigPath()

const OUString & SvtPathOptions::GetUserConfigPath ( ) const

Definition at line 562 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ GetWorkPath()

const OUString & SvtPathOptions::GetWorkPath ( ) const

Definition at line 567 of file pathoptions.cxx.

References pImpl.

Referenced by SearchFile().

◆ SearchFile()

bool SvtPathOptions::SearchFile	(	OUString &	rIniFile,
		SvtPathOptions::Paths	ePath = `Paths::UserConfig`
	)

Definition at line 607 of file pathoptions.cxx.

References AddIn, aURL, AutoCorrect, AutoText, Backup, Basic, Bitmap, Classification, Config, Dictionary, utl::UCBContentHelper::Exists(), Favorites, Filter, Fingerprint, Gallery, Translate::get(), GetAddinPath(), GetAutoCorrectPath(), GetAutoTextPath(), GetBackupPath(), GetBasicPath(), GetBitmapPath(), GetClassificationPath(), GetConfigPath(), GetDictionaryPath(), GetFavoritesPath(), GetFilterPath(), GetFingerprintPath(), GetGalleryPath(), GetGraphicPath(), GetHelpPath(), GetIconsetPath(), GetLinguisticPath(), INetURLObject::GetMainURL(), GetModulePath(), GetNumbertextPath(), GetPalettePath(), GetPluginPath(), INetURLObject::GetProtocol(), GetStoragePath(), GetTemplatePath(), GetTempPath(), o3tl::getToken(), INetURLObject::GetURLPath(), GetUserConfigPath(), GetWorkPath(), Graphic, INetURLObject::HasError(), Help, IconSet, INetURLObject::insertName(), LAST, Linguistic, Module, INetURLObject::NONE, NumberText, Palette, pImpl, Plugin, SAL_WARN, SEARCHPATH_DELIMITER, INetURLObject::SetSmartURL(), INetURLObject::SetURL(), Storage, Temp, Template, UIConfig, UserConfig, INetURLObject::WithCharset, and Work.

◆ SetAutoTextPath()

void SvtPathOptions::SetAutoTextPath ( const OUString & rPath )

Definition at line 577 of file pathoptions.cxx.

References pImpl.

◆ SetBasicPath()

void SvtPathOptions::SetBasicPath ( const OUString & rPath )

Definition at line 582 of file pathoptions.cxx.

References pImpl.

◆ SetTempPath()

void SvtPathOptions::SetTempPath ( const OUString & rPath )

Definition at line 587 of file pathoptions.cxx.

References pImpl.

◆ SubstituteVariable()

OUString SvtPathOptions::SubstituteVariable ( const OUString & rVar ) const

Definition at line 592 of file pathoptions.cxx.

References pImpl.

Referenced by SvtDefaultOptions::GetDefaultPath().

◆ UseVariable()

OUString SvtPathOptions::UseVariable ( const OUString & rVar ) const

Definition at line 602 of file pathoptions.cxx.

References pImpl.

Member Data Documentation

◆ pImpl

std::shared_ptr<SvtPathOptions_Impl> SvtPathOptions::pImpl

private

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

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Paths

Constructor & Destructor Documentation

◆ SvtPathOptions()

◆ ~SvtPathOptions()

Member Function Documentation

◆ ExpandMacros()

◆ GetAddinPath()

◆ GetAutoCorrectPath()

◆ GetAutoTextPath()

◆ GetBackupPath()

◆ GetBasicPath()

◆ GetBitmapPath()

◆ GetClassificationPath()

◆ GetConfigPath()

◆ GetDictionaryPath()

◆ GetFavoritesPath()

◆ GetFilterPath()

◆ GetFingerprintPath()

◆ GetGalleryPath()

◆ GetGraphicPath()

◆ GetHelpPath()

◆ GetIconsetPath()

◆ GetLinguisticPath()

◆ GetModulePath()

◆ GetNumbertextPath()

◆ GetPalettePath()

◆ GetPluginPath()

◆ GetStoragePath()

◆ GetTemplatePath()

◆ GetTempPath()

◆ GetUserConfigPath()

◆ GetWorkPath()

◆ SearchFile()

◆ SetAutoTextPath()

◆ SetBasicPath()

◆ SetTempPath()

◆ SubstituteVariable()

◆ UseVariable()

Member Data Documentation

◆ pImpl