#include <docfilt.hxx>

Collaboration diagram for SfxFilter:

Public Member Functions
	SfxFilter (OUString aProvider, OUString aFilterName)

	SfxFilter (OUString aName, std::u16string_view rWildCard, SfxFilterFlags nFormatType, SotClipboardFormatId lFormat, OUString aTypeName, OUString aMimeType, OUString aUserData, OUString aServiceName, bool bEnabled=true)

	~SfxFilter ()

bool	IsAllowedAsTemplate () const

bool	IsOwnFormat () const

bool	GetSupportsSigning () const
	If the filter supports digital signatures. More...

bool	GetGpgEncryption () const

bool	IsOwnTemplateFormat () const

bool	IsAlienFormat () const
	not our built-in format More...

bool	IsExoticFormat () const
	an unusual/legacy file to be loading More...

bool	CanImport () const

bool	CanExport () const

SfxFilterFlags	GetFilterFlags () const

const OUString &	GetFilterName () const

const OUString &	GetMimeType () const

const OUString &	GetName () const

const WildCard &	GetWildcard () const

const OUString &	GetRealTypeName () const

SotClipboardFormatId	GetFormat () const

const OUString &	GetTypeName () const

const OUString &	GetUIName () const

const OUString &	GetUserData () const

const OUString &	GetDefaultTemplate () const

void	SetDefaultTemplate (const OUString &rStr)

bool	UsesStorage () const

void	SetUIName (const OUString &rName)

void	SetVersion (sal_Int32 nVersionP)

sal_Int32	GetVersion () const

OUString	GetSuffixes () const

OUString	GetDefaultExtension () const

const OUString &	GetServiceName () const

const OUString &	GetProviderName () const

bool	IsEnabled () const

Static Public Member Functions
static std::shared_ptr< const SfxFilter >	GetDefaultFilter (std::u16string_view rName)

static std::shared_ptr< const SfxFilter >	GetFilterByName (const OUString &rName)

static std::shared_ptr< const SfxFilter >	GetDefaultFilterFromFactory (const OUString &rServiceName)

static OUString	GetTypeFromStorage (const SotStorage &rStg)

static OUString	GetTypeFromStorage (const css::uno::Reference< css::embed::XStorage > &xStorage)

Private Attributes
WildCard	aWildCard

OUString	aTypeName

OUString	aUserData

OUString	aServiceName

OUString	aMimeType

OUString	maFilterName

OUString	aUIName

OUString	aDefaultTemplate

OUString	maProvider
	Custom provider name in case the filter is provided via external libraries. More...

SfxFilterFlags	nFormatType

sal_Int32	nVersion

SotClipboardFormatId	lFormat

bool	mbEnabled

Friends
class	SfxFilterContainer

Detailed Description

Definition at line 38 of file docfilt.hxx.

Constructor & Destructor Documentation

◆ SfxFilter() [1/2]

SfxFilter::SfxFilter	(	OUString	aProvider,
		OUString	aFilterName
	)

Definition at line 36 of file docfilt.cxx.

References NONE.

◆ SfxFilter() [2/2]

SfxFilter::SfxFilter	(	OUString	aName,
		std::u16string_view	rWildCard,
		SfxFilterFlags	nFormatType,
		SotClipboardFormatId	lFormat,
		OUString	aTypeName,
		OUString	aMimeType,
		OUString	aUserData,
		OUString	aServiceName,
		bool	bEnabled = `true`
	)

Definition at line 46 of file docfilt.cxx.

References _aServiceName, aMimeType, aName, aWildCard, WildCard::getGlob(), GetWildcard(), nType, WildCard::setGlob(), SOFFICE_FILEFORMAT_50, and u.

◆ ~SfxFilter()

SfxFilter::~SfxFilter ( )

Definition at line 87 of file docfilt.cxx.

Member Function Documentation

◆ CanExport()

bool SfxFilter::CanExport ( ) const

inline

Definition at line 88 of file docfilt.hxx.

◆ CanImport()

bool SfxFilter::CanImport ( ) const

inline

Definition at line 87 of file docfilt.hxx.

◆ GetDefaultExtension()

OUString SfxFilter::GetDefaultExtension ( ) const

Definition at line 91 of file docfilt.cxx.

References WildCard::getGlob(), and GetWildcard().

◆ GetDefaultFilter()

std::shared_ptr< const SfxFilter > SfxFilter::GetDefaultFilter ( std::u16string_view rName )

static

Definition at line 105 of file docfilt.cxx.

References SfxFilterContainer::GetDefaultFilter_Impl().

Referenced by GetDefaultFilterFromFactory().

◆ GetDefaultFilterFromFactory()

std::shared_ptr< const SfxFilter > SfxFilter::GetDefaultFilterFromFactory ( const OUString & rServiceName )

static

Definition at line 110 of file docfilt.cxx.

References GetDefaultFilter(), and SfxObjectShell::GetServiceNameFromFactory().

Referenced by SfxObjectShell::APISaveAs_Impl().

◆ GetDefaultTemplate()

const OUString & SfxFilter::GetDefaultTemplate ( ) const

inline

Definition at line 99 of file docfilt.hxx.

◆ GetFilterByName()

std::shared_ptr< const SfxFilter > SfxFilter::GetFilterByName ( const OUString & rName )

static

Definition at line 115 of file docfilt.cxx.

References SfxFilterMatcher::GetFilter4FilterName().

Referenced by SfxFilterMatcher::GetFilterForProps(), SfxFilterMatcher::GuessFilterControlDefaultUI(), sfx2::TSortedFilterList::impl_getFilter(), and SfxFilterContainer::ReadSingleFilter_Impl().

◆ GetFilterFlags()

SfxFilterFlags SfxFilter::GetFilterFlags ( ) const

inline

Definition at line 89 of file docfilt.hxx.

◆ GetFilterName()

const OUString & SfxFilter::GetFilterName ( ) const

inline

Definition at line 90 of file docfilt.hxx.

◆ GetFormat()

SotClipboardFormatId SfxFilter::GetFormat ( ) const

inline

Definition at line 95 of file docfilt.hxx.

Referenced by GetTypeFromStorage().

◆ GetGpgEncryption()

bool SfxFilter::GetGpgEncryption ( ) const

inline

Definition at line 81 of file docfilt.hxx.

◆ GetMimeType()

const OUString & SfxFilter::GetMimeType ( ) const

inline

Definition at line 91 of file docfilt.hxx.

References aMimeType.

◆ GetName()

const OUString & SfxFilter::GetName ( ) const

inline

Definition at line 92 of file docfilt.hxx.

◆ GetProviderName()

const OUString & SfxFilter::GetProviderName ( ) const

inline

Definition at line 108 of file docfilt.hxx.

◆ GetRealTypeName()

const OUString & SfxFilter::GetRealTypeName ( ) const

inline

Definition at line 94 of file docfilt.hxx.

◆ GetServiceName()

const OUString & SfxFilter::GetServiceName ( ) const

inline

Definition at line 107 of file docfilt.hxx.

◆ GetSuffixes()

OUString SfxFilter::GetSuffixes ( ) const

Definition at line 97 of file docfilt.cxx.

References WildCard::getGlob(), and GetWildcard().

◆ GetSupportsSigning()

bool SfxFilter::GetSupportsSigning ( ) const

inline

If the filter supports digital signatures.

Definition at line 80 of file docfilt.hxx.

◆ GetTypeFromStorage() [1/2]

static OUString SfxFilter::GetTypeFromStorage ( const css::uno::Reference< css::embed::XStorage > & xStorage )

static

Exceptions

css::beans::UnknownPropertyException
css::lang::WrappedTargetException
css::uno::RuntimeException

◆ GetTypeFromStorage() [2/2]

OUString SfxFilter::GetTypeFromStorage ( const SotStorage & rStg )

static

Definition at line 121 of file docfilt.cxx.

References SfxFilterMatcher::GetFilter4ClipBoardId(), GetFormat(), and SotStorage::IsStream().

◆ GetTypeName()

const OUString & SfxFilter::GetTypeName ( ) const

inline

Definition at line 96 of file docfilt.hxx.

◆ GetUIName()

const OUString & SfxFilter::GetUIName ( ) const

inline

Definition at line 97 of file docfilt.hxx.

References aUIName.

◆ GetUserData()

const OUString & SfxFilter::GetUserData ( ) const

inline

Definition at line 98 of file docfilt.hxx.

◆ GetVersion()

sal_Int32 SfxFilter::GetVersion ( ) const

inline

Definition at line 104 of file docfilt.hxx.

References nVersion.

◆ GetWildcard()

const WildCard & SfxFilter::GetWildcard ( ) const

inline

Definition at line 93 of file docfilt.hxx.

Referenced by GetDefaultExtension(), GetSuffixes(), and SfxFilter().

◆ IsAlienFormat()

bool SfxFilter::IsAlienFormat ( ) const

inline

not our built-in format

Definition at line 84 of file docfilt.hxx.

◆ IsAllowedAsTemplate()

bool SfxFilter::IsAllowedAsTemplate ( ) const

inline

Definition at line 77 of file docfilt.hxx.

◆ IsEnabled()

bool SfxFilter::IsEnabled ( ) const

inline

Definition at line 120 of file docfilt.hxx.

◆ IsExoticFormat()

bool SfxFilter::IsExoticFormat ( ) const

inline

an unusual/legacy file to be loading

Definition at line 86 of file docfilt.hxx.

◆ IsOwnFormat()

bool SfxFilter::IsOwnFormat ( ) const

inline

Definition at line 78 of file docfilt.hxx.

◆ IsOwnTemplateFormat()

bool SfxFilter::IsOwnTemplateFormat ( ) const

inline

Definition at line 82 of file docfilt.hxx.

◆ SetDefaultTemplate()

void SfxFilter::SetDefaultTemplate ( const OUString & rStr )

inline

Definition at line 100 of file docfilt.hxx.

Referenced by SfxFilterContainer::ReadSingleFilter_Impl().

◆ SetUIName()

void SfxFilter::SetUIName ( const OUString & rName )

inline

Definition at line 102 of file docfilt.hxx.

References aUIName.

Referenced by SfxFilterContainer::ReadSingleFilter_Impl().

◆ SetVersion()

void SfxFilter::SetVersion ( sal_Int32 nVersionP )

inline

Definition at line 103 of file docfilt.hxx.

References nVersion.

Referenced by SfxFilterContainer::ReadSingleFilter_Impl().

◆ UsesStorage()

bool SfxFilter::UsesStorage ( ) const

inline

Definition at line 101 of file docfilt.hxx.

References GetFormat().

Friends And Related Function Documentation

◆ SfxFilterContainer

friend class SfxFilterContainer

friend

Definition at line 40 of file docfilt.hxx.

Member Data Documentation

◆ aDefaultTemplate

OUString SfxFilter::aDefaultTemplate

private

Definition at line 50 of file docfilt.hxx.

◆ aMimeType

OUString SfxFilter::aMimeType

private

Definition at line 47 of file docfilt.hxx.

Referenced by SfxFilterContainer::ReadSingleFilter_Impl().

◆ aServiceName

OUString SfxFilter::aServiceName

private

Definition at line 46 of file docfilt.hxx.

Referenced by SfxFilterContainer::ReadSingleFilter_Impl().

◆ aTypeName

OUString SfxFilter::aTypeName

private

Definition at line 44 of file docfilt.hxx.

Referenced by SfxFilterContainer::ReadSingleFilter_Impl().

◆ aUIName

OUString SfxFilter::aUIName

private

Definition at line 49 of file docfilt.hxx.

◆ aUserData

OUString SfxFilter::aUserData

private

Definition at line 45 of file docfilt.hxx.

Referenced by SfxFilterContainer::ReadSingleFilter_Impl().

◆ aWildCard

WildCard SfxFilter::aWildCard

private

Definition at line 42 of file docfilt.hxx.

Referenced by SfxFilterContainer::ReadSingleFilter_Impl(), and SfxFilter().

◆ lFormat

SotClipboardFormatId SfxFilter::lFormat

private

Definition at line 60 of file docfilt.hxx.

Referenced by SfxFilterContainer::ReadSingleFilter_Impl().

◆ maFilterName

OUString SfxFilter::maFilterName

private

Definition at line 48 of file docfilt.hxx.

Referenced by SfxFilterContainer::ReadSingleFilter_Impl().

◆ maProvider

OUString SfxFilter::maProvider

private

Custom provider name in case the filter is provided via external libraries.

Empty for conventional filter types.

Definition at line 56 of file docfilt.hxx.

◆ mbEnabled

bool SfxFilter::mbEnabled

private

Definition at line 61 of file docfilt.hxx.

Referenced by SfxFilterContainer::ReadSingleFilter_Impl().

◆ nFormatType

SfxFilterFlags SfxFilter::nFormatType

private

Definition at line 58 of file docfilt.hxx.

Referenced by SfxFilterContainer::ReadFilters_Impl(), and SfxFilterContainer::ReadSingleFilter_Impl().

◆ nVersion

sal_Int32 SfxFilter::nVersion

private

Definition at line 59 of file docfilt.hxx.

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

Public Member Functions

Static Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ SfxFilter() [1/2]

◆ SfxFilter() [2/2]

◆ ~SfxFilter()

Member Function Documentation

◆ CanExport()

◆ CanImport()

◆ GetDefaultExtension()

◆ GetDefaultFilter()

◆ GetDefaultFilterFromFactory()

◆ GetDefaultTemplate()

◆ GetFilterByName()

◆ GetFilterFlags()

◆ GetFilterName()

◆ GetFormat()

◆ GetGpgEncryption()

◆ GetMimeType()

◆ GetName()

◆ GetProviderName()

◆ GetRealTypeName()

◆ GetServiceName()

◆ GetSuffixes()

◆ GetSupportsSigning()

◆ GetTypeFromStorage() [1/2]

◆ GetTypeFromStorage() [2/2]

◆ GetTypeName()

◆ GetUIName()

◆ GetUserData()

◆ GetVersion()

◆ GetWildcard()

◆ IsAlienFormat()

◆ IsAllowedAsTemplate()

◆ IsEnabled()

◆ IsExoticFormat()

◆ IsOwnFormat()

◆ IsOwnTemplateFormat()

◆ SetDefaultTemplate()

◆ SetUIName()

◆ SetVersion()

◆ UsesStorage()

Friends And Related Function Documentation

◆ SfxFilterContainer

Member Data Documentation

◆ aDefaultTemplate

◆ aMimeType

◆ aServiceName

◆ aTypeName

◆ aUIName

◆ aUserData

◆ aWildCard

◆ lFormat

◆ maFilterName

◆ maProvider

◆ mbEnabled

◆ nFormatType

◆ nVersion