#include <request.hxx>

Inheritance diagram for SfxRequest:

Collaboration diagram for SfxRequest:

Public Member Functions
SAL_DLLPRIVATE void	Record_Impl (SfxShell &rSh, const SfxSlot &rSlot, const css::uno::Reference< css::frame::XDispatchRecorder > &xRecorder, SfxViewFrame *)

	SfxRequest (SfxViewFrame &, sal_uInt16 nSlotId)

	SfxRequest (sal_uInt16 nSlot, SfxCallMode nCallMode, SfxItemPool &rPool)

	SfxRequest (const SfxSlot *pSlot, const css::uno::Sequence< css::beans::PropertyValue > &rArgs, SfxCallMode nCallMode, SfxItemPool &rPool)

	SfxRequest (sal_uInt16 nSlot, SfxCallMode nCallMode, const SfxAllItemSet &rSfxArgs)

	SfxRequest (sal_uInt16 nSlot, SfxCallMode nCallMode, const SfxAllItemSet &rSfxArgs, const SfxAllItemSet &rSfxInternalArgs)

	SfxRequest (const SfxRequest &rOrig)

virtual	~SfxRequest () override

sal_uInt16	GetSlot () const

void	SetSlot (sal_uInt16 nNewSlot)

sal_uInt16	GetModifier () const

void	SetModifier (sal_uInt16 nModi)

void	SetInternalArgs_Impl (const SfxAllItemSet &rArgs)

SAL_DLLPRIVATE const SfxItemSet *	GetInternalArgs_Impl () const

const SfxItemSet *	GetArgs () const

void	SetArgs (const SfxAllItemSet &rArgs)

void	AppendItem (const SfxPoolItem &)

void	RemoveItem (sal_uInt16 nSlotId)

template<class T >
const T *	GetArg (sal_uInt16 nSlotId) const
	Templatized access to the individual parameters of the SfxRequest. More...

template<class T >
const T *	GetArg (TypedWhichId< T > nSlotId) const

void	ReleaseArgs ()

void	SetReturnValue (const SfxPoolItem &)

const SfxPoolItem *	GetReturnValue () const

SfxCallMode	GetCallMode () const

void	AllowRecording (bool)

bool	AllowsRecording () const

bool	IsAPI () const

bool	IsSynchronCall () const

void	SetSynchronCall (bool bSynchron)

bool	IsDone () const

void	Done (bool bRemove=false)

void	Ignore ()

void	Cancel ()

bool	IsCancelled () const

void	Done (const SfxItemSet &)

void	ForgetAllArgs ()

weld::Window *	GetFrameWeld () const
	Return the window that should be used as the parent for any dialogs this request creates. More...

Public Member Functions inherited from SfxHint
	SfxHint ()

	SfxHint (SfxHintId nId)

virtual	~SfxHint ()

	SfxHint (SfxHint const &)=default

	SfxHint (SfxHint &&)=default

SfxHint &	operator= (SfxHint const &)=default

SfxHint &	operator= (SfxHint &&)=default

SfxHintId	GetId () const

Static Public Member Functions
static css::uno::Reference< css::frame::XDispatchRecorder >	GetMacroRecorder (const SfxViewFrame &rFrame)

static bool	HasMacroRecorder (const SfxViewFrame &rFrame)

Private Member Functions
SAL_DLLPRIVATE void	Done_Impl (const SfxItemSet *pSet)

const SfxRequest &	operator= (const SfxRequest &)=delete

Private Attributes
sal_uInt16	nSlot

std::unique_ptr< SfxAllItemSet >	pArgs

std::unique_ptr< SfxRequest_Impl >	pImpl

Friends
struct	SfxRequest_Impl

Detailed Description

Definition at line 43 of file request.hxx.

Constructor & Destructor Documentation

◆ SfxRequest() [1/6]

SfxRequest::SfxRequest	(	SfxViewFrame &	rViewFrame,
		sal_uInt16	nSlotId
	)

Definition at line 188 of file request.cxx.

References GetMacroRecorder(), SfxShell::GetPool(), comphelper::getProcessComponentContext(), pImpl, SAL_WARN, and SYNCHRON.

◆ SfxRequest() [2/6]

SfxRequest::SfxRequest	(	sal_uInt16	nSlot,
		SfxCallMode	nCallMode,
		SfxItemPool &	rPool
	)

Definition at line 214 of file request.cxx.

References pImpl.

◆ SfxRequest() [3/6]

SfxRequest::SfxRequest	(	const SfxSlot *	pSlot,
		const css::uno::Sequence< css::beans::PropertyValue > &	rArgs,
		SfxCallMode	nCallMode,
		SfxItemPool &	rPool
	)

Definition at line 234 of file request.cxx.

References nSlot, pArgs, pImpl, and TransformParameters().

◆ SfxRequest() [4/6]

SfxRequest::SfxRequest	(	sal_uInt16	nSlot,
		SfxCallMode	nCallMode,
		const SfxAllItemSet &	rSfxArgs
	)

Definition at line 255 of file request.cxx.

References SfxItemSet::GetPool(), and pImpl.

◆ SfxRequest() [5/6]

SfxRequest::SfxRequest	(	sal_uInt16	nSlot,
		SfxCallMode	nCallMode,
		const SfxAllItemSet &	rSfxArgs,
		const SfxAllItemSet &	rSfxInternalArgs
	)

Definition at line 277 of file request.cxx.

References SetInternalArgs_Impl().

◆ SfxRequest() [6/6]

SfxRequest::SfxRequest ( const SfxRequest & rOrig )

Definition at line 132 of file request.cxx.

References GetMacroRecorder(), comphelper::getProcessComponentContext(), nSlot, pArgs, pImpl, and SAL_WARN.

◆ ~SfxRequest()

SfxRequest::~SfxRequest ( )

overridevirtual

Definition at line 119 of file request.cxx.

References DeleteItemOnIdle(), pArgs, and pImpl.

Member Function Documentation

◆ AllowRecording()

void SfxRequest::AllowRecording ( bool bSet )

Definition at line 730 of file request.cxx.

References pImpl.

Referenced by SfxDispatcher::Execute_().

◆ AllowsRecording()

bool SfxRequest::AllowsRecording ( ) const

Definition at line 735 of file request.cxx.

References API, pImpl, and RECORD.

◆ AppendItem()

void SfxRequest::AppendItem ( const SfxPoolItem & rItem )

Definition at line 404 of file request.cxx.

References pArgs, pImpl, and SfxPoolItem::Which().

Referenced by SfxViewFrame::AddDispatchMacroToBasic_Impl(), SfxViewFrame::ChildWindowExecute(), Done_Impl(), SfxViewFrame::Exec_Impl(), SfxObjectShell::ExecFile_Impl(), SfxViewShell::ExecPrint_Impl(), SfxViewFrame::ExecReload_Impl(), SfxBindings::Execute_Impl(), SfxApplication::MiscExec_Impl(), SfxViewFrame::MiscExec_Impl(), SfxApplication::NewDocDirectExec_Impl(), SfxApplication::OpenDocExec_Impl(), SfxApplication::OpenRemoteExec_Impl(), and SfxApplication::SignPDFExec_Impl().

◆ Cancel()

void SfxRequest::Cancel ( )

Definition at line 506 of file request.cxx.

References pArgs, and pImpl.

Referenced by SfxRequest_Impl::Notify().

◆ Done() [1/2]

void SfxRequest::Done ( bool bRemove = false )

◆ Done() [2/2]

void SfxRequest::Done ( const SfxItemSet & rSet )

Definition at line 435 of file request.cxx.

References Done_Impl(), SfxItemIter::GetCurItem(), IsInvalidItem(), SfxItemIter::NextItem(), pArgs, pImpl, and rSet.

◆ Done_Impl()

void SfxRequest::Done_Impl ( const SfxItemSet * pSet )

private

Definition at line 541 of file request.cxx.

References AppendItem(), aSeq, DBG_ASSERT, Done(), SfxItemIter::GetCurItem(), SfxItemSet::GetItemState(), SfxItemPool::GetSlotId(), SfxItemPool::GetWhich(), METHOD, SfxItemIter::NextItem(), SfxSlot::nFlags, nSlot, pImpl, RECORDPERITEM, RECORDPERSET, SAL_WARN_IF, and TransformItems().

Referenced by Done().

◆ ForgetAllArgs()

void SfxRequest::ForgetAllArgs ( )

Definition at line 493 of file request.cxx.

References pArgs, and pImpl.

Referenced by SfxApplication::MiscExec_Impl().

◆ GetArg() [1/2]

template<class T >

const T * SfxRequest::GetArg ( sal_uInt16 nSlotId ) const

inline

Templatized access to the individual parameters of the SfxRequest.

Use like: const SfxInt32Item *pPosItem = rReq.GetArg<SfxInt32Item>(SID_POS);

Definition at line 84 of file request.hxx.

Referenced by SfxViewFrame::ChildWindowExecute(), SfxViewFrame::DisplayNewDocument(), SfxViewFrame::Exec_Impl(), SfxObjectShell::ExecFile_Impl(), SfxViewShell::ExecMisc_Impl(), SfxViewShell::ExecPrint_Impl(), SfxViewFrame::ExecReload_Impl(), SfxViewFrame::ExecView_Impl(), SfxRedactionHelper::getStringParam(), SfxRedactionHelper::isRedactMode(), SfxApplication::MiscExec_Impl(), SfxViewFrame::MiscExec_Impl(), SfxApplication::NewDocDirectExec_Impl(), SfxApplication::NewDocExec_Impl(), SfxApplication::OfaExec_Impl(), SfxApplication::OpenDocExec_Impl(), and SfxApplication::PropExec_Impl().

◆ GetArg() [2/2]

template<class T >

const T * SfxRequest::GetArg ( TypedWhichId< T > nSlotId ) const

inline

Definition at line 90 of file request.hxx.

◆ GetArgs()

const SfxItemSet * SfxRequest::GetArgs ( ) const

inline

Definition at line 75 of file request.hxx.

Referenced by SfxObjectShell::ExecFile_Impl(), SfxViewShell::ExecPrint_Impl(), SfxObjectShell::ExecProps_Impl(), SfxBindings::Execute_Impl(), SfxViewFrame::ExecView_Impl(), SfxRedactionHelper::getStringParam(), SfxShell::IsConditionalFastCall(), SfxRedactionHelper::isRedactMode(), SfxApplication::MiscExec_Impl(), SfxApplication::OfaExec_Impl(), SfxApplication::OpenDocExec_Impl(), SfxApplication::OpenRemoteExec_Impl(), and SfxApplication::SignPDFExec_Impl().

◆ GetCallMode()

SfxCallMode SfxRequest::GetCallMode ( ) const

Definition at line 289 of file request.cxx.

References pImpl.

Referenced by SfxObjectShell::ExecFile_Impl(), and SfxBindings::Execute_Impl().

◆ GetFrameWeld()

weld::Window * SfxRequest::GetFrameWeld ( ) const

Return the window that should be used as the parent for any dialogs this request creates.

Definition at line 299 of file appserv.cxx.

References Application::GetFrameWeld(), GetInternalArgs_Impl(), SfxItemSet::GetItemIfSet(), SfxUnoAnyItem::GetValue(), SAL_WARN, and xFrame.

Referenced by SfxObjectShell::ExecFile_Impl(), SfxViewShell::ExecMisc_Impl(), SfxApplication::MiscExec_Impl(), SfxApplication::NewDocExec_Impl(), SfxApplication::OfaExec_Impl(), and SfxApplication::OpenDocExec_Impl().

◆ GetInternalArgs_Impl()

const SfxItemSet * SfxRequest::GetInternalArgs_Impl ( ) const

Definition at line 314 of file request.cxx.

References pImpl.

Referenced by GetFrameWeld().

◆ GetMacroRecorder()

css::uno::Reference< css::frame::XDispatchRecorder > SfxRequest::GetMacroRecorder ( const SfxViewFrame & rFrame )

static

Definition at line 670 of file request.cxx.

References SfxViewFrame::GetFrame(), and SfxFrame::GetFrameInterface().

Referenced by HasMacroRecorder(), and SfxRequest().

◆ GetModifier()

sal_uInt16 SfxRequest::GetModifier ( ) const

Definition at line 724 of file request.cxx.

References pImpl.

◆ GetReturnValue()

const SfxPoolItem * SfxRequest::GetReturnValue ( ) const

Definition at line 429 of file request.cxx.

References pImpl.

Referenced by SfxDispatchController_Impl::dispatch(), SfxViewFrame::Exec_Impl(), SfxDispatcher::Execute(), SfxBindings::Execute_Impl(), SfxDispatcher::ExecuteList(), SfxShell::ExecuteSlot(), SfxApplication::MiscExec_Impl(), SfxApplication::NewDocDirectExec_Impl(), and SfxApplication::OpenDocExec_Impl().

◆ GetSlot()

◆ HasMacroRecorder()

bool SfxRequest::HasMacroRecorder ( const SfxViewFrame & rFrame )

static

Definition at line 700 of file request.cxx.

References GetMacroRecorder().

◆ Ignore()

void SfxRequest::Ignore ( )

Definition at line 521 of file request.cxx.

References pImpl.

Referenced by SfxViewFrame::ChildWindowExecute(), SfxObjectShell::ExecFile_Impl(), SfxViewShell::ExecMisc_Impl(), SfxViewShell::ExecPrint_Impl(), SfxShell::HandleOpenXmlFilterSettings(), and SfxViewFrame::MiscExec_Impl().

◆ IsAPI()

bool SfxRequest::IsAPI ( ) const

Definition at line 705 of file request.cxx.

References API, and pImpl.

Referenced by SfxObjectShell::ExecFile_Impl(), SfxViewFrame::ExecReload_Impl(), and SfxApplication::MiscExec_Impl().

◆ IsCancelled()

bool SfxRequest::IsCancelled ( ) const

Definition at line 500 of file request.cxx.

References pImpl.

◆ IsDone()

bool SfxRequest::IsDone ( ) const

Definition at line 648 of file request.cxx.

References pImpl.

Referenced by SfxDispatcher::Call_Impl(), SfxDispatchController_Impl::dispatch(), and SfxObjectShell::ExecFile_Impl().

◆ IsSynchronCall()

bool SfxRequest::IsSynchronCall ( ) const

Definition at line 295 of file request.cxx.

References pImpl, and SYNCHRON.

Referenced by SfxObjectShell::ExecFile_Impl(), and SfxApplication::OpenDocExec_Impl().

◆ operator=()

const SfxRequest & SfxRequest::operator= ( const SfxRequest & )

privatedelete

◆ Record_Impl()

void SfxRequest::Record_Impl	(	SfxShell &	rSh,
		const SfxSlot &	rSlot,
		const css::uno::Reference< css::frame::XDispatchRecorder > &	xRecorder,
		SfxViewFrame *	pViewFrame
	)

Definition at line 371 of file request.cxx.

References SfxShell::GetName(), comphelper::getProcessComponentContext(), and pImpl.

Referenced by SfxDispatcher::Call_Impl().

◆ ReleaseArgs()

void SfxRequest::ReleaseArgs ( )

Definition at line 744 of file request.cxx.

References pArgs, and pImpl.

Referenced by SfxObjectShell::ExecFile_Impl().

◆ RemoveItem()

void SfxRequest::RemoveItem ( sal_uInt16 nSlotId )

Definition at line 412 of file request.cxx.

References pArgs.

Referenced by SfxApplication::OpenDocExec_Impl().

◆ SetArgs()

void SfxRequest::SetArgs ( const SfxAllItemSet & rArgs )

Definition at line 397 of file request.cxx.

References pArgs, and pImpl.

Referenced by SfxObjectShell::ExecFile_Impl(), SfxApplication::OfaExec_Impl(), and SfxApplication::OpenDocExec_Impl().

◆ SetInternalArgs_Impl()

void SfxRequest::SetInternalArgs_Impl ( const SfxAllItemSet & rArgs )

Definition at line 309 of file request.cxx.

References pImpl.

Referenced by SfxViewFrame::AddDispatchMacroToBasic_Impl(), SfxDispatchController_Impl::dispatch(), SfxDispatcher::Execute(), SfxBindings::Execute_Impl(), SfxDispatcher::ExecuteList(), and SfxRequest().

◆ SetModifier()

void SfxRequest::SetModifier ( sal_uInt16 nModi )

Definition at line 718 of file request.cxx.

References pImpl.

Referenced by SfxDispatchController_Impl::dispatch(), SfxDispatcher::Execute(), and SfxBindings::Execute_Impl().

◆ SetReturnValue()

void SfxRequest::SetReturnValue ( const SfxPoolItem & rItem )

Definition at line 422 of file request.cxx.

References SfxPoolItem::Clone(), DBG_ASSERT, and pImpl.

Referenced by SfxViewFrame::Exec_Impl(), SfxObjectShell::ExecFile_Impl(), SfxViewFrame::ExecHistory_Impl(), SfxViewShell::ExecPrint_Impl(), SfxViewFrame::ExecReload_Impl(), SfxObjectShell::ExecView_Impl(), SfxViewFrame::ExecView_Impl(), SfxApplication::MiscExec_Impl(), SfxApplication::NewDocDirectExec_Impl(), SfxApplication::NewDocExec_Impl(), SfxApplication::OfaExec_Impl(), and SfxApplication::OpenDocExec_Impl().

◆ SetSlot()

void SfxRequest::SetSlot ( sal_uInt16 nNewSlot )

inline

Definition at line 69 of file request.hxx.

Referenced by SfxBindings::Execute_Impl(), SfxApplication::OpenDocExec_Impl(), and SfxObjectShell::PrintExec_Impl().

◆ SetSynchronCall()

void SfxRequest::SetSynchronCall ( bool bSynchron )

Definition at line 301 of file request.cxx.

References pImpl, and SYNCHRON.

Friends And Related Function Documentation

◆ SfxRequest_Impl

friend struct SfxRequest_Impl

friend

Definition at line 45 of file request.hxx.

Member Data Documentation

◆ nSlot

sal_uInt16 SfxRequest::nSlot

private

Definition at line 47 of file request.hxx.

Referenced by Done_Impl(), and SfxRequest().

◆ pArgs

std::unique_ptr<SfxAllItemSet> SfxRequest::pArgs

private

Definition at line 48 of file request.hxx.

Referenced by AppendItem(), Cancel(), Done(), ForgetAllArgs(), ReleaseArgs(), RemoveItem(), SetArgs(), SfxRequest(), and ~SfxRequest().

◆ pImpl

std::unique_ptr< SfxRequest_Impl > SfxRequest::pImpl

private

Definition at line 49 of file request.hxx.

Referenced by AllowRecording(), AllowsRecording(), AppendItem(), Cancel(), Done(), Done_Impl(), ForgetAllArgs(), GetCallMode(), GetInternalArgs_Impl(), GetModifier(), GetReturnValue(), Ignore(), IsAPI(), IsCancelled(), IsDone(), IsSynchronCall(), Record_Impl(), ReleaseArgs(), SetArgs(), SetInternalArgs_Impl(), SetModifier(), SetReturnValue(), SetSynchronCall(), SfxRequest(), and ~SfxRequest().

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ SfxRequest() [1/6]

◆ SfxRequest() [2/6]

◆ SfxRequest() [3/6]

◆ SfxRequest() [4/6]

◆ SfxRequest() [5/6]

◆ SfxRequest() [6/6]

◆ ~SfxRequest()

Member Function Documentation

◆ AllowRecording()

◆ AllowsRecording()

◆ AppendItem()

◆ Cancel()

◆ Done() [1/2]

◆ Done() [2/2]

◆ Done_Impl()

◆ ForgetAllArgs()

◆ GetArg() [1/2]

◆ GetArg() [2/2]

◆ GetArgs()

◆ GetCallMode()

◆ GetFrameWeld()

◆ GetInternalArgs_Impl()

◆ GetMacroRecorder()

◆ GetModifier()

◆ GetReturnValue()

◆ GetSlot()

◆ HasMacroRecorder()

◆ Ignore()

◆ IsAPI()

◆ IsCancelled()

◆ IsDone()

◆ IsSynchronCall()

◆ operator=()

◆ Record_Impl()

◆ ReleaseArgs()

◆ RemoveItem()

◆ SetArgs()

◆ SetInternalArgs_Impl()

◆ SetModifier()

◆ SetReturnValue()

◆ SetSlot()

◆ SetSynchronCall()

Friends And Related Function Documentation

◆ SfxRequest_Impl

Member Data Documentation

◆ nSlot

◆ pArgs

◆ pImpl