is a helper class for enumerating documents in OOo More...

#include <documentenumeration.hxx>

Collaboration diagram for basctl::docs::DocumentEnumeration:

Public Member Functions
	DocumentEnumeration (css::uno::Reference< css::uno::XComponentContext > const &_rContext, const IDocumentDescriptorFilter *_pFilter)

	~DocumentEnumeration ()

void	getDocuments (Documents &_out_rDocuments) const
	retrieves a list of all currently known documents in the application More...

Private Attributes
css::uno::Reference< css::uno::XComponentContext >	m_xContext

const IDocumentDescriptorFilter *	m_pFilter

Detailed Description

is a helper class for enumerating documents in OOo

If you need a list of all open documents in OOo, this is little bit of a hassle: You need to iterate though all components at the desktop, which might or might not be documents.

Additionally, you need to examine the existing documents' frames for sub frames, which might contain sub documents (e.g. embedded objects edited out-place).

DocumentEnumeration relieves you from this hassle.

Definition at line 66 of file documentenumeration.hxx.

Constructor & Destructor Documentation

◆ DocumentEnumeration()

basctl::docs::DocumentEnumeration::DocumentEnumeration	(	css::uno::Reference< css::uno::XComponentContext > const &	_rContext,
		const IDocumentDescriptorFilter *	_pFilter
	)

Definition at line 52 of file documentenumeration.cxx.

References m_xContext.

◆ ~DocumentEnumeration()

basctl::docs::DocumentEnumeration::~DocumentEnumeration ( )

Definition at line 58 of file documentenumeration.cxx.

Member Function Documentation

◆ getDocuments()

void basctl::docs::DocumentEnumeration::getDocuments ( Documents & _out_rDocuments ) const

retrieves a list of all currently known documents in the application

Parameters

_out_rDocuments output parameter taking the collected document information @

Definition at line 137 of file documentenumeration.cxx.

References DBG_UNHANDLED_EXCEPTION, Exception, m_pFilter, and m_xContext.

Member Data Documentation

◆ m_pFilter

const IDocumentDescriptorFilter* basctl::docs::DocumentEnumeration::m_pFilter

private

Definition at line 84 of file documentenumeration.hxx.

Referenced by getDocuments().

◆ m_xContext

css::uno::Reference< css::uno::XComponentContext > basctl::docs::DocumentEnumeration::m_xContext