LibreOffice Module toolkit (master) 1
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
VCLXMenu Class Reference

#include <vclxmenu.hxx>

Inheritance diagram for VCLXMenu:
[legend]
Collaboration diagram for VCLXMenu:
[legend]

Public Member Functions

 VCLXMenu ()
 
 VCLXMenu (Menu *pMenu)
 
virtual ~VCLXMenu () override
 
Menu * GetMenu () const
 
bool IsPopupMenu () const
 
void setUserValue (sal_uInt16 nItemId, void *nUserValue, MenuUserDataReleaseFunction aFunc)
 
void * getUserValue (sal_uInt16 nItemId)
 
css::uno::Any SAL_CALL queryInterface (const css::uno::Type &rType) override
 
void SAL_CALL acquire () noexcept override
 
void SAL_CALL release () noexcept override
 
css::uno::Sequence< css::uno::Type > SAL_CALL getTypes () override
 
css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId () override
 
virtual void SAL_CALL addMenuListener (const css::uno::Reference< css::awt::XMenuListener > &xListener) override
 
virtual void SAL_CALL removeMenuListener (const css::uno::Reference< css::awt::XMenuListener > &xListener) override
 
virtual void SAL_CALL insertItem (sal_Int16 nItemId, const OUString &aText, sal_Int16 nItemStyle, sal_Int16 nPos) override
 
virtual void SAL_CALL removeItem (sal_Int16 nPos, sal_Int16 nCount) override
 
virtual void SAL_CALL clear () override
 
virtual sal_Int16 SAL_CALL getItemCount () override
 
virtual sal_Int16 SAL_CALL getItemId (sal_Int16 nPos) override
 
virtual sal_Int16 SAL_CALL getItemPos (sal_Int16 nId) override
 
virtual css::awt::MenuItemType SAL_CALL getItemType (::sal_Int16 nItemPos) override
 
virtual void SAL_CALL enableItem (sal_Int16 nItemId, sal_Bool bEnable) override
 
virtual sal_Bool SAL_CALL isItemEnabled (sal_Int16 nItemId) override
 
virtual void SAL_CALL hideDisabledEntries (sal_Bool bHide) override
 
virtual void SAL_CALL enableAutoMnemonics (sal_Bool bEnable) override
 
virtual void SAL_CALL setItemText (sal_Int16 nItemId, const OUString &aText) override
 
virtual OUString SAL_CALL getItemText (sal_Int16 nItemId) override
 
virtual void SAL_CALL setCommand (sal_Int16 nItemId, const OUString &aCommand) override
 
virtual OUString SAL_CALL getCommand (sal_Int16 nItemId) override
 
virtual void SAL_CALL setHelpCommand (sal_Int16 nItemId, const OUString &aHelp) override
 
virtual OUString SAL_CALL getHelpCommand (sal_Int16 nItemId) override
 
virtual void SAL_CALL setHelpText (::sal_Int16 nItemId, const OUString &sHelpText) override
 
virtual OUString SAL_CALL getHelpText (::sal_Int16 nItemId) override
 
virtual void SAL_CALL setTipHelpText (::sal_Int16 nItemId, const OUString &sTipHelpText) override
 
virtual OUString SAL_CALL getTipHelpText (::sal_Int16 nItemId) override
 
virtual sal_Bool SAL_CALL isPopupMenu () override
 
virtual void SAL_CALL setPopupMenu (sal_Int16 nItemId, const css::uno::Reference< css::awt::XPopupMenu > &aPopupMenu) override
 
virtual css::uno::Reference< css::awt::XPopupMenu > SAL_CALL getPopupMenu (sal_Int16 nItemId) override
 
virtual void SAL_CALL insertSeparator (sal_Int16 nPos) override
 
virtual void SAL_CALL setDefaultItem (sal_Int16 nItemId) override
 
virtual sal_Int16 SAL_CALL getDefaultItem () override
 
virtual void SAL_CALL checkItem (sal_Int16 nItemId, sal_Bool bCheck) override
 
virtual sal_Bool SAL_CALL isItemChecked (sal_Int16 nItemId) override
 
virtual ::sal_Int16 SAL_CALL execute (const css::uno::Reference< css::awt::XWindowPeer > &Parent, const css::awt::Rectangle &Position, ::sal_Int16 Direction) override
 
virtual sal_Bool SAL_CALL isInExecute () override
 
virtual void SAL_CALL endExecute () override
 
virtual void SAL_CALL setAcceleratorKeyEvent (::sal_Int16 nItemId, const css::awt::KeyEvent &aKeyEvent) override
 
virtual css::awt::KeyEvent SAL_CALL getAcceleratorKeyEvent (::sal_Int16 nItemId) override
 
virtual void SAL_CALL setItemImage (::sal_Int16 nItemId, const css::uno::Reference< css::graphic::XGraphic > &xGraphic, sal_Bool bScale) override
 
virtual css::uno::Reference< css::graphic::XGraphic > SAL_CALL getItemImage (::sal_Int16 nItemId) override
 
virtual OUString SAL_CALL getImplementationName () override
 
virtual sal_Bool SAL_CALL supportsService (const OUString &ServiceName) override
 
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames () override
 
- Public Member Functions inherited from cppu::OWeakObject
 OWeakObject ()
 
 OWeakObject (const OWeakObject &)
 
OWeakObject &SAL_CALL operator= (const OWeakObject &)
 
virtual css::uno::Any SAL_CALL queryInterface (const css::uno::Type &rType) SAL_OVERRIDE
 
virtual void SAL_CALL acquire () SAL_NOEXCEPT SAL_OVERRIDE
 
virtual void SAL_CALL release () SAL_NOEXCEPT SAL_OVERRIDE
 
virtual css::uno::Reference< css::uno::XAdapter > SAL_CALL queryAdapter () SAL_OVERRIDE
 
SAL_CALL operator css::uno::Reference< css::uno::XInterface > ()
 

Protected Member Functions

 DECL_DLLPRIVATE_LINK (MenuEventListener, VclMenuEvent &, void)
 
void ImplCreateMenu (bool bPopup)
 
void ImplAddListener ()
 
- Protected Member Functions inherited from cppu::OWeakObject
virtual ~OWeakObject () COVERITY_NOEXCEPT_FALSE
 
void disposeWeakConnectionPoint ()
 

Private Attributes

std::mutex maMutex
 
VclPtr< Menu > mpMenu
 
MenuListenerMultiplexer maMenuListeners
 
PopupMenuRefList maPopupMenuRefs
 
sal_Int16 mnDefaultItem
 

Additional Inherited Members

- Protected Attributes inherited from cppu::OWeakObject
oslInterlockedCount m_refCount
 

Detailed Description

Definition at line 52 of file vclxmenu.hxx.

Constructor & Destructor Documentation

◆ VCLXMenu() [1/2]

VCLXMenu::VCLXMenu ( )

Definition at line 39 of file vclxmenu.cxx.

References mpMenu.

◆ VCLXMenu() [2/2]

VCLXMenu::VCLXMenu ( Menu *  pMenu)

Definition at line 46 of file vclxmenu.cxx.

References mpMenu.

◆ ~VCLXMenu()

VCLXMenu::~VCLXMenu ( )
overridevirtual

Definition at line 53 of file vclxmenu.cxx.

References VclPtr< class reference_type >::disposeAndClear(), LINK, maPopupMenuRefs, and mpMenu.

Member Function Documentation

◆ acquire()

void SAL_CALL VCLXMenu::acquire ( )
inlineoverridevirtualnoexcept

Reimplemented from cppu::OWeakObject.

Definition at line 85 of file vclxmenu.hxx.

References cppu::OWeakObject::acquire().

◆ addMenuListener()

void VCLXMenu::addMenuListener ( const css::uno::Reference< css::awt::XMenuListener > &  xListener)
overridevirtual

Definition at line 260 of file vclxmenu.cxx.

References maMenuListeners, and maMutex.

◆ checkItem()

void VCLXMenu::checkItem ( sal_Int16  nItemId,
sal_Bool  bCheck 
)
overridevirtual

Definition at line 452 of file vclxmenu.cxx.

References maMutex, and mpMenu.

◆ clear()

void SAL_CALL VCLXMenu::clear ( )
overridevirtual

Definition at line 616 of file vclxmenu.cxx.

References maMutex, and mpMenu.

◆ DECL_DLLPRIVATE_LINK()

VCLXMenu::DECL_DLLPRIVATE_LINK ( MenuEventListener  ,
VclMenuEvent &  ,
void   
)
protected

◆ enableAutoMnemonics()

void SAL_CALL VCLXMenu::enableAutoMnemonics ( sal_Bool  bEnable)
overridevirtual

Definition at line 678 of file vclxmenu.cxx.

References maMutex, and mpMenu.

◆ enableItem()

void VCLXMenu::enableItem ( sal_Int16  nItemId,
sal_Bool  bEnable 
)
overridevirtual

Definition at line 335 of file vclxmenu.cxx.

References maMutex, and mpMenu.

◆ endExecute()

void SAL_CALL VCLXMenu::endExecute ( )
overridevirtual

Definition at line 668 of file vclxmenu.cxx.

References VclPtr< class reference_type >::get(), IsPopupMenu(), maMutex, and mpMenu.

◆ execute()

sal_Int16 VCLXMenu::execute ( const css::uno::Reference< css::awt::XWindowPeer > &  Parent,
const css::awt::Rectangle &  Position,
::sal_Int16  Direction 
)
override

Definition at line 472 of file vclxmenu.cxx.

References Execute(), VCLUnoHelper::GetWindow(), IsPopupMenu(), maMutex, mpMenu, and VCLRectangle().

◆ getAcceleratorKeyEvent()

css::awt::KeyEvent SAL_CALL VCLXMenu::getAcceleratorKeyEvent ( ::sal_Int16  nItemId)
overridevirtual

Definition at line 708 of file vclxmenu.cxx.

References IsPopupMenu(), maMutex, MENU_ITEM_NOTFOUND, and mpMenu.

◆ getCommand()

OUString SAL_CALL VCLXMenu::getCommand ( sal_Int16  nItemId)
overridevirtual

Definition at line 503 of file vclxmenu.cxx.

References maMutex, and mpMenu.

◆ getDefaultItem()

sal_Int16 VCLXMenu::getDefaultItem ( )
overridevirtual

Definition at line 445 of file vclxmenu.cxx.

References maMutex, and mnDefaultItem.

◆ getHelpCommand()

OUString SAL_CALL VCLXMenu::getHelpCommand ( sal_Int16  nItemId)
overridevirtual

Definition at line 526 of file vclxmenu.cxx.

References maMutex, and mpMenu.

◆ getHelpText()

OUString SAL_CALL VCLXMenu::getHelpText ( ::sal_Int16  nItemId)
overridevirtual

Definition at line 739 of file vclxmenu.cxx.

References maMutex, MENU_ITEM_NOTFOUND, and mpMenu.

◆ getImplementationId()

css::uno::Sequence< sal_Int8 > VCLXMenu::getImplementationId ( )
override

Definition at line 255 of file vclxmenu.cxx.

◆ getImplementationName()

OUString SAL_CALL VCLXMenu::getImplementationName ( )
overridevirtual

Definition at line 168 of file vclxmenu.cxx.

References implName, IsPopupMenu(), and maMutex.

◆ getItemCount()

sal_Int16 VCLXMenu::getItemCount ( )
overridevirtual

Definition at line 309 of file vclxmenu.cxx.

References maMutex, and mpMenu.

◆ getItemId()

sal_Int16 VCLXMenu::getItemId ( sal_Int16  nPos)
overridevirtual

Definition at line 317 of file vclxmenu.cxx.

References maMutex, mpMenu, and nPos.

◆ getItemImage()

css::uno::Reference< css::graphic::XGraphic > SAL_CALL VCLXMenu::getItemImage ( ::sal_Int16  nItemId)
overridevirtual

Definition at line 801 of file vclxmenu.cxx.

References Image::GetBitmapEx(), Graphic::GetXGraphic(), IsPopupMenu(), maMutex, MENU_ITEM_NOTFOUND, and mpMenu.

◆ getItemPos()

sal_Int16 VCLXMenu::getItemPos ( sal_Int16  nId)
overridevirtual

Definition at line 326 of file vclxmenu.cxx.

References maMutex, mpMenu, and nId.

◆ getItemText()

OUString VCLXMenu::getItemText ( sal_Int16  nItemId)
overridevirtual

Definition at line 366 of file vclxmenu.cxx.

References maMutex, and mpMenu.

◆ getItemType()

css::awt::MenuItemType SAL_CALL VCLXMenu::getItemType ( ::sal_Int16  nItemPos)
overridevirtual

Definition at line 625 of file vclxmenu.cxx.

References maMutex, and mpMenu.

◆ GetMenu()

Menu * VCLXMenu::GetMenu ( ) const
inline

Definition at line 78 of file vclxmenu.hxx.

Referenced by getPopupMenu(), VCLXTopWindow::setMenuBar(), and setPopupMenu().

◆ getPopupMenu()

css::uno::Reference< css::awt::XPopupMenu > VCLXMenu::getPopupMenu ( sal_Int16  nItemId)
overridevirtual

Definition at line 396 of file vclxmenu.cxx.

References GetMenu(), maMutex, maPopupMenuRefs, mpMenu, and n.

◆ getSupportedServiceNames()

css::uno::Sequence< OUString > SAL_CALL VCLXMenu::getSupportedServiceNames ( )
overridevirtual

Definition at line 183 of file vclxmenu.cxx.

References IsPopupMenu(), and maMutex.

◆ getTipHelpText()

OUString SAL_CALL VCLXMenu::getTipHelpText ( ::sal_Int16  nItemId)
overridevirtual

Definition at line 769 of file vclxmenu.cxx.

References maMutex, MENU_ITEM_NOTFOUND, and mpMenu.

◆ getTypes()

css::uno::Sequence< css::uno::Type > VCLXMenu::getTypes ( )
override

Definition at line 230 of file vclxmenu.cxx.

References cppu::OTypeCollection::getTypes(), IsPopupMenu(), and maMutex.

◆ getUserValue()

void * VCLXMenu::getUserValue ( sal_uInt16  nItemId)

Definition at line 826 of file vclxmenu.cxx.

References maMutex, and mpMenu.

◆ hideDisabledEntries()

void SAL_CALL VCLXMenu::hideDisabledEntries ( sal_Bool  bHide)
overridevirtual

Definition at line 641 of file vclxmenu.cxx.

References maMutex, and mpMenu.

◆ ImplAddListener()

void VCLXMenu::ImplAddListener ( )
protected

Definition at line 81 of file vclxmenu.cxx.

References LINK, and mpMenu.

Referenced by VCLXPopupMenu::VCLXPopupMenu().

◆ ImplCreateMenu()

void VCLXMenu::ImplCreateMenu ( bool  bPopup)
protected

Definition at line 69 of file vclxmenu.cxx.

References bPopup, VclPtr< class reference_type >::Create(), DBG_ASSERT, LINK, and mpMenu.

Referenced by VCLXPopupMenu::VCLXPopupMenu().

◆ insertItem()

void VCLXMenu::insertItem ( sal_Int16  nItemId,
const OUString &  aText,
sal_Int16  nItemStyle,
sal_Int16  nPos 
)
overridevirtual

Definition at line 276 of file vclxmenu.cxx.

References maMutex, mpMenu, and nPos.

◆ insertSeparator()

void VCLXMenu::insertSeparator ( sal_Int16  nPos)
overridevirtual

Definition at line 427 of file vclxmenu.cxx.

References maMutex, mpMenu, and nPos.

◆ isInExecute()

sal_Bool SAL_CALL VCLXMenu::isInExecute ( )
overridevirtual

Definition at line 656 of file vclxmenu.cxx.

References vcl::IsInPopupMenuExecute(), IsPopupMenu(), maMutex, and mpMenu.

◆ isItemChecked()

sal_Bool VCLXMenu::isItemChecked ( sal_Int16  nItemId)
overridevirtual

Definition at line 463 of file vclxmenu.cxx.

References maMutex, and mpMenu.

◆ isItemEnabled()

sal_Bool VCLXMenu::isItemEnabled ( sal_Int16  nItemId)
overridevirtual

Definition at line 346 of file vclxmenu.cxx.

References maMutex, and mpMenu.

◆ IsPopupMenu()

bool VCLXMenu::IsPopupMenu ( ) const

Definition at line 64 of file vclxmenu.cxx.

References mpMenu.

Referenced by endExecute(), execute(), getAcceleratorKeyEvent(), getImplementationName(), getItemImage(), getSupportedServiceNames(), getTypes(), isInExecute(), isPopupMenu(), queryInterface(), setAcceleratorKeyEvent(), setItemImage(), VCLXTopWindow::setMenuBar(), and setPopupMenu().

◆ isPopupMenu()

sal_Bool SAL_CALL VCLXMenu::isPopupMenu ( )
overridevirtual

Definition at line 609 of file vclxmenu.cxx.

References IsPopupMenu(), and maMutex.

◆ queryInterface()

css::uno::Any VCLXMenu::queryInterface ( const css::uno::Type &  rType)
overridevirtual

Reimplemented from cppu::OWeakObject.

Definition at line 204 of file vclxmenu.cxx.

References IsPopupMenu(), and maMutex.

◆ release()

void SAL_CALL VCLXMenu::release ( )
inlineoverridevirtualnoexcept

Reimplemented from cppu::OWeakObject.

Definition at line 86 of file vclxmenu.hxx.

References cppu::OWeakObject::release().

◆ removeItem()

void VCLXMenu::removeItem ( sal_Int16  nPos,
sal_Int16  nCount 
)
overridevirtual

Definition at line 289 of file vclxmenu.cxx.

References maMutex, mpMenu, nCount, and nPos.

◆ removeMenuListener()

void VCLXMenu::removeMenuListener ( const css::uno::Reference< css::awt::XMenuListener > &  xListener)
overridevirtual

Definition at line 268 of file vclxmenu.cxx.

References maMenuListeners, and maMutex.

◆ setAcceleratorKeyEvent()

void SAL_CALL VCLXMenu::setAcceleratorKeyEvent ( ::sal_Int16  nItemId,
const css::awt::KeyEvent &  aKeyEvent 
)
overridevirtual

Definition at line 693 of file vclxmenu.cxx.

References IsPopupMenu(), maMutex, MENU_ITEM_NOTFOUND, and mpMenu.

◆ setCommand()

void SAL_CALL VCLXMenu::setCommand ( sal_Int16  nItemId,
const OUString &  aCommand 
)
overridevirtual

Definition at line 492 of file vclxmenu.cxx.

References aCommand, maMutex, and mpMenu.

◆ setDefaultItem()

void VCLXMenu::setDefaultItem ( sal_Int16  nItemId)
overridevirtual

Definition at line 437 of file vclxmenu.cxx.

References maMutex, and mnDefaultItem.

◆ setHelpCommand()

void SAL_CALL VCLXMenu::setHelpCommand ( sal_Int16  nItemId,
const OUString &  aHelp 
)
overridevirtual

Definition at line 515 of file vclxmenu.cxx.

References maMutex, and mpMenu.

◆ setHelpText()

void SAL_CALL VCLXMenu::setHelpText ( ::sal_Int16  nItemId,
const OUString &  sHelpText 
)
overridevirtual

Definition at line 725 of file vclxmenu.cxx.

References maMutex, MENU_ITEM_NOTFOUND, and mpMenu.

◆ setItemImage()

void SAL_CALL VCLXMenu::setItemImage ( ::sal_Int16  nItemId,
const css::uno::Reference< css::graphic::XGraphic > &  xGraphic,
sal_Bool  bScale 
)
overridevirtual

Definition at line 784 of file vclxmenu.cxx.

References IsPopupMenu(), maMutex, MENU_ITEM_NOTFOUND, and mpMenu.

◆ setItemText()

void VCLXMenu::setItemText ( sal_Int16  nItemId,
const OUString &  aText 
)
overridevirtual

Definition at line 355 of file vclxmenu.cxx.

References maMutex, and mpMenu.

◆ setPopupMenu()

void VCLXMenu::setPopupMenu ( sal_Int16  nItemId,
const css::uno::Reference< css::awt::XPopupMenu > &  aPopupMenu 
)
overridevirtual

Definition at line 378 of file vclxmenu.cxx.

References DBG_ASSERT, GetMenu(), IsPopupMenu(), maMutex, maPopupMenuRefs, and mpMenu.

◆ setTipHelpText()

void SAL_CALL VCLXMenu::setTipHelpText ( ::sal_Int16  nItemId,
const OUString &  sTipHelpText 
)
overridevirtual

Definition at line 755 of file vclxmenu.cxx.

References maMutex, MENU_ITEM_NOTFOUND, and mpMenu.

◆ setUserValue()

void VCLXMenu::setUserValue ( sal_uInt16  nItemId,
void *  nUserValue,
MenuUserDataReleaseFunction  aFunc 
)

Definition at line 818 of file vclxmenu.cxx.

References maMutex, and mpMenu.

◆ supportsService()

sal_Bool SAL_CALL VCLXMenu::supportsService ( const OUString &  ServiceName)
overridevirtual

Definition at line 199 of file vclxmenu.cxx.

References cppu::supportsService().

Member Data Documentation

◆ maMenuListeners

MenuListenerMultiplexer VCLXMenu::maMenuListeners
private

Definition at line 61 of file vclxmenu.hxx.

Referenced by addMenuListener(), and removeMenuListener().

◆ maMutex

std::mutex VCLXMenu::maMutex
private

Definition at line 59 of file vclxmenu.hxx.

Referenced by addMenuListener(), checkItem(), clear(), enableAutoMnemonics(), enableItem(), endExecute(), execute(), getAcceleratorKeyEvent(), getCommand(), getDefaultItem(), getHelpCommand(), getHelpText(), getImplementationName(), getItemCount(), getItemId(), getItemImage(), getItemPos(), getItemText(), getItemType(), getPopupMenu(), getSupportedServiceNames(), getTipHelpText(), getTypes(), getUserValue(), hideDisabledEntries(), insertItem(), insertSeparator(), isInExecute(), isItemChecked(), isItemEnabled(), isPopupMenu(), queryInterface(), removeItem(), removeMenuListener(), setAcceleratorKeyEvent(), setCommand(), setDefaultItem(), setHelpCommand(), setHelpText(), setItemImage(), setItemText(), setPopupMenu(), setTipHelpText(), and setUserValue().

◆ maPopupMenuRefs

PopupMenuRefList VCLXMenu::maPopupMenuRefs
private

Definition at line 62 of file vclxmenu.hxx.

Referenced by getPopupMenu(), setPopupMenu(), and ~VCLXMenu().

◆ mnDefaultItem

sal_Int16 VCLXMenu::mnDefaultItem
private

Definition at line 63 of file vclxmenu.hxx.

Referenced by getDefaultItem(), and setDefaultItem().

◆ mpMenu

VclPtr<Menu> VCLXMenu::mpMenu
private

Definition at line 60 of file vclxmenu.hxx.

Referenced by checkItem(), clear(), enableAutoMnemonics(), enableItem(), endExecute(), execute(), getAcceleratorKeyEvent(), getCommand(), getHelpCommand(), getHelpText(), getItemCount(), getItemId(), getItemImage(), getItemPos(), getItemText(), getItemType(), getPopupMenu(), getTipHelpText(), getUserValue(), hideDisabledEntries(), ImplAddListener(), ImplCreateMenu(), insertItem(), insertSeparator(), isInExecute(), isItemChecked(), isItemEnabled(), IsPopupMenu(), removeItem(), setAcceleratorKeyEvent(), setCommand(), setHelpCommand(), setHelpText(), setItemImage(), setItemText(), setPopupMenu(), setTipHelpText(), setUserValue(), VCLXMenu(), and ~VCLXMenu().

The documentation for this class was generated from the following files:
Generated on Sun Jul 30 2023 04:29:50 for LibreOffice Module toolkit (master) by doxygen 1.9.3