#include <menu.hxx>

Inheritance diagram for Menu:

Collaboration diagram for Menu:

Public Member Functions
SAL_DLLPRIVATE void	ImplKillLayoutData () const

SAL_DLLPRIVATE vcl::Window *	ImplGetWindow () const

virtual	~Menu () override

virtual void	dispose () override

void	Activate ()

void	Deactivate ()

void	Select ()

void	InsertItem (sal_uInt16 nItemId, const OUString &rStr, MenuItemBits nItemBits=MenuItemBits::NONE, const OUString &rIdent={}, sal_uInt16 nPos=MENU_APPEND)

void	InsertItem (sal_uInt16 nItemId, const Image &rImage, MenuItemBits nItemBits=MenuItemBits::NONE, const OUString &rIdent={}, sal_uInt16 nPos=MENU_APPEND)

void	InsertItem (sal_uInt16 nItemId, const OUString &rString, const Image &rImage, MenuItemBits nItemBits=MenuItemBits::NONE, const OUString &rIdent={}, sal_uInt16 nPos=MENU_APPEND)

void	InsertSeparator (const OUString &rIdent={}, sal_uInt16 nPos=MENU_APPEND)

void	RemoveItem (sal_uInt16 nPos)

void	Clear ()

void	CreateAutoMnemonics ()

void	SetMenuFlags (MenuFlags nFlags)

MenuFlags	GetMenuFlags () const

bool	HasValidEntries (bool bCheckPopups) const

sal_uInt16	GetItemCount () const

sal_uInt16	GetItemId (sal_uInt16 nPos) const

sal_uInt16	GetItemId (std::u16string_view rIdent) const

sal_uInt16	GetItemPos (sal_uInt16 nItemId) const

OUString	GetItemIdent (sal_uInt16 nItemId) const

MenuItemType	GetItemType (sal_uInt16 nPos) const

sal_uInt16	GetCurItemId () const

OUString const &	GetCurItemIdent () const

void	SetItemBits (sal_uInt16 nItemId, MenuItemBits nBits)

MenuItemBits	GetItemBits (sal_uInt16 nItemId) const

void	SetUserValue (sal_uInt16 nItemId, void *nUserValue, MenuUserDataReleaseFunction aFunc=nullptr)

void *	GetUserValue (sal_uInt16 nItemId) const

void	SetPopupMenu (sal_uInt16 nItemId, PopupMenu *pMenu)

PopupMenu *	GetPopupMenu (sal_uInt16 nItemId) const

void	SetAccelKey (sal_uInt16 nItemId, const vcl::KeyCode &rKeyCode)

vcl::KeyCode	GetAccelKey (sal_uInt16 nItemId) const

void	CheckItem (sal_uInt16 nItemId, bool bCheck=true)

void	CheckItem (std::u16string_view rIdent, bool bCheck=true)

bool	IsItemChecked (sal_uInt16 nItemId) const

virtual void	SelectItem (sal_uInt16 nItemId)=0

void	EnableItem (sal_uInt16 nItemId, bool bEnable=true)

void	EnableItem (std::u16string_view rIdent, bool bEnable=true)

bool	IsItemEnabled (sal_uInt16 nItemId) const

void	ShowItem (sal_uInt16 nItemId, bool bVisible=true)

void	HideItem (sal_uInt16 nItemId)

bool	IsItemPosVisible (sal_uInt16 nItemPos) const

bool	IsMenuVisible () const

virtual bool	IsMenuBar () const =0

void	RemoveDisabledEntries (bool bRemoveEmptyPopups=false)

void	UpdateNativeMenu ()

void	SetItemText (sal_uInt16 nItemId, const OUString &rStr)

OUString	GetItemText (sal_uInt16 nItemId) const

void	SetItemImage (sal_uInt16 nItemId, const Image &rImage)

Image	GetItemImage (sal_uInt16 nItemId) const

void	SetItemCommand (sal_uInt16 nItemId, const OUString &rCommand)

OUString	GetItemCommand (sal_uInt16 nItemId) const

void	SetHelpText (sal_uInt16 nItemId, const OUString &rString)

OUString	GetHelpText (sal_uInt16 nItemId) const

void	SetTipHelpText (sal_uInt16 nItemId, const OUString &rString)

OUString	GetTipHelpText (sal_uInt16 nItemId) const

void	SetHelpCommand (sal_uInt16 nItemId, const OUString &rString)

OUString	GetHelpCommand (sal_uInt16 nItemId) const

void	SetHelpId (sal_uInt16 nItemId, const OUString &rHelpId)

OUString	GetHelpId (sal_uInt16 nItemId) const

void	SetHelpId (const OUString &rHelpId)

OUString	GetHelpId () const

void	SetActivateHdl (const Link< Menu *, bool > &rLink)

void	SetDeactivateHdl (const Link< Menu *, bool > &rLink)

void	SetSelectHdl (const Link< Menu *, bool > &rLink)

sal_uInt16	GetTitleHeight () const

void	AddEventListener (const Link< VclMenuEvent &, void > &rEventListener)

void	RemoveEventListener (const Link< VclMenuEvent &, void > &rEventListener)

Menu &	operator= (const Menu &rMenu)

MenuItemList *	GetItemList () const

void	GetSystemMenuData (SystemMenuData *pData) const

tools::Rectangle	GetCharacterBounds (sal_uInt16 nItemId, tools::Long nIndex) const

tools::Long	GetIndexForPoint (const Point &rPoint, sal_uInt16 &rItemID) const

tools::Rectangle	GetBoundingRectangle (sal_uInt16 nItemPos) const

css::uno::Reference< css::accessibility::XAccessible >	GetAccessible ()

void	SetAccessible (const css::uno::Reference< css::accessibility::XAccessible > &rxAccessible)

KeyEvent	GetActivationKey (sal_uInt16 nItemId) const

vcl::Window *	GetWindow () const

void	SetAccessibleName (sal_uInt16 nItemId, const OUString &rStr)

OUString	GetAccessibleName (sal_uInt16 nItemId) const

void	SetAccessibleDescription (sal_uInt16 nItemId, const OUString &rStr)

OUString	GetAccessibleDescription (sal_uInt16 nItemId) const

bool	IsHighlighted (sal_uInt16 nItemPos) const

void	HighlightItem (sal_uInt16 nItemPos)

void	DeHighlight ()

bool	HandleMenuCommandEvent (Menu *pMenu, sal_uInt16 nEventId) const

bool	HandleMenuActivateEvent (Menu *pMenu) const

bool	HandleMenuDeActivateEvent (Menu *pMenu) const

void	set_id (const OUString &rID)
	Sets an ID. More...

const OUString &	get_id () const
	Get the ID of the window. More...

Public Member Functions inherited from VclReferenceBase
void	acquire () const

void	release () const

sal_Int32	getRefCount () const

void	disposeOnce ()

bool	isDisposed () const

Protected Member Functions
SAL_DLLPRIVATE Menu *	ImplGetStartMenu ()

SAL_DLLPRIVATE Menu *	ImplFindSelectMenu ()

SAL_DLLPRIVATE Menu *	ImplFindMenu (sal_uInt16 nId)

SAL_DLLPRIVATE Size	ImplCalcSize (vcl::Window *pWin)

SAL_DLLPRIVATE bool	ImplIsVisible (sal_uInt16 nPos) const

SAL_DLLPRIVATE bool	ImplCurrentlyHiddenOnGUI (sal_uInt16 nPos) const

SAL_DLLPRIVATE bool	ImplIsSelectable (sal_uInt16 nPos) const

SAL_DLLPRIVATE sal_uInt16	ImplGetVisibleItemCount () const

SAL_DLLPRIVATE sal_uInt16	ImplGetFirstVisible () const

SAL_DLLPRIVATE sal_uInt16	ImplGetPrevVisible (sal_uInt16 nPos) const

SAL_DLLPRIVATE sal_uInt16	ImplGetNextVisible (sal_uInt16 nPos) const

SAL_DLLPRIVATE void	ImplPaint (vcl::RenderContext &rRenderContext, Size const &rSize, sal_uInt16 nBorder, tools::Long nOffY=0, MenuItemData const *pThisDataOnly=nullptr, bool bHighlighted=false, bool bLayout=false, bool bRollover=false) const

SAL_DLLPRIVATE void	ImplPaintMenuTitle (vcl::RenderContext &, const tools::Rectangle &rRect) const

SAL_DLLPRIVATE void	ImplSelect ()

SAL_DLLPRIVATE void	ImplCallHighlight (sal_uInt16 nHighlightItem)

SAL_DLLPRIVATE void	ImplCallEventListeners (VclEventId nEvent, sal_uInt16 nPos)

	DECL_DLLPRIVATE_LINK (ImplCallSelect, void *, void)

SAL_DLLPRIVATE void	ImplFillLayoutData () const

SAL_DLLPRIVATE SalMenu *	ImplGetSalMenu ()

SAL_DLLPRIVATE OUString	ImplGetHelpText (sal_uInt16 nItemId) const

SAL_DLLPRIVATE Size	ImplGetNativeCheckAndRadioSize (vcl::RenderContext const &rRenderContext, tools::Long &rCheckHeight, tools::Long &rRadioHeight) const

SAL_DLLPRIVATE void	ImplAddDel (ImplMenuDelData &rDel)

SAL_DLLPRIVATE void	ImplRemoveDel (ImplMenuDelData &rDel)

SAL_DLLPRIVATE MenuItemData *	NbcInsertItem (sal_uInt16 nId, MenuItemBits nBits, const OUString &rStr, Menu *pMenu, size_t nPos, const OUString &rIdent)

virtual void	ClosePopup (Menu *pMenu)=0
	Close the 'pStartedFrom' menu window. More...

virtual void	MenuBarKeyInput (const KeyEvent &rEvent)
	Forward the KeyInput call to the MenuBar. More...

	Menu ()
	The Menu constructor is protected. More...

Protected Member Functions inherited from VclReferenceBase
	VclReferenceBase ()

virtual	~VclReferenceBase ()

virtual void	dispose ()

Static Protected Member Functions
static SAL_DLLPRIVATE bool	ImplGetNativeSubmenuArrowSize (vcl::RenderContext const &rRenderContext, Size &rArrowSize, tools::Long &rArrowSpacing)

Private Attributes
ImplMenuDelData *	mpFirstDel

std::unique_ptr< MenuItemList >	pItemList

VclPtr< Menu >	pStartedFrom

VclPtr< vcl::Window >	pWindow

Link< Menu *, bool >	aActivateHdl

Link< Menu *, bool >	aDeactivateHdl

Link< Menu *, bool >	aSelectHdl

std::list< Link< VclMenuEvent &, void > >	maEventListeners

OUString	maID

OUString	aTitleText

sal_uInt16	nTitleHeight

ImplSVEvent *	nEventId

sal_uInt16	mnHighlightedItemPos

MenuFlags	nMenuFlags

sal_uInt16	nSelectedId

OUString	sSelectedIdent

sal_uInt16	nImgOrChkPos

sal_uInt16	nTextPos

bool	bCanceled: 1
	Terminated during a callback. More...

bool	bInCallback: 1
	In Activate/Deactivate. More...

bool	bKilled: 1
	Killed. More...

css::uno::Reference< css::accessibility::XAccessible >	mxAccessible

std::unique_ptr< vcl::MenuLayoutData >	mpLayoutData

std::unique_ptr< SalMenu >	mpSalMenu

OUString	m_sMenuHelpId

Friends
class	MenuBar

class	MenuBarWindow

class	MenuButton

class	MenuFloatingWindow

class	PopupMenu

class	SystemWindow

struct	ImplMenuDelData

Detailed Description

Definition at line 115 of file menu.hxx.

Constructor & Destructor Documentation

◆ Menu()

Menu::Menu ( )

protected

The Menu constructor is protected.

The callers are supposed to instantiate either PopupMenu or MenuBar, but not a Menu directly.

Definition at line 158 of file menu.cxx.

References NONE.

◆ ~Menu()

Menu::~Menu ( )

overridevirtual

Definition at line 176 of file menu.cxx.

References VclReferenceBase::disposeOnce().

Member Function Documentation

◆ Activate()

void Menu::Activate ( )

Definition at line 256 of file menu.cxx.

References aActivateHdl, bInCallback, Link< typename Arg, typename Ret >::Call(), CreateAutoMnemonics(), ImplCallEventListeners(), ImplGetStartMenu(), ImplMenuDelData::isDeleted(), ITEMPOS_INVALID, MenuActivate, nMenuFlags, and NoAutoMnemonics.

Referenced by MenuBarWindow::ChangeHighlightItem(), HandleMenuActivateEvent(), and PopupMenu::PrepareRun().

◆ AddEventListener()

void Menu::AddEventListener ( const Link< VclMenuEvent &, void > & rEventListener )

Definition at line 407 of file menu.cxx.

References maEventListeners.

Referenced by ToolBox::ExecuteCustomMenu().

◆ CheckItem() [1/2]

void Menu::CheckItem	(	sal_uInt16	nItemId,
		bool	bCheck = `true`
	)

Definition at line 838 of file menu.cxx.

References AUTOCHECK, CheckItem(), SalMenu::CheckItem(), GetItemCount(), ImplCallEventListeners(), ImplGetSalMenu(), IsItemChecked(), MenuItemChecked, MenuItemUnchecked, MenuItemData::nBits, MenuItemData::nId, nPos, pData, pItemList, and RADIOCHECK.

Referenced by CheckItem(), ImplCopyItem(), ImplSelect(), SalInstanceMenu::set_active(), SalInstanceMenuButton::set_item_active(), and ToolBox::UpdateCustomMenu().

◆ CheckItem() [2/2]

void Menu::CheckItem	(	std::u16string_view	rIdent,
		bool	bCheck = `true`
	)

Definition at line 903 of file menu.cxx.

References CheckItem(), and GetItemId().

◆ Clear()

void Menu::Clear ( )

Definition at line 571 of file menu.cxx.

References GetItemCount(), i, and RemoveItem().

Referenced by SalInstanceMenu::clear(), SalInstanceMenuButton::clear(), operator=(), and ToolBox::UpdateCustomMenu().

◆ ClosePopup()

virtual void Menu::ClosePopup ( Menu * pMenu )

protectedpure virtual

Close the 'pStartedFrom' menu window.

Implemented in MenuBar, and PopupMenu.

◆ CreateAutoMnemonics()

void Menu::CreateAutoMnemonics ( )

Definition at line 238 of file menu.cxx.

References MnemonicGenerator::CreateMnemonic(), n, NOSELECT, pData, pItemList, and MnemonicGenerator::RegisterMnemonic().

Referenced by Activate().

◆ Deactivate()

void Menu::Deactivate ( )

Definition at line 287 of file menu.cxx.

References aDeactivateHdl, bInCallback, Link< typename Arg, typename Ret >::Call(), ImplCallEventListeners(), ImplGetSalMenu(), ImplGetStartMenu(), ImplMenuDelData::isDeleted(), ITEMPOS_INVALID, MenuDeactivate, n, pData, pItemList, and SalMenu::RemoveItem().

Referenced by MenuBarWindow::ChangeHighlightItem(), HandleMenuDeActivateEvent(), MenuBarWindow::KillActivePopup(), and MenuFloatingWindow::KillActivePopup().

◆ DECL_DLLPRIVATE_LINK()

Menu::DECL_DLLPRIVATE_LINK	(	ImplCallSelect	,
		void *	,
		void
	)

protected

◆ DeHighlight()

void Menu::DeHighlight ( )

inline

Definition at line 389 of file menu.hxx.

◆ dispose()

void Menu::dispose ( void )

overridevirtual

Reimplemented from VclReferenceBase.

Reimplemented in MenuBar.

Definition at line 181 of file menu.cxx.

References bKilled, VclPtr< reference_type >::clear(), VclReferenceBase::dispose(), VclPtr< reference_type >::get(), ImplCallEventListeners(), ITEMPOS_INVALID, mpFirstDel, mpLayoutData, ImplMenuDelData::mpMenu, ImplMenuDelData::mpNext, mpSalMenu, mxAccessible, n, nEventId, ObjectDying, pItemList, MenuFloatingWindow::pMenu, pStartedFrom, pWindow, Application::RemoveUserEvent(), and vcl::Window::SetAccessible().

Referenced by MenuBar::dispose().

◆ EnableItem() [1/2]

void Menu::EnableItem	(	sal_uInt16	nItemId,
		bool	bEnable = `true`
	)

Definition at line 919 of file menu.cxx.

References MenuItemData::bEnabled, SalMenu::EnableItem(), ImplCallEventListeners(), ImplGetSalMenu(), ImplGetWindow(), vcl::Window::Invalidate(), IsMenuBar(), vcl::Window::IsVisible(), MenuDisable, MenuEnable, n, nCount, nPos, pData, pItemList, and SAL_WARN_IF.

Referenced by Edit::Command(), TextWindow::Command(), ImplCopyItem(), SalInstanceMenuButton::set_item_sensitive(), SalInstanceMenu::set_sensitive(), and ToolBox::UpdateCustomMenu().

◆ EnableItem() [2/2]

void Menu::EnableItem	(	std::u16string_view	rIdent,
		bool	bEnable = `true`
	)

inline

Definition at line 283 of file menu.hxx.

◆ get_id()

const OUString & Menu::get_id ( ) const

inline

Get the ID of the window.

Definition at line 403 of file menu.hxx.

Referenced by PopupMenu::PrepareRun().

◆ GetAccelKey()

KeyCode Menu::GetAccelKey ( sal_uInt16 nItemId ) const

Definition at line 803 of file menu.cxx.

References pData, and pItemList.

◆ GetAccessible()

css::uno::Reference< css::accessibility::XAccessible > Menu::GetAccessible ( )

Definition at line 1307 of file menu.cxx.

References UnoWrapperBase::CreateAccessible(), GetAccessible(), GetItemCount(), GetItemId(), GetPopupMenu(), UnoWrapperBase::GetUnoWrapper(), i, IsMenuBar(), mxAccessible, nCount, and pStartedFrom.

Referenced by MenuBarWindow::CreateAccessible(), MenuFloatingWindow::CreateAccessible(), and GetAccessible().

◆ GetAccessibleDescription()

OUString Menu::GetAccessibleDescription ( sal_uInt16 nItemId ) const

Definition at line 2326 of file menu.cxx.

References GetHelpText(), pData, and pItemList.

◆ GetAccessibleName()

OUString Menu::GetAccessibleName ( sal_uInt16 nItemId ) const

Definition at line 2308 of file menu.cxx.

References pData, and pItemList.

◆ GetActivationKey()

KeyEvent Menu::GetActivationKey ( sal_uInt16 nItemId ) const

Definition at line 813 of file menu.cxx.

References KEY_0, KEY_A, KEY_MOD2, nPos, pData, and pItemList.

◆ GetBoundingRectangle()

tools::Rectangle Menu::GetBoundingRectangle ( sal_uInt16 nItemPos ) const

Definition at line 2281 of file menu.cxx.

References ImplFillLayoutData(), mpLayoutData, and nPos.

◆ GetCharacterBounds()

tools::Rectangle Menu::GetCharacterBounds	(	sal_uInt16	nItemId,
		tools::Long	nIndex
	)		const

Definition at line 2238 of file menu.cxx.

References i, ImplFillLayoutData(), mpLayoutData, nIndex, and nItemID.

◆ GetCurItemId()

sal_uInt16 Menu::GetCurItemId ( ) const

inline

Definition at line 262 of file menu.hxx.

Referenced by MenuButton::ExecuteMenu(), ImplCallHighlight(), Select(), and MenuButton::SetCurItemId().

◆ GetCurItemIdent()

OUString const & Menu::GetCurItemIdent ( ) const

inline

Definition at line 263 of file menu.hxx.

Referenced by MenuButton::ExecuteMenu(), SalInstanceMenu::popup_at_rect(), and MenuButton::SetCurItemId().

◆ GetHelpCommand()

OUString Menu::GetHelpCommand ( sal_uInt16 nItemId ) const

Definition at line 1081 of file menu.cxx.

References pData, and pItemList.

◆ GetHelpId() [1/2]

OUString Menu::GetHelpId ( ) const

inline

Definition at line 322 of file menu.hxx.

◆ GetHelpId() [2/2]

OUString Menu::GetHelpId ( sal_uInt16 nItemId ) const

Definition at line 1156 of file menu.cxx.

References pData, and pItemList.

Referenced by MenuWindow::ImplHandleHelpEvent().

◆ GetHelpText()

OUString Menu::GetHelpText ( sal_uInt16 nItemId ) const

Definition at line 1125 of file menu.cxx.

References ImplGetHelpText().

Referenced by GetAccessibleDescription(), and MenuWindow::ImplHandleHelpEvent().

◆ GetIndexForPoint()

tools::Long Menu::GetIndexForPoint	(	const Point &	rPoint,
		sal_uInt16 &	rItemID
	)		const

Definition at line 2257 of file menu.cxx.

References i, ImplFillLayoutData(), mpLayoutData, and nIndex.

◆ GetItemBits()

MenuItemBits Menu::GetItemBits ( sal_uInt16 nItemId ) const

Definition at line 711 of file menu.cxx.

References NONE, pData, and pItemList.

◆ GetItemCommand()

OUString Menu::GetItemCommand ( sal_uInt16 nItemId ) const

Definition at line 1063 of file menu.cxx.

References pData, and pItemList.

Referenced by MenuWindow::ImplHandleHelpEvent().

◆ GetItemCount()

sal_uInt16 Menu::GetItemCount ( ) const

◆ GetItemId() [1/2]

sal_uInt16 Menu::GetItemId ( sal_uInt16 nPos ) const

Definition at line 641 of file menu.cxx.

References nPos, pData, and pItemList.

◆ GetItemId() [2/2]

sal_uInt16 Menu::GetItemId ( std::u16string_view rIdent ) const

Definition at line 651 of file menu.cxx.

References MENU_ITEM_NOTFOUND, n, pData, and pItemList.

◆ GetItemIdent()

OUString Menu::GetItemIdent ( sal_uInt16 nItemId ) const

Definition at line 683 of file menu.cxx.

References nId, pData, and pItemList.

Referenced by Edit::Command(), TextWindow::Command(), MenuButton::DumpAsPropertyTree(), SalInstanceMenu::get_id(), HandleMenuCommandEvent(), MenuBar::HandleMenuHighlightEvent(), and PopupMenu::SetSelectedEntry().

◆ GetItemImage()

Image Menu::GetItemImage ( sal_uInt16 nItemId ) const

Definition at line 1044 of file menu.cxx.

References pData, and pItemList.

◆ GetItemList()

MenuItemList * Menu::GetItemList ( ) const

inline

Definition at line 350 of file menu.hxx.

Referenced by MenuFloatingWindow::EndExecute(), MenuBarWindow::HandleKeyEvent(), ImplCopyItem(), MenuBarWindow::ImplCreatePopup(), MenuFloatingWindow::ImplCursorUpDown(), ImplFindMenu(), ImplFindSelectMenu(), MenuFloatingWindow::ImplGetStartY(), MenuWindow::ImplHandleHelpEvent(), MenuFloatingWindow::ImplScroll(), ImplSelect(), MenuFloatingWindow::KeyInput(), MenuBarWindow::KillActivePopup(), MenuFloatingWindow::MouseButtonUp(), MenuBarWindow::Paint(), and PopupMenu::SelectItem().

◆ GetItemPos()

sal_uInt16 Menu::GetItemPos ( sal_uInt16 nItemId ) const

Definition at line 662 of file menu.cxx.

References MENU_ITEM_NOTFOUND, nPos, pData, and pItemList.

Referenced by MenuBar::HandleMenuHighlightEvent(), ImplCallHighlight(), ImplCopyItem(), InsertItem(), SalInstanceMenu::remove(), SalInstanceMenuButton::remove_item(), Select(), and MenuBar::SelectItem().

◆ GetItemText()

OUString Menu::GetItemText ( sal_uInt16 nItemId ) const

Definition at line 1017 of file menu.cxx.

References nPos, pData, and pItemList.

Referenced by MenuButton::DumpAsPropertyTree(), SalInstanceMenuButton::get_item_label(), SalInstanceMenu::get_label(), and DebugEventInjector::InjectMenuEvent().

◆ GetItemType()

MenuItemType Menu::GetItemType ( sal_uInt16 nPos ) const

Definition at line 673 of file menu.cxx.

References DONTKNOW, nPos, pData, and pItemList.

Referenced by CollectMenuItemIds(), ImplCopyItem(), and RemoveDisabledEntries().

◆ GetMenuFlags()

MenuFlags Menu::GetMenuFlags ( ) const

inline

Definition at line 253 of file menu.hxx.

◆ GetPopupMenu()

PopupMenu * Menu::GetPopupMenu ( sal_uInt16 nItemId ) const

Definition at line 775 of file menu.cxx.

References pData, and pItemList.

Referenced by CollectMenuItemIds(), GetAccessible(), ImplCopyItem(), and MenuBarWindow::ImplCreatePopup().

◆ GetSystemMenuData()

void Menu::GetSystemMenuData ( SystemMenuData * pData ) const

Definition at line 2336 of file menu.cxx.

References SalMenu::GetSystemMenuData(), ImplGetSalMenu(), and pData.

◆ GetTipHelpText()

OUString Menu::GetTipHelpText ( sal_uInt16 nItemId ) const

Definition at line 1138 of file menu.cxx.

References pData, and pItemList.

Referenced by MenuWindow::ImplHandleHelpEvent().

◆ GetTitleHeight()

sal_uInt16 Menu::GetTitleHeight ( ) const

inline

Definition at line 339 of file menu.hxx.

Referenced by MenuFloatingWindow::ImplGetStartY().

◆ GetUserValue()

void * Menu::GetUserValue ( sal_uInt16 nItemId ) const

Definition at line 732 of file menu.cxx.

References pData, and pItemList.

◆ GetWindow()

vcl::Window * Menu::GetWindow ( ) const

inline

Definition at line 377 of file menu.hxx.

Referenced by vcl::Window::GetAccessibleChildWindow(), vcl::Window::GetAccessibleChildWindowCount(), MenuBar::GetMenuBarHeight(), and ImplInvalidateMenubar().

◆ HandleMenuActivateEvent()

bool Menu::HandleMenuActivateEvent ( Menu * pMenu ) const

Definition at line 2563 of file menu.cxx.

References Activate(), bInCallback, ImplMenuDelData::isDeleted(), and pStartedFrom.

Referenced by ImplHandleMenuEvent().

◆ HandleMenuCommandEvent()

bool Menu::HandleMenuCommandEvent	(	Menu *	pMenu,
		sal_uInt16	nEventId
	)		const

Definition at line 2619 of file menu.cxx.

References GetItemIdent(), ImplFindMenu(), ImplSelect(), nSelectedId, pStartedFrom, and sSelectedIdent.

Referenced by ImplHandleMenuEvent().

◆ HandleMenuDeActivateEvent()

bool Menu::HandleMenuDeActivateEvent ( Menu * pMenu ) const

Definition at line 2579 of file menu.cxx.

References bInCallback, Deactivate(), ImplMenuDelData::isDeleted(), and pStartedFrom.

Referenced by ImplHandleMenuEvent().

◆ HasValidEntries()

bool Menu::HasValidEntries ( bool bCheckPopups ) const

Definition at line 582 of file menu.cxx.

References MenuItemData::bEnabled, MenuItemData::eType, GetItemCount(), HasValidEntries(), n, nCount, pItemList, MenuItemData::pSubMenu, and SEPARATOR.

Referenced by HasValidEntries().

◆ HideItem()

void Menu::HideItem ( sal_uInt16 nItemId )

inline

Definition at line 290 of file menu.hxx.

Referenced by VclBuilder::insertMenuObject().

◆ HighlightItem()

void Menu::HighlightItem ( sal_uInt16 nItemPos )

Definition at line 2360 of file menu.cxx.

References MenuBarWindow::ChangeHighlightItem(), VclPtr< reference_type >::get(), IsMenuBar(), pWindow, and MenuBarWindow::SetAutoPopup().

◆ ImplAddDel()

void Menu::ImplAddDel ( ImplMenuDelData & rDel )

protected

Definition at line 1401 of file menu.cxx.

References mpFirstDel, ImplMenuDelData::mpMenu, ImplMenuDelData::mpNext, and SAL_WARN_IF.

◆ ImplCalcSize()

Size Menu::ImplCalcSize ( vcl::Window * pWin )

protected

Definition at line 1431 of file menu.cxx.

References Size::AdjustHeight(), Size::AdjustWidth(), aName, aTitleText, ENABLED, Entire, EXTRAITEMHEIGHT, VclPtr< reference_type >::get(), OutputDevice::GetCtrlTextWidth(), vcl::Window::GetFont(), tools::Rectangle::GetHeight(), vcl::Window::GetNativeControlRegion(), vcl::Window::GetOutDev(), Application::GetScreenPosSizePixel(), vcl::Window::GetSettings(), tools::Rectangle::GetSize(), AllSettings::GetStyleSettings(), OutputDevice::GetTextBoundRect(), vcl::Window::GetTextHeight(), vcl::Window::GetTextWidth(), StyleSettings::GetUseImagesInMenus(), tools::Rectangle::GetWidth(), Size::Height(), i, IMAGE, ImplAccelDisabled(), ImplGetNativeCheckAndRadioSize(), ImplGetSVData(), vcl::Window::ImplGetWindowImpl(), ImplIsVisible(), IsMenuBar(), vcl::Window::IsNativeControlSupported(), SalFrame::maGeometry, ImplSVData::maNWFData, Menubar, ImplSVNWFData::mnMenuFormatBorderX, ImplSVNWFData::mnMenuFormatBorderY, WindowImpl::mpFrame, n, nImgOrChkPos, nTextPos, nTitleHeight, pData, pItemList, OutputDevice::Pop(), OutputDevice::Push(), pWindow, SalFrameGeometry::screen(), SEPARATOR, vcl::Window::SetFont(), Size::setHeight(), vcl::Font::SetWeight(), Size::setWidth(), SPACE_AROUND_TITLE, STRING, STRINGIMAGE, WEIGHT_BOLD, and Size::Width().

Referenced by MenuBar::ImplCreate(), InsertItem(), MenuBarWindow::LayoutChanged(), PopupMenu::PrepareRun(), RemoveItem(), and SetItemText().

◆ ImplCallEventListeners()

void Menu::ImplCallEventListeners	(	VclEventId	nEvent,
		sal_uInt16	nPos
	)

protected

◆ ImplCallHighlight()

void Menu::ImplCallHighlight ( sal_uInt16 nHighlightItem )

protected

Definition at line 2111 of file menu.cxx.

References GetCurItemId(), GetItemPos(), ImplCallEventListeners(), ImplMenuDelData::isDeleted(), MenuHighlight, nSelectedId, pData, pItemList, and sSelectedIdent.

Referenced by MenuBarWindow::ChangeHighlightItem(), MenuFloatingWindow::ChangeHighlightItem(), MenuBar::HandleMenuHighlightEvent(), and MenuFloatingWindow::KeyInput().

◆ ImplCurrentlyHiddenOnGUI()

bool Menu::ImplCurrentlyHiddenOnGUI ( sal_uInt16 nPos ) const

protected

Definition at line 1197 of file menu.cxx.

References MenuItemData::bHiddenOnGUI, nPos, pData, and pItemList.

Referenced by MenuBarWindow::HandleKeyEvent().

◆ ImplFillLayoutData()

void Menu::ImplFillLayoutData ( ) const

protected

Definition at line 2220 of file menu.cxx.

References VclPtr< reference_type >::get(), vcl::Window::GetOutDev(), vcl::Window::GetOutputSizePixel(), MenuFloatingWindow::ImplGetStartY(), ImplPaint(), IsMenuBar(), vcl::Window::IsReallyVisible(), mpLayoutData, MenuFloatingWindow::nScrollerHeight, and pWindow.

Referenced by GetBoundingRectangle(), GetCharacterBounds(), and GetIndexForPoint().

◆ ImplFindMenu()

Menu * Menu::ImplFindMenu ( sal_uInt16 nId )

protected

Definition at line 2153 of file menu.cxx.

References MenuItemList::GetDataFromPos(), GetItemList(), n, pData, and size.

Referenced by HandleMenuCommandEvent(), and MenuBar::HandleMenuHighlightEvent().

◆ ImplFindSelectMenu()

Menu * Menu::ImplFindSelectMenu ( )

protected

Definition at line 2138 of file menu.cxx.

References MenuItemList::GetDataFromPos(), GetItemList(), n, nEventId, pData, and size.

Referenced by PopupMenu::ImplFlushPendingSelect().

◆ ImplGetFirstVisible()

sal_uInt16 Menu::ImplGetFirstVisible ( ) const

protected

Definition at line 611 of file menu.cxx.

References ImplIsVisible(), ITEMPOS_INVALID, n, and pItemList.

Referenced by PopupMenu::PrepareRun().

◆ ImplGetHelpText()

OUString Menu::ImplGetHelpText ( sal_uInt16 nItemId ) const

protected

Definition at line 1099 of file menu.cxx.

References Application::GetHelp(), Help::GetHelpText(), pData, and pItemList.

Referenced by GetHelpText().

◆ ImplGetNativeCheckAndRadioSize()

Size Menu::ImplGetNativeCheckAndRadioSize	(	vcl::RenderContext const &	rRenderContext,
		tools::Long &	rCheckHeight,
		tools::Long &	rRadioHeight
	)		const

protected

Definition at line 1344 of file menu.cxx.

References ENABLED, tools::Rectangle::GetHeight(), OutputDevice::GetNativeControlRegion(), tools::Rectangle::GetWidth(), IsMenuBar(), OutputDevice::IsNativeControlSupported(), MenuItemCheckMark, MenuItemRadioMark, and MenuPopup.

Referenced by ImplCalcSize(), and ImplPaint().

◆ ImplGetNativeSubmenuArrowSize()

bool Menu::ImplGetNativeSubmenuArrowSize	(	vcl::RenderContext const &	rRenderContext,
		Size &	rArrowSize,
		tools::Long &	rArrowSpacing
	)

staticprotected

Definition at line 1380 of file menu.cxx.

References ENABLED, tools::Rectangle::GetHeight(), OutputDevice::GetNativeControlRegion(), tools::Rectangle::GetWidth(), OutputDevice::IsNativeControlSupported(), MenuPopup, and SubmenuArrow.

Referenced by ImplPaint().

◆ ImplGetNextVisible()

sal_uInt16 Menu::ImplGetNextVisible ( sal_uInt16 nPos ) const

protected

Definition at line 631 of file menu.cxx.

References ImplIsVisible(), ITEMPOS_INVALID, n, nPos, and pItemList.

Referenced by MenuFloatingWindow::ImplScroll().

◆ ImplGetPrevVisible()

sal_uInt16 Menu::ImplGetPrevVisible ( sal_uInt16 nPos ) const

protected

Definition at line 621 of file menu.cxx.

References ImplIsVisible(), ITEMPOS_INVALID, n, and nPos.

Referenced by MenuFloatingWindow::ImplScroll().

◆ ImplGetSalMenu()

SAL_DLLPRIVATE SalMenu * Menu::ImplGetSalMenu ( )

inlineprotected

◆ ImplGetStartMenu()

Menu * Menu::ImplGetStartMenu ( )

protected

Definition at line 2103 of file menu.cxx.

References pStartedFrom.

Referenced by Activate(), Deactivate(), MenuFloatingWindow::EndExecute(), MenuFloatingWindow::KeyInput(), and Select().

◆ ImplGetVisibleItemCount()

sal_uInt16 Menu::ImplGetVisibleItemCount ( ) const

protected

Definition at line 600 of file menu.cxx.

References ImplIsVisible(), n, and pItemList.

Referenced by PopupMenu::PrepareRun().

◆ ImplGetWindow()

SAL_DLLPRIVATE vcl::Window * Menu::ImplGetWindow ( ) const

inline

◆ ImplIsSelectable()

bool Menu::ImplIsSelectable ( sal_uInt16 nPos ) const

protected

Definition at line 1295 of file menu.cxx.

References NOSELECT, nPos, pData, and pItemList.

Referenced by MenuFloatingWindow::ImplCursorUpDown(), MenuFloatingWindow::ImplHighlightItem(), and PopupMenu::Run().

◆ ImplIsVisible()

bool Menu::ImplIsVisible ( sal_uInt16 nPos ) const

protected

◆ ImplKillLayoutData()

void Menu::ImplKillLayoutData ( ) const

Definition at line 2215 of file menu.cxx.

References mpLayoutData.

Referenced by MenuFloatingWindow::ImplScroll(), MenuBarWindow::LayoutChanged(), and MenuBarWindow::StateChanged().

◆ ImplPaint()

void Menu::ImplPaint	(	vcl::RenderContext &	rRenderContext,
		Size const &	rSize,
		sal_uInt16	nBorder,
		tools::Long	nOffY = `0`,
		MenuItemData const *	pThisDataOnly = `nullptr`,
		bool	bHighlighted = `false`,
		bool	bLayout = `false`,
		bool	bRollover = `false`
	)		const

protected

Definition at line 1728 of file menu.cxx.

References Point::AdjustX(), Point::AdjustY(), CHECKMARK, Disable, OutputDevice::DrawCtrlText(), DecorationView::DrawFrame(), OutputDevice::DrawImage(), OutputDevice::DrawLine(), OutputDevice::DrawNativeControl(), DecorationView::DrawSymbol(), ENABLED, Entire, psp::eSymbol, tools::Rectangle::GetHeight(), StyleSettings::GetLightColor(), StyleSettings::GetMenuBarColor(), StyleSettings::GetMenuBarHighlightTextColor(), StyleSettings::GetMenuBarRolloverTextColor(), StyleSettings::GetMenuBarTextColor(), StyleSettings::GetMenuColor(), StyleSettings::GetMenuHighlightTextColor(), StyleSettings::GetMenuTextColor(), OutputDevice::GetSettings(), StyleSettings::GetShadowColor(), getShortenedString(), Image::GetSizePixel(), AllSettings::GetStyleSettings(), OutputDevice::GetTextColor(), OutputDevice::GetTextHeight(), OutputDevice::GetTextWidth(), tools::Rectangle::GetWidth(), Group, GUTTERBORDER, Size::Height(), IMAGE, ImplAccelDisabled(), ImplGetNativeCheckAndRadioSize(), ImplGetNativeSubmenuArrowSize(), ImplGetSVData(), ImplIsVisible(), ImplPaintCheckBackground(), ImplPaintMenuTitle(), OutputDevice::IsBackground(), vcl::Window::IsEnabled(), IsMenuBar(), OutputDevice::IsNativeControlSupported(), tools::Rectangle::Left(), ImplSVData::maNWFData, MenuItemCheckMark, MenuItemRadioMark, MenuPopup, Mnemonic, ImplSVNWFData::mnMenuFormatBorderX, mpLayoutData, n, nBorder, nCount, nImgOrChkPos, NONE, nState, nTextPos, nTitleHeight, pData, pItemList, POPUPSELECT, PRESSED, pWindow, RADIOCHECK, RADIOCHECKMARK, SELECTED, SEPARATOR, Separator, OutputDevice::SetBackground(), OutputDevice::SetLineColor(), OutputDevice::SetTextColor(), Size::setWidth(), Point::setX(), Point::setY(), SPIN_RIGHT, STRING, STRINGIMAGE, SubmenuArrow, tools::Rectangle::Top(), tools::Rectangle::TopLeft(), Size::Width(), Point::X(), and Point::Y().

Referenced by MenuBarWindow::HighlightItem(), ImplFillLayoutData(), MenuBarWindow::Paint(), MenuFloatingWindow::Paint(), and MenuFloatingWindow::RenderHighlightItem().

◆ ImplPaintMenuTitle()

void Menu::ImplPaintMenuTitle	(	vcl::RenderContext &	rRenderContext,
		const tools::Rectangle &	rRect
	)		const

protected

Definition at line 1693 of file menu.cxx.

Referenced by ImplPaint().

◆ ImplRemoveDel()

void Menu::ImplRemoveDel ( ImplMenuDelData & rDel )

protected

Definition at line 1412 of file menu.cxx.

References mpFirstDel, ImplMenuDelData::mpMenu, ImplMenuDelData::mpNext, pData, and SAL_WARN_IF.

◆ ImplSelect()

void Menu::ImplSelect ( )

protected

Definition at line 330 of file menu.cxx.

References AUTOCHECK, CheckItem(), MenuItemList::GetData(), GetItemList(), ImplGetSVData(), IsItemChecked(), LINK, ImplSVData::maAppData, ImplSVAppData::mpActivePopupMenu, nEventId, nSelectedId, pData, Application::PostUserEvent(), and RADIOCHECK.

Referenced by MenuFloatingWindow::EndExecute(), and HandleMenuCommandEvent().

◆ InsertItem() [1/3]

void Menu::InsertItem	(	sal_uInt16	nItemId,
		const Image &	rImage,
		MenuItemBits	nItemBits = `MenuItemBits::NONE`,
		const OUString &	rIdent = `{}`,
		sal_uInt16	nPos = `MENU_APPEND`
	)

Definition at line 457 of file menu.cxx.

References InsertItem(), nPos, and SetItemImage().

◆ InsertItem() [2/3]

void Menu::InsertItem	(	sal_uInt16	nItemId,
		const OUString &	rStr,
		MenuItemBits	nItemBits = `MenuItemBits::NONE`,
		const OUString &	rIdent = `{}`,
		sal_uInt16	nPos = `MENU_APPEND`
	)

Definition at line 432 of file menu.cxx.

References GetItemPos(), ImplCalcSize(), ImplCallEventListeners(), ImplGetWindow(), vcl::Window::Invalidate(), vcl::Window::IsVisible(), MENU_APPEND, MENU_ITEM_NOTFOUND, MenuInsertItem, mpLayoutData, NbcInsertItem(), nPos, pItemList, and SAL_WARN_IF.

Referenced by ImplCopyItem(), MenuBarWindow::ImplCreatePopup(), InsertItem(), VclBuilder::insertMenuObject(), NotebookBarAddonsMerger::MergeNotebookBarMenuAddons(), and ToolBox::UpdateCustomMenu().

◆ InsertItem() [3/3]

void Menu::InsertItem	(	sal_uInt16	nItemId,
		const OUString &	rString,
		const Image &	rImage,
		MenuItemBits	nItemBits = `MenuItemBits::NONE`,
		const OUString &	rIdent = `{}`,
		sal_uInt16	nPos = `MENU_APPEND`
	)