include/toolkit/awt/vclxmenu.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_TOOLKIT_AWT_VCLXMENU_HXX
  21 #define INCLUDED_TOOLKIT_AWT_VCLXMENU_HXX
  22
  23 #include <config_options.h>
  24 #include <toolkit/dllapi.h>
  25 #include <toolkit/helper/listenermultiplexer.hxx>
  26
  27 #include <com/sun/star/awt/XMenuBar.hpp>
  28 #include <com/sun/star/awt/XPopupMenu.hpp>
  29 #include <com/sun/star/lang/XServiceInfo.hpp>
  30 #include <com/sun/star/lang/XTypeProvider.hpp>
  31
  32 #include <cppuhelper/weak.hxx>
  33 #include <mutex>
  34
  35 #include <tools/link.hxx>
  36 #include <vcl/vclptr.hxx>
  37
  38 #include <vector>
  39
  40 class Menu;
  41 class MenuBar;
  42 class PopupMenu;
  43 class VclMenuEvent;
  44
  45 typedef ::std::vector<
  46     css::uno::Reference< css::awt::XPopupMenu >
  47 > PopupMenuRefList;
  48
  49 typedef void (*MenuUserDataReleaseFunction)(void*);
  50
  51 class TOOLKIT_DLLPUBLIC VCLXMenu :  public css::awt::XMenuBar,
  52                                     public css::awt::XPopupMenu,
  53                                     public css::lang::XServiceInfo,
  54                                     public css::lang::XTypeProvider,
  55                                     public ::cppu::OWeakObject
  56 {
  57 private:
  58     std::mutex              maMutex;
  59     VclPtr<Menu>            mpMenu;
  60     MenuListenerMultiplexer maMenuListeners;
  61     PopupMenuRefList        maPopupMenuRefs;
  62     sal_Int16               mnDefaultItem;
  63
  64 protected:
  65
  66     DECL_DLLPRIVATE_LINK( MenuEventListener, VclMenuEvent&, void );
  67
  68     void ImplCreateMenu( bool bPopup );
  69     void ImplAddListener();
  70
  71 public:
  72     VCLXMenu();
  73     VCLXMenu( Menu* pMenu );
  74     virtual ~VCLXMenu() override;
  75
  76
  77     Menu*    GetMenu() const { return mpMenu; }
  78     bool IsPopupMenu() const;
  79     void setUserValue(sal_uInt16 nItemId, void* nUserValue, MenuUserDataReleaseFunction aFunc);
  80     void* getUserValue(sal_uInt16 nItemId);
  81
  82     // css::uno::XInterface
  83     css::uno::Any  SAL_CALL queryInterface( const css::uno::Type & rType ) override;
  84     void SAL_CALL acquire() noexcept override  { OWeakObject::acquire(); }
  85     void SAL_CALL release() noexcept override  { OWeakObject::release(); }
  86
  87     // css::lang::XTypeProvider
  88     css::uno::Sequence< css::uno::Type >  SAL_CALL getTypes() override;
  89     css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() override;
  90
  91     // css::awt::XMenu
  92     virtual void SAL_CALL addMenuListener( const css::uno::Reference< css::awt::XMenuListener >& xListener ) override;
  93     virtual void SAL_CALL removeMenuListener( const css::uno::Reference< css::awt::XMenuListener >& xListener ) override;
  94     virtual void SAL_CALL insertItem( sal_Int16 nItemId, const OUString& aText, sal_Int16 nItemStyle, sal_Int16 nPos ) override;
  95     virtual void SAL_CALL removeItem( sal_Int16 nPos, sal_Int16 nCount ) override;
  96     virtual void SAL_CALL clear( ) override;
  97     virtual sal_Int16 SAL_CALL getItemCount(  ) override;
  98     virtual sal_Int16 SAL_CALL getItemId( sal_Int16 nPos ) override;
  99     virtual sal_Int16 SAL_CALL getItemPos( sal_Int16 nId ) override;
 100     virtual css::awt::MenuItemType SAL_CALL getItemType( ::sal_Int16 nItemPos ) override;
 101     virtual void SAL_CALL enableItem( sal_Int16 nItemId, sal_Bool bEnable ) override;
 102     virtual sal_Bool SAL_CALL isItemEnabled( sal_Int16 nItemId ) override;
 103     virtual void SAL_CALL hideDisabledEntries( sal_Bool bHide ) override;
 104     virtual void SAL_CALL enableAutoMnemonics( sal_Bool bEnable ) override;
 105     virtual void SAL_CALL setItemText( sal_Int16 nItemId, const OUString& aText ) override;
 106     virtual OUString SAL_CALL getItemText( sal_Int16 nItemId ) override;
 107     virtual void SAL_CALL setCommand( sal_Int16 nItemId, const OUString& aCommand ) override;
 108     virtual OUString SAL_CALL getCommand( sal_Int16 nItemId ) override;
 109     virtual void SAL_CALL setHelpCommand( sal_Int16 nItemId, const OUString& aHelp ) override;
 110     virtual OUString SAL_CALL getHelpCommand( sal_Int16 nItemId ) override;
 111     virtual void SAL_CALL setHelpText( ::sal_Int16 nItemId, const OUString& sHelpText ) override;
 112     virtual OUString SAL_CALL getHelpText( ::sal_Int16 nItemId ) override;
 113     virtual void SAL_CALL setTipHelpText( ::sal_Int16 nItemId, const OUString& sTipHelpText ) override;
 114     virtual OUString SAL_CALL getTipHelpText( ::sal_Int16 nItemId ) override;
 115
 116     virtual sal_Bool SAL_CALL isPopupMenu(  ) override;
 117     virtual void SAL_CALL setPopupMenu( sal_Int16 nItemId, const css::uno::Reference< css::awt::XPopupMenu >& aPopupMenu ) override;
 118     virtual css::uno::Reference< css::awt::XPopupMenu > SAL_CALL getPopupMenu( sal_Int16 nItemId ) override;
 119
 120     // css::awt::XPopupMenu
 121     virtual void SAL_CALL insertSeparator( sal_Int16 nPos ) override;
 122     virtual void SAL_CALL setDefaultItem( sal_Int16 nItemId ) override;
 123     virtual sal_Int16 SAL_CALL getDefaultItem(  ) override;
 124     virtual void SAL_CALL checkItem( sal_Int16 nItemId, sal_Bool bCheck ) override;
 125     virtual sal_Bool SAL_CALL isItemChecked( sal_Int16 nItemId ) override;
 126     virtual ::sal_Int16 SAL_CALL execute( const css::uno::Reference< css::awt::XWindowPeer >& Parent, const css::awt::Rectangle& Position, ::sal_Int16 Direction ) override;
 127     virtual sal_Bool SAL_CALL isInExecute(  ) override;
 128     virtual void SAL_CALL endExecute(  ) override;
 129     virtual void SAL_CALL setAcceleratorKeyEvent( ::sal_Int16 nItemId, const css::awt::KeyEvent& aKeyEvent ) override;
 130     virtual css::awt::KeyEvent SAL_CALL getAcceleratorKeyEvent( ::sal_Int16 nItemId ) override;
 131     virtual void SAL_CALL setItemImage( ::sal_Int16 nItemId, const css::uno::Reference< css::graphic::XGraphic >& xGraphic, sal_Bool bScale ) override;
 132     virtual css::uno::Reference< css::graphic::XGraphic > SAL_CALL getItemImage( ::sal_Int16 nItemId ) override;
 133
 134     // css::lang::XServiceInfo
 135     virtual OUString SAL_CALL getImplementationName(  ) override;
 136     virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;
 137     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames(  ) override;
 138 };
 139
 140 class UNLESS_MERGELIBS(TOOLKIT_DLLPUBLIC) VCLXMenuBar final : public VCLXMenu
 141 {
 142 public:
 143     VCLXMenuBar();
 144     VCLXMenuBar( MenuBar* pMenuBar );
 145 };
 146
 147 class TOOLKIT_DLLPUBLIC VCLXPopupMenu final : public VCLXMenu
 148 {
 149 public:
 150     VCLXPopupMenu();
 151     VCLXPopupMenu( PopupMenu* pPopMenu );
 152
 153     ~VCLXPopupMenu() override;
 154 };
 155
 156 #endif // INCLUDED_TOOLKIT_AWT_VCLXMENU_HXX
 157
 158 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */