This class implements a popup window for the auto filter dropdown. More...

#include <checklistmenu.hxx>

Collaboration diagram for ScCheckListMenuControl:

Classes
class	Action
	Action to perform when an event takes place. More...

struct	Config
	Configuration options for this popup window. More...

struct	ExtendedData
	Extended data that the client code may need to store. More...

struct	MenuItemData

struct	ResultEntry

struct	SubMenuItemData

Public Types
typedef std::set< ResultEntry >	ResultType

Public Member Functions
	ScCheckListMenuControl (weld::Widget *pParent, ScViewData &rViewData, bool bTreeMode, int nWidth)

	~ScCheckListMenuControl ()

void	addMenuItem (const OUString &rText, Action *pAction)

void	addSeparator ()

ScListSubMenuControl *	addSubMenuItem (const OUString &rText, bool bEnabled, bool bColorMenu)

void	selectMenuItem (size_t nPos, bool bSubMenuTimer)

void	queueLaunchSubMenu (size_t nPos, ScListSubMenuControl *pMenu)

void	setMemberSize (size_t n)

void	addDateMember (const OUString &rName, double nVal, bool bVisible, bool bHiddenByOtherFilter)

void	addMember (const OUString &rName, const double nVal, bool bVisible, bool bHiddenByOtherFilter, bool bValue=false)

size_t	initMembers (int nMaxMemberWidth=-1)

void	setConfig (const Config &rConfig)

bool	isAllSelected () const

void	getResult (ResultType &rResult)

void	launch (weld::Widget *pWidget, const tools::Rectangle &rRect)

void	close (bool bOK)

void	StartPopupMode (weld::Widget *pParent, const tools::Rectangle &rRect)

void	EndPopupMode ()

size_t	getSubMenuPos (const ScListSubMenuControl *pSubMenu)

void	setSubMenuFocused (const ScListSubMenuControl *pSubMenu)

void	queueCloseSubMenu ()

void	clearSelectedMenuItem ()

void	setExtendedData (std::unique_ptr< ExtendedData > p)
	Set auxiliary data that the client code might need. More...

ExtendedData *	getExtendedData ()
	Get the store auxiliary data, or NULL if no such data is stored. More...

ScViewData &	GetViewData () const

void	GrabFocus ()

void	setOKAction (Action *p)

void	setPopupEndAction (Action *p)

int	GetTextWidth (const OUString &rsName) const

int	IncreaseWindowWidthToFitText (int nMaxTextWidth)

void	terminateAllPopupMenus ()
	Dismiss all visible popup menus and set focus back to the application window. More...

void	endSubMenu (ScListSubMenuControl &rSubMenu)

Static Public Attributes
static constexpr size_t	MENU_NOT_SELECTED = 999

Private Member Functions
void	prepWindow ()
	Calculate the appropriate window size based on the menu items. More...

void	setAllMemberState (bool bSet)

void	selectCurrentMemberOnly (bool bSet)

void	updateMemberParents (const weld::TreeIter *pLeaf, size_t nIdx)

std::unique_ptr< weld::TreeIter >	ShowCheckEntry (const OUString &sName, ScCheckListMember &rMember, bool bShow=true, bool bCheck=true)

void	CheckEntry (std::u16string_view sName, const weld::TreeIter *pParent, bool bCheck)

void	CheckEntry (const weld::TreeIter &rEntry, bool bCheck)

void	GetRecursiveChecked (const weld::TreeIter *pEntry, std::unordered_set< OUString > &vOut, OUString &rLabel)

std::unordered_set< OUString >	GetAllChecked ()

bool	IsChecked (std::u16string_view sName, const weld::TreeIter *pParent)

int	GetCheckedEntryCount () const

void	CheckAllChildren (const weld::TreeIter &rEntry, bool bCheck)

void	setSelectedMenuItem (size_t nPos)

std::unique_ptr< weld::TreeIter >	FindEntry (const weld::TreeIter *pParent, std::u16string_view sNode)

void	executeMenuItem (size_t nPos)

tools::Rectangle	GetSubMenuParentRect ()
	Get the area of the active row. More...

void	handleMenuTimeout (const SubMenuItemData *pTimer)

void	launchSubMenu ()

void	CreateDropDown ()

	DECL_LINK (ButtonHdl, weld::Button &, void)

	DECL_LINK (TriStateHdl, weld::Toggleable &, void)

void	Check (const weld::TreeIter *pIter)

	DECL_LINK (CheckHdl, const weld::TreeView::iter_col &, void)

	DECL_LINK (PopupModeEndHdl, weld::Popover &, void)

	DECL_LINK (EdModifyHdl, weld::Entry &, void)

	DECL_LINK (EdActivateHdl, weld::Entry &, bool)

	DECL_LINK (RowActivatedHdl, weld::TreeView &rMEvt, bool)

	DECL_LINK (SelectHdl, weld::TreeView &, void)

	DECL_LINK (TreeSizeAllocHdl, const Size &, void)

	DECL_LINK (KeyInputHdl, const KeyEvent &, bool)

	DECL_LINK (MenuKeyInputHdl, const KeyEvent &, bool)

	DECL_LINK (MouseEnterHdl, const MouseEvent &, bool)

	DECL_LINK (PostPopdownHdl, void *, void)

void	SetDropdownPos ()

	DECL_LINK (SetDropdownPosHdl, void *, void)

	DECL_LINK (CommandHdl, const CommandEvent &, bool)

void	ResizeToRequest ()

void	DropPendingEvents ()

Private Attributes
std::vector< MenuItemData >	maMenuItems

std::unique_ptr< weld::Builder >	mxBuilder

std::unique_ptr< weld::Popover >	mxPopover

std::unique_ptr< weld::Container >	mxContainer

std::unique_ptr< weld::TreeView >	mxMenu

std::unique_ptr< weld::TreeIter >	mxScratchIter

std::unique_ptr< weld::Widget >	mxNonMenu

std::unique_ptr< weld::Entry >	mxEdSearch

std::unique_ptr< weld::Widget >	mxBox

std::unique_ptr< weld::TreeView >	mxListChecks

std::unique_ptr< weld::TreeView >	mxTreeChecks

weld::TreeView *	mpChecks

std::unique_ptr< weld::CheckButton >	mxChkToggleAll

std::unique_ptr< weld::Button >	mxBtnSelectSingle

std::unique_ptr< weld::Button >	mxBtnUnselectSingle

std::unique_ptr< weld::Box >	mxButtonBox

std::unique_ptr< weld::Button >	mxBtnOk

std::unique_ptr< weld::Button >	mxBtnCancel

std::unique_ptr< weld::Menu >	mxContextMenu

ScopedVclPtr< VirtualDevice >	mxDropDown

std::vector< ScCheckListMember >	maMembers

std::map< OUString, size_t >	maYearMonthMap

std::unique_ptr< ExtendedData >	mxExtendedData

std::unique_ptr< Action >	mxOKAction

std::unique_ptr< Action >	mxPopupEndAction

Config	maConfig

Size	maAllocatedSize

int	mnCheckWidthReq

int	mnWndWidth
	matching width request for mxChecks More...

int	mnCheckListVisibleRows
	whole window width. More...

TriState	mePrevToggleAllState

size_t	mnSelectedMenu

ScViewData &	mrViewData

ImplSVEvent *	mnAsyncPostPopdownId

ImplSVEvent *	mnAsyncSetDropdownPosId

bool	mbHasDates

bool	mbIsPoppedUp

SubMenuItemData	maOpenTimer

SubMenuItemData	maCloseTimer

Detailed Description

This class implements a popup window for the auto filter dropdown.

Definition at line 56 of file checklistmenu.hxx.

Member Typedef Documentation

◆ ResultType

typedef std::set<ResultEntry> ScCheckListMenuControl::ResultType

Definition at line 95 of file checklistmenu.hxx.

Constructor & Destructor Documentation

◆ ScCheckListMenuControl()

ScCheckListMenuControl::ScCheckListMenuControl	(	weld::Widget *	pParent,
		ScViewData &	rViewData,
		bool	bTreeMode,
		int	nWidth
	)

Definition at line 478 of file checklistmenu.cxx.

References weld::Check, CreateDropDown(), LINK, mbHasDates, mnCheckListVisibleRows, mnCheckWidthReq, mpChecks, mxBox, mxBtnCancel, mxBtnOk, mxBtnSelectSingle, mxBtnUnselectSingle, mxButtonBox, mxChkToggleAll, mxContainer, mxContainer, mxEdSearch, mxListChecks, mxMenu, mxNonMenu, mxTreeChecks, nBorderWidth, and TRISTATE_INDET.

◆ ~ScCheckListMenuControl()

ScCheckListMenuControl::~ScCheckListMenuControl ( )

Definition at line 613 of file checklistmenu.cxx.

References DropPendingEvents(), EndPopupMode(), and maMenuItems.

Member Function Documentation

◆ addDateMember()

void ScCheckListMenuControl::addDateMember	(	const OUString &	rName,
		double	nVal,
		bool	bVisible,
		bool	bHiddenByOtherFilter
	)

Definition at line 961 of file checklistmenu.cxx.

References Date::AddDays(), bVisible, ScCheckListMember::DAY, FindEntry(), weld::Widget::freeze(), ScGlobal::GetCalendar(), Date::GetDay(), ScViewData::GetDocument(), ScDocument::GetFormatTable(), Date::GetMonth(), CalendarWrapper::getMonths(), SvNumberFormatter::GetNullDate(), Date::GetYear(), weld::TreeView::insert(), ScCheckListMember::maDateParts, weld::TreeView::make_iterator(), maMembers, ScCheckListMember::maName, ScCheckListMember::maRealName, maYearMonthMap, ScCheckListMember::mbDate, ScCheckListMember::mbHiddenByOtherFilter, ScCheckListMember::mbLeaf, ScCheckListMember::mbVisible, ScCheckListMember::meDatePartType, ScCheckListMember::MONTH, mpChecks, mrViewData, ScCheckListMember::mxParent, weld::TreeView::set_sensitive(), weld::TreeView::set_text(), weld::TreeView::set_toggle(), weld::Widget::thaw(), TRISTATE_FALSE, and ScCheckListMember::YEAR.

◆ addMember()

void ScCheckListMenuControl::addMember	(	const OUString &	rName,
		const double	nVal,
		bool	bVisible,
		bool	bHiddenByOtherFilter,
		bool	bValue = `false`
	)

Definition at line 1055 of file checklistmenu.cxx.

References bVisible, maMembers, ScCheckListMember::maName, ScCheckListMember::maRealName, ScCheckListMember::mbDate, ScCheckListMember::mbHiddenByOtherFilter, ScCheckListMember::mbLeaf, ScCheckListMember::mbValue, ScCheckListMember::mbVisible, ScCheckListMember::mnValue, ScCheckListMember::mxParent, and o3tl::trim().

◆ addMenuItem()

void ScCheckListMenuControl::addMenuItem	(	const OUString &	rText,
		Action *	pAction
	)

Definition at line 121 of file checklistmenu.cxx.

References maMenuItems, ScCheckListMenuControl::MenuItemData::mbEnabled, ScCheckListMenuControl::MenuItemData::mxAction, and mxMenu.

◆ addSeparator()

void ScCheckListMenuControl::addSeparator ( )

Definition at line 133 of file checklistmenu.cxx.

References maMenuItems, and mxMenu.

◆ addSubMenuItem()

ScListSubMenuControl * ScCheckListMenuControl::addSubMenuItem	(	const OUString &	rText,
		bool	bEnabled,
		bool	bColorMenu
	)

Definition at line 190 of file checklistmenu.cxx.

References maMenuItems, ScCheckListMenuControl::MenuItemData::mbEnabled, mxDropDown, mxMenu, and ScCheckListMenuControl::MenuItemData::mxSubMenuWin.

◆ Check()

void ScCheckListMenuControl::Check ( const weld::TreeIter * pIter )

private

Definition at line 890 of file checklistmenu.cxx.

References CheckEntry(), weld::TreeView::get_toggle(), GetCheckedEntryCount(), maConfig, maMembers, ScCheckListMenuControl::Config::mbAllowEmptySet, mePrevToggleAllState, mpChecks, mxBtnOk, mxChkToggleAll, TRISTATE_FALSE, TRISTATE_INDET, and TRISTATE_TRUE.

◆ CheckAllChildren()

void ScCheckListMenuControl::CheckAllChildren	(	const weld::TreeIter &	rEntry,
		bool	bCheck
	)

private

Definition at line 1150 of file checklistmenu.cxx.

References CheckAllChildren(), weld::TreeView::iter_children(), weld::TreeView::iter_next_sibling(), weld::TreeView::make_iterator(), mpChecks, weld::TreeView::set_toggle(), TRISTATE_FALSE, and TRISTATE_TRUE.

Referenced by CheckAllChildren(), and CheckEntry().

◆ CheckEntry() [1/2]

void ScCheckListMenuControl::CheckEntry	(	const weld::TreeIter &	rEntry,
		bool	bCheck
	)

private

Definition at line 1162 of file checklistmenu.cxx.

References CheckAllChildren(), weld::TreeView::get_iter_depth(), weld::TreeView::get_toggle(), weld::TreeView::iter_children(), weld::TreeView::iter_next_sibling(), weld::TreeView::iter_parent(), weld::TreeView::make_iterator(), mpChecks, weld::TreeView::set_toggle(), TRISTATE_FALSE, and TRISTATE_TRUE.

◆ CheckEntry() [2/2]

void ScCheckListMenuControl::CheckEntry	(	std::u16string_view	sName,
		const weld::TreeIter *	pParent,
		bool	bCheck
	)

private

Definition at line 1142 of file checklistmenu.cxx.

References CheckEntry(), FindEntry(), and sName.

Referenced by Check(), CheckEntry(), initMembers(), and ShowCheckEntry().

◆ clearSelectedMenuItem()

void ScCheckListMenuControl::clearSelectedMenuItem ( )

Definition at line 405 of file checklistmenu.cxx.

References MENU_NOT_SELECTED, and selectMenuItem().

◆ close()

void ScCheckListMenuControl::close ( bool bOK )

Definition at line 1467 of file checklistmenu.cxx.

References EndPopupMode(), and mxOKAction.

◆ CreateDropDown()

void ScCheckListMenuControl::CreateDropDown ( )

private

Definition at line 170 of file checklistmenu.cxx.

References DecorationView::DrawSymbol(), VclPtr< class reference_type >::get(), StyleSettings::GetDarkShadowColor(), StyleSettings::GetLightColor(), Application::GetSettings(), AllSettings::GetStyleSettings(), StyleSettings::GetWindowColor(), Color::IsDark(), mxDropDown, mxMenu, and Point.

Referenced by ScCheckListMenuControl().

◆ DECL_LINK() [1/15]

ScCheckListMenuControl::DECL_LINK	(	ButtonHdl	,
		weld::Button &	,
		void
	)

private

◆ DECL_LINK() [2/15]

ScCheckListMenuControl::DECL_LINK	(	CheckHdl	,
		const weld::TreeView::iter_col &	,
		void
	)

private

◆ DECL_LINK() [3/15]

ScCheckListMenuControl::DECL_LINK	(	CommandHdl	,
		const CommandEvent &	,
		bool
	)

private

◆ DECL_LINK() [4/15]

ScCheckListMenuControl::DECL_LINK	(	EdActivateHdl	,
		weld::Entry &	,
		bool
	)

private

◆ DECL_LINK() [5/15]

ScCheckListMenuControl::DECL_LINK	(	EdModifyHdl	,
		weld::Entry &	,
		void
	)

private

◆ DECL_LINK() [6/15]

ScCheckListMenuControl::DECL_LINK	(	KeyInputHdl	,
		const KeyEvent &	,
		bool
	)

private

◆ DECL_LINK() [7/15]

ScCheckListMenuControl::DECL_LINK	(	MenuKeyInputHdl	,
		const KeyEvent &	,
		bool
	)

private

◆ DECL_LINK() [8/15]

ScCheckListMenuControl::DECL_LINK	(	MouseEnterHdl	,
		const MouseEvent &	,
		bool
	)

private

◆ DECL_LINK() [9/15]

ScCheckListMenuControl::DECL_LINK	(	PopupModeEndHdl	,
		weld::Popover &	,
		void
	)

private

◆ DECL_LINK() [10/15]

ScCheckListMenuControl::DECL_LINK	(	PostPopdownHdl	,
		void *	,
		void
	)

private

◆ DECL_LINK() [11/15]

ScCheckListMenuControl::DECL_LINK	(	RowActivatedHdl	,
		weld::TreeView &	rMEvt,
		bool
	)

private

◆ DECL_LINK() [12/15]

ScCheckListMenuControl::DECL_LINK	(	SelectHdl	,
		weld::TreeView &	,
		void
	)

private

◆ DECL_LINK() [13/15]

ScCheckListMenuControl::DECL_LINK	(	SetDropdownPosHdl	,
		void *	,
		void
	)

private

◆ DECL_LINK() [14/15]

ScCheckListMenuControl::DECL_LINK	(	TreeSizeAllocHdl	,
		const Size &	,
		void
	)

private

◆ DECL_LINK() [15/15]

ScCheckListMenuControl::DECL_LINK	(	TriStateHdl	,
		weld::Toggleable &	,
		void
	)

private

◆ DropPendingEvents()

void ScCheckListMenuControl::DropPendingEvents ( )

private

Definition at line 599 of file checklistmenu.cxx.

References mnAsyncPostPopdownId, mnAsyncSetDropdownPosId, and Application::RemoveUserEvent().

Referenced by ~ScCheckListMenuControl().

◆ EndPopupMode()

void ScCheckListMenuControl::EndPopupMode ( )

Definition at line 432 of file checklistmenu.cxx.

References mbIsPoppedUp, and mxPopover.

Referenced by close(), terminateAllPopupMenus(), and ~ScCheckListMenuControl().

◆ endSubMenu()

void ScCheckListMenuControl::endSubMenu ( ScListSubMenuControl & rSubMenu )

Definition at line 359 of file checklistmenu.cxx.

References ScListSubMenuControl::EndPopupMode(), getSubMenuPos(), LINK, maOpenTimer, MENU_NOT_SELECTED, mnAsyncPostPopdownId, mnSelectedMenu, mxMenu, Application::PostUserEvent(), and ScCheckListMenuControl::SubMenuItemData::reset().

◆ executeMenuItem()

void ScCheckListMenuControl::executeMenuItem ( size_t nPos )

private

Definition at line 204 of file checklistmenu.cxx.

References launchSubMenu(), maMenuItems, maOpenTimer, ScCheckListMenuControl::MenuItemData::mbEnabled, ScCheckListMenuControl::SubMenuItemData::mnMenuPos, ScCheckListMenuControl::SubMenuItemData::mpSubMenu, ScCheckListMenuControl::MenuItemData::mxSubMenuWin, nPos, and terminateAllPopupMenus().

Referenced by IMPL_LINK(), and IMPL_LINK_NOARG().

◆ FindEntry()

std::unique_ptr< weld::TreeIter > ScCheckListMenuControl::FindEntry	(	const weld::TreeIter *	pParent,
		std::u16string_view	sNode
	)

private

Definition at line 1071 of file checklistmenu.cxx.

References weld::TreeView::get_iter_first(), weld::TreeView::get_text(), weld::TreeView::iter_children(), weld::TreeView::iter_next_sibling(), weld::TreeView::make_iterator(), and mpChecks.

Referenced by addDateMember(), CheckEntry(), initMembers(), IsChecked(), ShowCheckEntry(), and updateMemberParents().

◆ GetAllChecked()

std::unordered_set< OUString > ScCheckListMenuControl::GetAllChecked ( )

private

Definition at line 1118 of file checklistmenu.cxx.

References aLabel, weld::TreeView::get_iter_first(), GetRecursiveChecked(), weld::TreeView::iter_next_sibling(), weld::TreeView::make_iterator(), and mpChecks.

Referenced by getResult().

◆ GetCheckedEntryCount()

int ScCheckListMenuControl::GetCheckedEntryCount ( ) const

private

Definition at line 1264 of file checklistmenu.cxx.

References weld::TreeView::all_foreach(), weld::TreeView::get_toggle(), mpChecks, and TRISTATE_TRUE.

Referenced by Check(), launch(), and setAllMemberState().

◆ getExtendedData()

ScCheckListMenuControl::ExtendedData * ScCheckListMenuControl::getExtendedData ( )

Get the store auxiliary data, or NULL if no such data is stored.

Definition at line 1479 of file checklistmenu.cxx.

References mxExtendedData.

Referenced by ScListSubMenuControl::getExtendedData().

◆ GetRecursiveChecked()

void ScCheckListMenuControl::GetRecursiveChecked	(	const weld::TreeIter *	pEntry,
		std::unordered_set< OUString > &	vOut,
		OUString &	rLabel
	)

private

Definition at line 1084 of file checklistmenu.cxx.

References aLabel, weld::TreeView::get_text(), weld::TreeView::get_toggle(), GetRecursiveChecked(), weld::TreeView::iter_children(), weld::TreeView::iter_has_child(), weld::TreeView::iter_next_sibling(), weld::TreeView::make_iterator(), mpChecks, and TRISTATE_TRUE.

Referenced by GetAllChecked(), and GetRecursiveChecked().

◆ getResult()

void ScCheckListMenuControl::getResult ( ResultType & rResult )

Definition at line 1392 of file checklistmenu.cxx.

References aLabel, ScCheckListMenuControl::ResultEntry::aName, ScCheckListMenuControl::ResultEntry::bDate, ScCheckListMenuControl::ResultEntry::bValid, ScCheckListMenuControl::ResultEntry::bValue, weld::TreeView::get_text(), GetAllChecked(), i, weld::TreeView::iter_parent(), weld::TreeView::make_iterator(), maMembers, maName, mpChecks, mxParent, n, ScCheckListMenuControl::ResultEntry::nValue, and ScResId().

◆ GetSubMenuParentRect()

tools::Rectangle ScCheckListMenuControl::GetSubMenuParentRect ( )

private

Get the area of the active row.

Suitable as the parent rectangle argument for Executing a popup

Definition at line 322 of file checklistmenu.cxx.

References mxMenu, and mxScratchIter.

Referenced by launchSubMenu().

◆ getSubMenuPos()

size_t ScCheckListMenuControl::getSubMenuPos ( const ScListSubMenuControl * pSubMenu )

Definition at line 410 of file checklistmenu.cxx.

References i, maMenuItems, MENU_NOT_SELECTED, and n.

Referenced by endSubMenu(), and setSubMenuFocused().

◆ GetTextWidth()

int ScCheckListMenuControl::GetTextWidth ( const OUString & rsName ) const

Definition at line 1504 of file checklistmenu.cxx.

References mxDropDown.

◆ GetViewData()

ScViewData & ScCheckListMenuControl::GetViewData ( ) const

inline

Definition at line 169 of file checklistmenu.hxx.

References mrViewData.

Referenced by ScListSubMenuControl::GetViewData().

◆ GrabFocus()

void ScCheckListMenuControl::GrabFocus ( )

Definition at line 588 of file checklistmenu.cxx.

References mxEdSearch, and mxMenu.

Referenced by StartPopupMode().

◆ handleMenuTimeout()

void ScCheckListMenuControl::handleMenuTimeout ( const SubMenuItemData * pTimer )

private

Definition at line 239 of file checklistmenu.cxx.

References ScListSubMenuControl::EndPopupMode(), launchSubMenu(), LINK, maCloseTimer, maOpenTimer, ScCheckListMenuControl::SubMenuItemData::maTimer, mnAsyncPostPopdownId, ScCheckListMenuControl::SubMenuItemData::mpSubMenu, Application::PostUserEvent(), and Task::Stop().

◆ IncreaseWindowWidthToFitText()

int ScCheckListMenuControl::IncreaseWindowWidthToFitText ( int nMaxTextWidth )

Definition at line 1509 of file checklistmenu.cxx.

References weld::TreeView::get_height_rows(), mnCheckWidthReq, mpChecks, nBorder, nBorderWidth, nCheckListVisibleRows, and weld::Widget::set_size_request().

◆ initMembers()

size_t ScCheckListMenuControl::initMembers ( int nMaxMemberWidth = -1 )

◆ isAllSelected()

bool ScCheckListMenuControl::isAllSelected ( ) const

Definition at line 1387 of file checklistmenu.cxx.

References mxChkToggleAll, and TRISTATE_TRUE.

◆ IsChecked()

bool ScCheckListMenuControl::IsChecked	(	std::u16string_view	sName,
		const weld::TreeIter *	pParent
	)

private

Definition at line 1136 of file checklistmenu.cxx.

References FindEntry(), weld::TreeView::get_toggle(), mpChecks, sName, and TRISTATE_TRUE.

Referenced by initMembers().

◆ launch()

void ScCheckListMenuControl::launch	(	weld::Widget *	pWidget,
		const tools::Rectangle &	rRect
	)

Definition at line 1432 of file checklistmenu.cxx.

References tools::Rectangle::AdjustLeft(), GetCheckedEntryCount(), tools::Rectangle::GetWidth(), comphelper::LibreOfficeKit::isActive(), tools::Rectangle::Left(), maConfig, ScCheckListMenuControl::Config::mbAllowEmptySet, ScCheckListMenuControl::Config::mbRTL, mnWndWidth, tools::Rectangle::Move(), mxBtnOk, prepWindow(), tools::Rectangle::SetLeft(), and StartPopupMode().

◆ launchSubMenu()

void ScCheckListMenuControl::launchSubMenu ( )

private

Definition at line 329 of file checklistmenu.cxx.

References GetSubMenuParentRect(), ScListSubMenuControl::GrabFocus(), maOpenTimer, ScCheckListMenuControl::SubMenuItemData::mpSubMenu, mxMenu, mxScratchIter, and ScListSubMenuControl::StartPopupMode().

Referenced by executeMenuItem(), and handleMenuTimeout().

◆ prepWindow()

void ScCheckListMenuControl::prepWindow ( )

private

Calculate the appropriate window size based on the menu items.

Definition at line 621 of file checklistmenu.cxx.

References MENU_NOT_SELECTED, mnSelectedMenu, mnWndWidth, mxContainer, mxMenu, and nBorderWidth.

Referenced by launch().

◆ queueCloseSubMenu()

void ScCheckListMenuControl::queueCloseSubMenu ( )

Definition at line 296 of file checklistmenu.cxx.

References ScListSubMenuControl::EndPopupMode(), Timer::Invoke(), comphelper::LibreOfficeKit::isActive(), maCloseTimer, maOpenTimer, ScCheckListMenuControl::SubMenuItemData::maTimer, MENU_NOT_SELECTED, ScCheckListMenuControl::SubMenuItemData::mnMenuPos, ScCheckListMenuControl::SubMenuItemData::mpSubMenu, Timer::Start(), and Task::Stop().

Referenced by queueLaunchSubMenu(), and selectMenuItem().

◆ queueLaunchSubMenu()

void ScCheckListMenuControl::queueLaunchSubMenu	(	size_t	nPos,
		ScListSubMenuControl *	pMenu
	)

Definition at line 268 of file checklistmenu.cxx.

References Timer::Invoke(), comphelper::LibreOfficeKit::isActive(), maCloseTimer, maOpenTimer, ScCheckListMenuControl::SubMenuItemData::maTimer, ScCheckListMenuControl::SubMenuItemData::mnMenuPos, ScCheckListMenuControl::SubMenuItemData::mpSubMenu, nPos, queueCloseSubMenu(), ScCheckListMenuControl::SubMenuItemData::reset(), and Timer::Start().

Referenced by selectMenuItem().

◆ ResizeToRequest()

void ScCheckListMenuControl::ResizeToRequest ( )

private

Definition at line 679 of file checklistmenu.cxx.

References mnCheckListVisibleRows, mnCheckWidthReq, mxListChecks, mxPopover, and mxTreeChecks.

◆ selectCurrentMemberOnly()

void ScCheckListMenuControl::selectCurrentMemberOnly ( bool bSet )

private

Definition at line 649 of file checklistmenu.cxx.

References weld::TreeView::get_cursor(), weld::TreeView::make_iterator(), mpChecks, weld::TreeView::set_toggle(), setAllMemberState(), TRISTATE_FALSE, and TRISTATE_TRUE.

◆ selectMenuItem()

void ScCheckListMenuControl::selectMenuItem	(	size_t	nPos,
		bool	bSubMenuTimer
	)

Definition at line 376 of file checklistmenu.cxx.

References maMenuItems, MENU_NOT_SELECTED, mnSelectedMenu, mxMenu, nPos, queueCloseSubMenu(), and queueLaunchSubMenu().

Referenced by clearSelectedMenuItem(), IMPL_LINK(), and setSelectedMenuItem().

◆ setAllMemberState()

void ScCheckListMenuControl::setAllMemberState ( bool bSet )

private

Definition at line 634 of file checklistmenu.cxx.

References weld::TreeView::all_foreach(), weld::TreeView::get_sensitive(), GetCheckedEntryCount(), maConfig, ScCheckListMenuControl::Config::mbAllowEmptySet, mpChecks, mxBtnOk, weld::TreeView::set_toggle(), TRISTATE_FALSE, and TRISTATE_TRUE.

Referenced by selectCurrentMemberOnly().

◆ setConfig()

void ScCheckListMenuControl::setConfig ( const Config & rConfig )

Definition at line 1382 of file checklistmenu.cxx.

References maConfig.

◆ SetDropdownPos()

void ScCheckListMenuControl::SetDropdownPos ( )

private

Definition at line 154 of file checklistmenu.cxx.

References maAllocatedSize, mxMenu, and Size::Width().

Referenced by IMPL_LINK(), and IMPL_LINK_NOARG().

◆ setExtendedData()

void ScCheckListMenuControl::setExtendedData ( std::unique_ptr< ExtendedData > p )

Set auxiliary data that the client code might need.

Note that this popup window class manages its life time; no explicit deletion of the instance is needed in the client code.

Definition at line 1474 of file checklistmenu.cxx.

References mxExtendedData, and p.

◆ setMemberSize()

void ScCheckListMenuControl::setMemberSize ( size_t n )

Definition at line 956 of file checklistmenu.cxx.

References maMembers, and n.

◆ setOKAction()

void ScCheckListMenuControl::setOKAction ( Action * p )

Definition at line 1484 of file checklistmenu.cxx.

References mxOKAction, and p.

◆ setPopupEndAction()

void ScCheckListMenuControl::setPopupEndAction ( Action * p )

Definition at line 1489 of file checklistmenu.cxx.

References mxPopupEndAction, and p.

◆ setSelectedMenuItem()

void ScCheckListMenuControl::setSelectedMenuItem ( size_t nPos )

private

Definition at line 230 of file checklistmenu.cxx.

References mnSelectedMenu, nPos, and selectMenuItem().

Referenced by IMPL_LINK_NOARG().

◆ setSubMenuFocused()

void ScCheckListMenuControl::setSubMenuFocused ( const ScListSubMenuControl * pSubMenu )

Definition at line 421 of file checklistmenu.cxx.

References getSubMenuPos(), maCloseTimer, mnSelectedMenu, mxMenu, and ScCheckListMenuControl::SubMenuItemData::reset().

Referenced by ScListSubMenuControl::StartPopupMode().

◆ ShowCheckEntry()

std::unique_ptr< weld::TreeIter > ScCheckListMenuControl::ShowCheckEntry	(	const OUString &	sName,
		ScCheckListMember &	rMember,
		bool	bShow = `true`,
		bool	bCheck = `true`
	)

private

◆ StartPopupMode()

void ScCheckListMenuControl::StartPopupMode	(	weld::Widget *	pParent,
		const tools::Rectangle &	rRect
	)

Definition at line 442 of file checklistmenu.cxx.

References GrabFocus(), LINK, mbIsPoppedUp, and mxPopover.

Referenced by launch().

◆ terminateAllPopupMenus()

void ScCheckListMenuControl::terminateAllPopupMenus ( )

Dismiss all visible popup menus and set focus back to the application window.

This method is called e.g. when a menu action is fired.

Definition at line 450 of file checklistmenu.cxx.

References EndPopupMode().

Referenced by executeMenuItem(), and ScListSubMenuControl::terminateAllPopupMenus().

◆ updateMemberParents()

void ScCheckListMenuControl::updateMemberParents	(	const weld::TreeIter *	pLeaf,
		size_t	nIdx
	)

private

Definition at line 913 of file checklistmenu.cxx.

References ScCheckListMember::DAY, FindEntry(), weld::TreeView::iter_parent(), weld::TreeView::make_iterator(), maMembers, maYearMonthMap, and mpChecks.

Member Data Documentation

◆ maAllocatedSize

Size ScCheckListMenuControl::maAllocatedSize

private

Definition at line 291 of file checklistmenu.hxx.

Referenced by IMPL_LINK(), and SetDropdownPos().

◆ maCloseTimer

SubMenuItemData ScCheckListMenuControl::maCloseTimer

private

Definition at line 323 of file checklistmenu.hxx.

Referenced by handleMenuTimeout(), queueCloseSubMenu(), queueLaunchSubMenu(), and setSubMenuFocused().

◆ maConfig

Config ScCheckListMenuControl::maConfig

private

Definition at line 290 of file checklistmenu.hxx.

Referenced by Check(), launch(), setAllMemberState(), and setConfig().

◆ maMembers

std::vector<ScCheckListMember> ScCheckListMenuControl::maMembers

private

Definition at line 282 of file checklistmenu.hxx.

Referenced by addDateMember(), addMember(), Check(), getResult(), initMembers(), setMemberSize(), and updateMemberParents().

◆ maMenuItems

std::vector<MenuItemData> ScCheckListMenuControl::maMenuItems

private

Definition at line 188 of file checklistmenu.hxx.

Referenced by addMenuItem(), addSeparator(), addSubMenuItem(), executeMenuItem(), getSubMenuPos(), IMPL_LINK(), IMPL_LINK_NOARG(), selectMenuItem(), and ~ScCheckListMenuControl().

◆ maOpenTimer

SubMenuItemData ScCheckListMenuControl::maOpenTimer

private

Definition at line 322 of file checklistmenu.hxx.

Referenced by endSubMenu(), executeMenuItem(), handleMenuTimeout(), launchSubMenu(), queueCloseSubMenu(), and queueLaunchSubMenu().

◆ maYearMonthMap

std::map<OUString, size_t> ScCheckListMenuControl::maYearMonthMap

private

Definition at line 284 of file checklistmenu.hxx.

Referenced by addDateMember(), and updateMemberParents().

◆ mbHasDates

bool ScCheckListMenuControl::mbHasDates

private

Definition at line 304 of file checklistmenu.hxx.

Referenced by initMembers(), and ScCheckListMenuControl().

◆ mbIsPoppedUp

bool ScCheckListMenuControl::mbIsPoppedUp

private

Definition at line 305 of file checklistmenu.hxx.

Referenced by EndPopupMode(), and StartPopupMode().

◆ MENU_NOT_SELECTED

constexpr size_t ScCheckListMenuControl::MENU_NOT_SELECTED = 999

staticconstexpr

Definition at line 59 of file checklistmenu.hxx.

Referenced by clearSelectedMenuItem(), endSubMenu(), getSubMenuPos(), IMPL_LINK(), IMPL_LINK_NOARG(), prepWindow(), queueCloseSubMenu(), ScCheckListMenuControl::SubMenuItemData::reset(), and selectMenuItem().

◆ mePrevToggleAllState

TriState ScCheckListMenuControl::mePrevToggleAllState

private

Definition at line 295 of file checklistmenu.hxx.

Referenced by Check(), and initMembers().

◆ mnAsyncPostPopdownId

ImplSVEvent* ScCheckListMenuControl::mnAsyncPostPopdownId

private

Definition at line 301 of file checklistmenu.hxx.

Referenced by DropPendingEvents(), endSubMenu(), handleMenuTimeout(), and IMPL_LINK_NOARG().

◆ mnAsyncSetDropdownPosId

ImplSVEvent* ScCheckListMenuControl::mnAsyncSetDropdownPosId

private

Definition at line 302 of file checklistmenu.hxx.

Referenced by DropPendingEvents(), IMPL_LINK(), and IMPL_LINK_NOARG().

◆ mnCheckListVisibleRows

int ScCheckListMenuControl::mnCheckListVisibleRows

private

whole window width.

Definition at line 294 of file checklistmenu.hxx.

Referenced by ResizeToRequest(), and ScCheckListMenuControl().

◆ mnCheckWidthReq

int ScCheckListMenuControl::mnCheckWidthReq

private

Definition at line 292 of file checklistmenu.hxx.

Referenced by IncreaseWindowWidthToFitText(), initMembers(), ResizeToRequest(), and ScCheckListMenuControl().

◆ mnSelectedMenu

size_t ScCheckListMenuControl::mnSelectedMenu

private

Definition at line 297 of file checklistmenu.hxx.

Referenced by endSubMenu(), IMPL_LINK(), IMPL_LINK_NOARG(), prepWindow(), selectMenuItem(), setSelectedMenuItem(), and setSubMenuFocused().

◆ mnWndWidth

int ScCheckListMenuControl::mnWndWidth

private

matching width request for mxChecks

Definition at line 293 of file checklistmenu.hxx.

Referenced by launch(), and prepWindow().

◆ mpChecks

weld::TreeView* ScCheckListMenuControl::mpChecks

private

Definition at line 269 of file checklistmenu.hxx.

Referenced by addDateMember(), Check(), CheckAllChildren(), CheckEntry(), FindEntry(), GetAllChecked(), GetCheckedEntryCount(), GetRecursiveChecked(), getResult(), IncreaseWindowWidthToFitText(), initMembers(), IsChecked(), ScCheckListMenuControl(), selectCurrentMemberOnly(), setAllMemberState(), ShowCheckEntry(), and updateMemberParents().

◆ mrViewData

ScViewData& ScCheckListMenuControl::mrViewData

private

Definition at line 299 of file checklistmenu.hxx.

Referenced by addDateMember(), and GetViewData().

◆ mxBox

std::unique_ptr<weld::Widget> ScCheckListMenuControl::mxBox

private

Definition at line 266 of file checklistmenu.hxx.

Referenced by ScCheckListMenuControl().

◆ mxBtnCancel

std::unique_ptr<weld::Button> ScCheckListMenuControl::mxBtnCancel

private

Definition at line 277 of file checklistmenu.hxx.

Referenced by ScCheckListMenuControl().

◆ mxBtnOk

std::unique_ptr<weld::Button> ScCheckListMenuControl::mxBtnOk

private

Definition at line 276 of file checklistmenu.hxx.

Referenced by Check(), launch(), ScCheckListMenuControl(), and setAllMemberState().

◆ mxBtnSelectSingle

std::unique_ptr<weld::Button> ScCheckListMenuControl::mxBtnSelectSingle

private

Definition at line 272 of file checklistmenu.hxx.

Referenced by ScCheckListMenuControl().

◆ mxBtnUnselectSingle

std::unique_ptr<weld::Button> ScCheckListMenuControl::mxBtnUnselectSingle

private

Definition at line 273 of file checklistmenu.hxx.

Referenced by ScCheckListMenuControl().

◆ mxBuilder

std::unique_ptr<weld::Builder> ScCheckListMenuControl::mxBuilder

private

Definition at line 259 of file checklistmenu.hxx.

◆ mxButtonBox

std::unique_ptr<weld::Box> ScCheckListMenuControl::mxButtonBox

private

Definition at line 275 of file checklistmenu.hxx.

Referenced by ScCheckListMenuControl().

◆ mxChkToggleAll

std::unique_ptr<weld::CheckButton> ScCheckListMenuControl::mxChkToggleAll

private

Definition at line 271 of file checklistmenu.hxx.

Referenced by Check(), initMembers(), isAllSelected(), and ScCheckListMenuControl().

◆ mxContainer

std::unique_ptr<weld::Container> ScCheckListMenuControl::mxContainer

private

Definition at line 261 of file checklistmenu.hxx.

Referenced by prepWindow(), and ScCheckListMenuControl().

◆ mxContextMenu

std::unique_ptr<weld::Menu> ScCheckListMenuControl::mxContextMenu

private

Definition at line 278 of file checklistmenu.hxx.

◆ mxDropDown

ScopedVclPtr<VirtualDevice> ScCheckListMenuControl::mxDropDown

private

Definition at line 280 of file checklistmenu.hxx.

Referenced by addSubMenuItem(), CreateDropDown(), and GetTextWidth().

◆ mxEdSearch

std::unique_ptr<weld::Entry> ScCheckListMenuControl::mxEdSearch

private

Definition at line 265 of file checklistmenu.hxx.

Referenced by GrabFocus(), and ScCheckListMenuControl().

◆ mxExtendedData

std::unique_ptr<ExtendedData> ScCheckListMenuControl::mxExtendedData

private

Definition at line 286 of file checklistmenu.hxx.

Referenced by getExtendedData(), and setExtendedData().

◆ mxListChecks

std::unique_ptr<weld::TreeView> ScCheckListMenuControl::mxListChecks

private

Definition at line 267 of file checklistmenu.hxx.

Referenced by ResizeToRequest(), and ScCheckListMenuControl().

◆ mxMenu

std::unique_ptr<weld::TreeView> ScCheckListMenuControl::mxMenu

private

Definition at line 262 of file checklistmenu.hxx.

Referenced by addMenuItem(), addSeparator(), addSubMenuItem(), CreateDropDown(), endSubMenu(), GetSubMenuParentRect(), GrabFocus(), IMPL_LINK_NOARG(), launchSubMenu(), prepWindow(), ScCheckListMenuControl(), selectMenuItem(), SetDropdownPos(), and setSubMenuFocused().

◆ mxNonMenu

std::unique_ptr<weld::Widget> ScCheckListMenuControl::mxNonMenu

private

Definition at line 264 of file checklistmenu.hxx.

Referenced by ScCheckListMenuControl().

◆ mxOKAction

std::unique_ptr<Action> ScCheckListMenuControl::mxOKAction

private

Definition at line 287 of file checklistmenu.hxx.

Referenced by close(), and setOKAction().

◆ mxPopover

std::unique_ptr<weld::Popover> ScCheckListMenuControl::mxPopover

private

Definition at line 260 of file checklistmenu.hxx.

Referenced by EndPopupMode(), ResizeToRequest(), and StartPopupMode().

◆ mxPopupEndAction

std::unique_ptr<Action> ScCheckListMenuControl::mxPopupEndAction

private

Definition at line 288 of file checklistmenu.hxx.

Referenced by setPopupEndAction().

◆ mxScratchIter

std::unique_ptr<weld::TreeIter> ScCheckListMenuControl::mxScratchIter

private

Definition at line 263 of file checklistmenu.hxx.

Referenced by GetSubMenuParentRect(), IMPL_LINK_NOARG(), and launchSubMenu().

◆ mxTreeChecks

std::unique_ptr<weld::TreeView> ScCheckListMenuControl::mxTreeChecks

private

Definition at line 268 of file checklistmenu.hxx.

Referenced by ResizeToRequest(), and ScCheckListMenuControl().

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

Classes

Public Types

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ResultType

Constructor & Destructor Documentation

◆ ScCheckListMenuControl()

◆ ~ScCheckListMenuControl()

Member Function Documentation

◆ addDateMember()

◆ addMember()

◆ addMenuItem()

◆ addSeparator()

◆ addSubMenuItem()

◆ Check()

◆ CheckAllChildren()

◆ CheckEntry() [1/2]

◆ CheckEntry() [2/2]

◆ clearSelectedMenuItem()

◆ close()

◆ CreateDropDown()

◆ DECL_LINK() [1/15]

◆ DECL_LINK() [2/15]

◆ DECL_LINK() [3/15]

◆ DECL_LINK() [4/15]

◆ DECL_LINK() [5/15]

◆ DECL_LINK() [6/15]

◆ DECL_LINK() [7/15]

◆ DECL_LINK() [8/15]

◆ DECL_LINK() [9/15]

◆ DECL_LINK() [10/15]

◆ DECL_LINK() [11/15]

◆ DECL_LINK() [12/15]

◆ DECL_LINK() [13/15]

◆ DECL_LINK() [14/15]

◆ DECL_LINK() [15/15]

◆ DropPendingEvents()

◆ EndPopupMode()

◆ endSubMenu()

◆ executeMenuItem()

◆ FindEntry()

◆ GetAllChecked()

◆ GetCheckedEntryCount()

◆ getExtendedData()

◆ GetRecursiveChecked()

◆ getResult()

◆ GetSubMenuParentRect()

◆ getSubMenuPos()

◆ GetTextWidth()

◆ GetViewData()

◆ GrabFocus()

◆ handleMenuTimeout()

◆ IncreaseWindowWidthToFitText()

◆ initMembers()

◆ isAllSelected()

◆ IsChecked()

◆ launch()

◆ launchSubMenu()

◆ prepWindow()

◆ queueCloseSubMenu()

◆ queueLaunchSubMenu()

◆ ResizeToRequest()

◆ selectCurrentMemberOnly()

◆ selectMenuItem()

◆ setAllMemberState()

◆ setConfig()

◆ SetDropdownPos()

◆ setExtendedData()

◆ setMemberSize()

◆ setOKAction()

◆ setPopupEndAction()

◆ setSelectedMenuItem()

◆ setSubMenuFocused()

◆ ShowCheckEntry()

◆ StartPopupMode()

◆ terminateAllPopupMenus()