The "Validity" tab dialog. More...

#include <validate.hxx>

Inheritance diagram for ScValidationDlg:

Collaboration diagram for ScValidationDlg:

Public Types
enum	{ SLOTID = SID_VALIDITY_REFERENCE }

Public Types inherited from ScRefHdlrControllerImpl< SfxTabDialogController, false >
enum

Public Types inherited from ScRefHandlerHelper
typedef void(ScRefHandlerCaller::*	PFUNCSETREFHDLTYPE) (const ScRange &, const ScDocument &)

typedef void(ScRefHandlerCaller::*	PCOMMONHDLTYPE) ()

typedef void(ScRefHandlerCaller::*	PINPUTSTARTDLTYPE) (formula::RefEdit pEdit, const formula::RefButton pButton)

Public Member Functions
	ScValidationDlg (weld::Window pParent, const SfxItemSet pArgSet, ScTabViewShell *pTabViewSh)

virtual	~ScValidationDlg () override

ScTabViewShell *	GetTabViewShell ()

bool	SetupRefDlg ()

bool	RemoveRefDlg (bool bRestoreModal)

void	SetModal (bool bModal)

virtual void	EndDialog (int nResponse) override

virtual bool	CloseOnHide () const override

virtual void	SetReference (const ScRange &rRef, ScDocument &rDoc) override

virtual void	SetActive () override

bool	IsRefInputting () const

weld::Container *	get_refinput_shrink_parent ()

virtual void	RefInputStart (formula::RefEdit pEdit, formula::RefButton pButton=nullptr) override

virtual void	RefInputDone (bool bForced=false) override

bool	IsChildFocus () const

virtual void	Close () override

Public Member Functions inherited from ScRefHdlrControllerImpl< SfxTabDialogController, false >
	ScRefHdlrControllerImpl (weld::Window pParent, const OUString &rUIXMLDescription, const OUString &rID, const SfxItemSet pArg, SfxBindings *pB)

	ScRefHdlrControllerImpl (SfxBindings pB, SfxChildWindow pCW, weld::Window *pParent, const OUString &rUIXMLDescription, const OUString &rID)

Public Member Functions inherited from SfxTabDialogController
	SfxTabDialogController (weld::Widget pParent, const OUString &rUIXMLDescription, const OUString &rID, const SfxItemSet =nullptr, bool bEditFmt=false)

virtual	~SfxTabDialogController () override

void	AddTabPage (const OUString &rName, CreateTabPage pCreateFunc, GetTabPageRanges pRangesFunc)

void	AddTabPage (const OUString &rName, sal_uInt16 nPageCreateId)

void	AddTabPage (const OUString &rName, const OUString &rLabel, CreateTabPage pCreateFunc)

void	AddTabPage (const OUString &rName, const OUString &rLabel, sal_uInt16 nPageCreateId)

void	RemoveTabPage (const OUString &rName)

void	SetCurPageId (const OUString &rName)

void	ShowPage (const OUString &rName)

OUString	GetCurPageId () const

SfxTabPage *	GetCurTabPage () const

const WhichRangesContainer &	GetInputRanges (const SfxItemPool &)

void	SetInputSet (const SfxItemSet *pInSet)

const SfxItemSet *	GetOutputItemSet () const

virtual weld::Button &	GetOKButton () const override

weld::Button &	GetCancelButton () const

weld::Button *	GetUserButton () const

weld::Button *	GetStandardButton () const

weld::Button *	GetApplyButton () const

weld::Button *	GetResetButton () const

void	RemoveResetButton ()

void	RemoveStandardButton ()

virtual short	run () override

virtual const SfxItemSet *	GetExampleSet () const override

void	SetApplyHandler (const Link< weld::Button &, void > &_rHdl)

bool	Apply ()

void	Applied ()

std::vector< OUString >	getAllPageUIXMLDescriptions () const

bool	selectPageByUIXMLDescription (const OUString &rUIXMLDescription)

BitmapEx	createScreenshot () const

OUString	GetScreenshotId () const

Public Member Functions inherited from SfxOkDialogController
	SfxOkDialogController (weld::Widget *pParent, const OUString &rUIXMLDescription, const OUString &rID)

virtual weld::Button &	GetOKButton () const=0

virtual const SfxItemSet *	GetExampleSet () const=0

Public Member Functions inherited from SfxDialogController
	SfxDialogController (weld::Widget *pParent, const OUString &rUIFile, const OUString &rDialogId)

virtual void	Activate ()

virtual void	Deactivate ()

virtual void	ChildWinDispose ()

virtual void	Close ()

virtual void	EndDialog (int nResponse)

virtual bool	CloseOnHide () const

Public Member Functions inherited from ScRefHandler
	ScRefHandler (SfxDialogController &rController, SfxBindings *pB, bool bBindRef)

virtual	~ScRefHandler () COVERITY_NOEXCEPT_FALSE override

virtual void	SetReference (const ScRange &rRef, ScDocument &rDoc) override=0

virtual void	AddRefEntry () override

virtual bool	IsRefInputMode () const override

virtual bool	IsTableLocked () const override

virtual bool	IsDocAllowed (SfxObjectShell *pDocSh) const override

virtual void	ShowReference (const OUString &rStr) override

virtual void	HideReference (bool bDoneRefMode=true) override

virtual void	ToggleCollapsed (formula::RefEdit pEdit, formula::RefButton pButton) override

virtual void	ReleaseFocus (formula::RefEdit *pEdit) override

virtual void	ViewShellChanged () override

void	SwitchToDocument ()

virtual void	SetActive () override=0

bool	EnterRefMode ()

bool	LeaveRefMode ()

bool	CanInputDone (bool bForced)

Public Member Functions inherited from ScRefHandlerHelper
void	SetSetRefHdl (PFUNCSETREFHDLTYPE pNewHdl)

void	SetSetActHdl (PCOMMONHDLTYPE pNewHdl)

void	SetHandler (ScRefHandlerCaller *pNewHandler)

void	SetRefInputStartPreHdl (PINPUTSTARTDLTYPE pNewHdl)

void	SetRefInputDonePostHdl (void(ScRefHandlerCaller::*pNewHdl)())

	ScRefHandlerHelper ()

Static Public Member Functions
static std::shared_ptr< SfxDialogController >	Find1AliveObject (const weld::Window *pAncestor)

Static Public Member Functions inherited from SfxTabDialogController
static bool	runAsync (const std::shared_ptr< SfxTabDialogController > &rController, const std::function< void(sal_Int32)> &)

Static Public Member Functions inherited from ScRefHandler
static bool	CanInputStart (const formula::RefEdit *pEdit)

Private Types
typedef ScRefHdlrControllerImpl< SfxTabDialogController, false >	ScValidationDlgBase

Private Member Functions
bool	EnterRefStatus ()

bool	LeaveRefStatus ()

Private Attributes
ScTabViewShell *	m_pTabVwSh

OUString	m_sValuePageId

bool	m_bOwnRefHdlr:1

bool	m_bRefInputting:1

std::unique_ptr< weld::Container >	m_xHBox

Additional Inherited Members
Protected Member Functions inherited from SfxTabDialogController
	DECL_LINK (OkHdl, weld::Button &, void)

	DECL_DLLPRIVATE_LINK (ResetHdl, weld::Button &, void)

	DECL_DLLPRIVATE_LINK (BaseFmtHdl, weld::Button &, void)

	DECL_DLLPRIVATE_LINK (UserHdl, weld::Button &, void)

	DECL_DLLPRIVATE_LINK (CancelHdl, weld::Button &, void)

virtual short	Ok ()

virtual void	RefreshInputSet ()

virtual SfxItemSet *	CreateInputItemSet (const OUString &rName)

virtual void	PageCreated (const OUString &rName, SfxTabPage &rPage)

virtual void	ActivatePage (const OUString &rPage)

bool	DeactivatePage (std::u16string_view aPage)

SfxItemSet *	GetInputSetImpl ()

SfxTabPage *	GetTabPage (std::u16string_view rPageId) const

bool	PrepareLeaveCurrentPage ()

void	SavePosAndId ()

Protected Member Functions inherited from ScRefHandler
void	disposeRefHandler ()

bool	DoClose (sal_uInt16 nId)

void	SetDispatcherLock (bool bLock)

virtual void	RefInputStart (formula::RefEdit pEdit, formula::RefButton pButton=nullptr) override

virtual void	RefInputDone (bool bForced=false) override

bool	ParseWithNames (ScRangeList &rRanges, std::u16string_view rStr, const ScDocument &pDoc)

Protected Attributes inherited from SfxTabDialogController
std::unique_ptr< weld::Notebook >	m_xTabCtrl

std::unique_ptr< SfxItemSet >	m_xExampleSet

Protected Attributes inherited from ScRefHandlerHelper
ScRefHandlerCaller *	m_pHandler

void(ScRefHandlerCaller::*	m_pSetReferenceHdl )(const ScRange &, const ScDocument &)

void(ScRefHandlerCaller::*	m_pSetActiveHdl )()

void(ScRefHandlerCaller::*	m_pRefInputStartPreHdl )(formula::RefEdit pEdit, const formula::RefButton pButton)

void(ScRefHandlerCaller::*	m_pRefInputDonePostHdl )()

Detailed Description

The "Validity" tab dialog.

Definition at line 146 of file validate.hxx.

Member Typedef Documentation

◆ ScValidationDlgBase

typedef ScRefHdlrControllerImpl<SfxTabDialogController, false> ScValidationDlg::ScValidationDlgBase

private

Definition at line 150 of file validate.hxx.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
SLOTID

Definition at line 223 of file validate.hxx.

Constructor & Destructor Documentation

◆ ScValidationDlg()

ScValidationDlg::ScValidationDlg	(	weld::Window *	pParent,
		const SfxItemSet *	pArgSet,
		ScTabViewShell *	pTabViewSh
	)

explicit

Definition at line 84 of file validate.cxx.

References SfxTabDialogController::AddTabPage(), ScTPValidationValue::Create(), ScTPValidationHelp::Create(), ScTPValidationError::Create(), IS_MOBILE, and m_sValuePageId.

◆ ~ScValidationDlg()

ScValidationDlg::~ScValidationDlg ( )

overridevirtual

Definition at line 119 of file validate.cxx.

References m_bOwnRefHdlr, and RemoveRefDlg().

Member Function Documentation

◆ Close()

virtual void ScValidationDlg::Close ( )

inlineoverridevirtual

Reimplemented from SfxDialogController.

Definition at line 225 of file validate.hxx.

References SfxDialogController::Close(), SfxTabDialogController::GetTabPage(), m_bOwnRefHdlr, m_sValuePageId, and RemoveRefDlg().

◆ CloseOnHide()

virtual bool ScValidationDlg::CloseOnHide ( ) const

inlineoverridevirtual

Reimplemented from SfxDialogController.

Definition at line 181 of file validate.hxx.

◆ EndDialog()

void ScValidationDlg::EndDialog ( int nResponse )

overridevirtual

Reimplemented from SfxDialogController.

Definition at line 105 of file validate.cxx.

References SfxDialogController::EndDialog(), m_bOwnRefHdlr, nCloseResponseToJustHide, and RemoveRefDlg().

◆ EnterRefStatus()

bool ScValidationDlg::EnterRefStatus ( )

private

Definition at line 841 of file validate.cxx.

References SfxViewFrame::GetChildWindow(), SfxChildWindow::GetController(), GetTabViewShell(), SfxViewShell::GetViewFrame(), nId, SC_MOD, and SLOTID.

Referenced by SetupRefDlg().

◆ Find1AliveObject()

static std::shared_ptr< SfxDialogController > ScValidationDlg::Find1AliveObject ( const weld::Window * pAncestor )

inlinestatic

Definition at line 165 of file validate.hxx.

References SC_MOD, and SLOTID.

Referenced by ScValidityRefChildWin::ScValidityRefChildWin().

◆ get_refinput_shrink_parent()

weld::Container * ScValidationDlg::get_refinput_shrink_parent ( )

inline

Definition at line 196 of file validate.hxx.

References m_xHBox.

Referenced by ScTPValidationValue::RefInputStartPreHdl().

◆ GetTabViewShell()

ScTabViewShell * ScValidationDlg::GetTabViewShell ( )

inline

Definition at line 169 of file validate.hxx.

References m_pTabVwSh.

Referenced by EnterRefStatus(), LeaveRefStatus(), and RemoveRefDlg().

◆ IsChildFocus()

bool ScValidationDlg::IsChildFocus ( ) const

Definition at line 926 of file validate.cxx.

References m_xDialog.

◆ IsRefInputting()

bool ScValidationDlg::IsRefInputting ( ) const

inline

Definition at line 195 of file validate.hxx.

References m_bRefInputting.

◆ LeaveRefStatus()

bool ScValidationDlg::LeaveRefStatus ( )

private

Definition at line 858 of file validate.cxx.

References ScRefHandler::DoClose(), SfxViewFrame::GetChildWindow(), GetTabViewShell(), SfxViewShell::GetViewFrame(), nId, and SLOTID.

Referenced by RemoveRefDlg().

◆ RefInputDone()

virtual void ScValidationDlg::RefInputDone ( bool bForced = false )

inlineoverridevirtual

Reimplemented from ScRefHandler.

Definition at line 209 of file validate.hxx.

References ScRefHandler::CanInputDone(), m_bRefInputting, ScRefHandlerHelper::m_pHandler, ScRefHandlerHelper::m_pRefInputDonePostHdl, and ScRefHandler::RefInputDone().

◆ RefInputStart()

virtual void ScValidationDlg::RefInputStart	(	formula::RefEdit *	pEdit,
		formula::RefButton *	pButton = `nullptr`
	)

inlineoverridevirtual

Reimplemented from ScRefHandler.

Definition at line 198 of file validate.hxx.

References ScRefHandler::CanInputStart(), m_bRefInputting, ScRefHandlerHelper::m_pHandler, ScRefHandlerHelper::m_pRefInputStartPreHdl, and ScRefHandler::RefInputStart().

◆ RemoveRefDlg()

bool ScValidationDlg::RemoveRefDlg ( bool bRestoreModal )

Definition at line 886 of file validate.cxx.

References SfxViewFrame::GetChildWindow(), GetTabViewShell(), SfxViewShell::GetViewFrame(), ScRefHandler::LeaveRefMode(), LeaveRefStatus(), m_bOwnRefHdlr, and SetModal().

Referenced by Close(), EndDialog(), ScTPValidationValue::RemoveRefDlg(), and ~ScValidationDlg().

◆ SetActive()

virtual void ScValidationDlg::SetActive ( )

inlineoverridevirtual

Implements ScRefHandler.

Definition at line 189 of file validate.hxx.

References ScRefHandlerHelper::m_pHandler, and ScRefHandlerHelper::m_pSetActiveHdl.

◆ SetModal()

void ScValidationDlg::SetModal ( bool bModal )

inline

Definition at line 177 of file validate.hxx.

References m_xDialog.

Referenced by RemoveRefDlg(), and SetupRefDlg().

◆ SetReference()

virtual void ScValidationDlg::SetReference	(	const ScRange &	rRef,
		ScDocument &	rDoc
	)

inlineoverridevirtual

Implements ScRefHandler.

Definition at line 183 of file validate.hxx.

References ScRefHandlerHelper::m_pHandler, and ScRefHandlerHelper::m_pSetReferenceHdl.

◆ SetupRefDlg()

bool ScValidationDlg::SetupRefDlg ( )

Definition at line 873 of file validate.cxx.

References ScRefHandler::EnterRefMode(), EnterRefStatus(), m_bOwnRefHdlr, and SetModal().

Referenced by ScTPValidationValue::SetupRefDlg().

Member Data Documentation

◆ m_bOwnRefHdlr

bool ScValidationDlg::m_bOwnRefHdlr

private

Definition at line 154 of file validate.hxx.

Referenced by Close(), EndDialog(), RemoveRefDlg(), SetupRefDlg(), and ~ScValidationDlg().

◆ m_bRefInputting

bool ScValidationDlg::m_bRefInputting

private

Definition at line 155 of file validate.hxx.

Referenced by IsRefInputting(), RefInputDone(), and RefInputStart().

◆ m_pTabVwSh

ScTabViewShell* ScValidationDlg::m_pTabVwSh

private

Definition at line 152 of file validate.hxx.

Referenced by GetTabViewShell().

◆ m_sValuePageId

OUString ScValidationDlg::m_sValuePageId

private

Definition at line 153 of file validate.hxx.

Referenced by Close(), and ScValidationDlg().

◆ m_xHBox

std::unique_ptr<weld::Container> ScValidationDlg::m_xHBox

private

Definition at line 157 of file validate.hxx.

Referenced by get_refinput_shrink_parent().

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

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ScValidationDlgBase

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ ScValidationDlg()

◆ ~ScValidationDlg()

Member Function Documentation

◆ Close()

◆ CloseOnHide()

◆ EndDialog()

◆ EnterRefStatus()

◆ Find1AliveObject()

◆ get_refinput_shrink_parent()

◆ GetTabViewShell()

◆ IsChildFocus()

◆ IsRefInputting()

◆ LeaveRefStatus()

◆ RefInputDone()

◆ RefInputStart()

◆ RemoveRefDlg()

◆ SetActive()

◆ SetModal()

◆ SetReference()

◆ SetupRefDlg()

Member Data Documentation

◆ m_bOwnRefHdlr

◆ m_bRefInputting

◆ m_pTabVwSh

◆ m_sValuePageId

◆ m_xHBox