| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| #ifndef __FRAMEWORK_CLASSES_ADDONMENU_HXX_ |
| #define __FRAMEWORK_CLASSES_ADDONMENU_HXX_ |
| |
| //_________________________________________________________________________________________________________________ |
| // interface includes |
| //_________________________________________________________________________________________________________________ |
| |
| #include <com/sun/star/frame/XFrame.hpp> |
| #include <com/sun/star/beans/PropertyValue.hpp> |
| #include <com/sun/star/uno/Sequence.hxx> |
| |
| //_________________________________________________________________________________________________________________ |
| // includes of other projects |
| //_________________________________________________________________________________________________________________ |
| |
| #include <vcl/menu.hxx> |
| #include <framework/fwedllapi.h> |
| |
| #define ADDONMENU_ITEMID_START 2000 |
| #define ADDONMENU_ITEMID_END 3000 |
| |
| namespace framework |
| { |
| |
| class FWE_DLLPUBLIC AddonMenu : public PopupMenu |
| { |
| public: |
| AddonMenu( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& rFrame ); |
| ~AddonMenu(); |
| |
| protected: |
| ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame > m_xFrame; |
| }; |
| |
| class AddonMenuManager; |
| class FWE_DLLPUBLIC AddonPopupMenu : public AddonMenu |
| { |
| public: |
| ~AddonPopupMenu(); |
| |
| // Check if command URL string has the unique prefix to identify addon popup menus |
| static sal_Bool IsCommandURLPrefix( const rtl::OUString& aCmdURL ); |
| |
| void SetCommandURL( const rtl::OUString& aCmdURL ) { m_aCommandURL = aCmdURL; } |
| const rtl::OUString& GetCommandURL() const { return m_aCommandURL; } |
| |
| protected: |
| void Initialize( const com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue >& rAddonPopupMenuDefinition ); |
| |
| private: |
| AddonPopupMenu( const com::sun::star::uno::Reference< com::sun::star::frame::XFrame >& rFrame ); |
| |
| rtl::OUString m_aCommandURL; |
| |
| friend class AddonMenuManager; |
| }; |
| |
| class FWE_DLLPUBLIC AddonMenuManager |
| { |
| public: |
| enum MenuType |
| { |
| ADDON_MENU, |
| ADDON_POPUPMENU |
| }; |
| |
| static sal_Bool HasAddonMenuElements(); |
| static sal_Bool HasAddonHelpMenuElements(); |
| |
| static sal_Bool IsAddonMenuId( sal_uInt16 nId ) { return (( nId >= ADDONMENU_ITEMID_START ) && ( nId < ADDONMENU_ITEMID_END )); } |
| |
| // Check if the context string matches the provided xModel context |
| static sal_Bool IsCorrectContext( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& rModel, const rtl::OUString& aContext ); |
| |
| // Factory method to create different Add-On menu types |
| static PopupMenu* CreatePopupMenuType( MenuType eMenuType, const com::sun::star::uno::Reference< com::sun::star::frame::XFrame >& rFrame ); |
| |
| // Create the Add-Ons menu |
| static AddonMenu* CreateAddonMenu( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& rFrame ); |
| |
| // Merge the Add-Ons help menu items into the given menu bar at a defined pos |
| static void MergeAddonHelpMenu( const com::sun::star::uno::Reference< com::sun::star::frame::XFrame >& rFrame, |
| MenuBar* pMergeMenuBar ); |
| |
| // Merge the addon popup menus into the given menu bar at the provided pos. |
| static void MergeAddonPopupMenus( const com::sun::star::uno::Reference< com::sun::star::frame::XFrame >& rFrame, |
| const com::sun::star::uno::Reference< com::sun::star::frame::XModel >& rModel, |
| sal_uInt16 nMergeAtPos, |
| MenuBar* pMergeMenuBar ); |
| |
| // Returns the next position to insert a menu item/sub menu |
| static sal_uInt16 GetNextPos( sal_uInt16 nPos ); |
| |
| // Build up the menu item and sub menu into the provided pCurrentMenu. The sub menus should be of type nSubMenuType. |
| static void BuildMenu( PopupMenu* pCurrentMenu, |
| MenuType nSubMenuType, |
| sal_uInt16 nInsPos, |
| sal_uInt16& nUniqueMenuId, |
| com::sun::star::uno::Sequence< com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue > > aAddonMenuDefinition, |
| const com::sun::star::uno::Reference< com::sun::star::frame::XFrame >& rFrame, |
| const com::sun::star::uno::Reference< com::sun::star::frame::XModel >& rModel ); |
| |
| // Retrieve the menu entry property values from a sequence |
| static void GetMenuEntry( const com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue >& rAddonMenuEntry, |
| ::rtl::OUString& rTitle, |
| ::rtl::OUString& rURL, |
| ::rtl::OUString& rTarget, |
| ::rtl::OUString& rImageId, |
| ::rtl::OUString& rContext, |
| com::sun::star::uno::Sequence< com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue > >& rAddonSubMenu ); |
| }; |
| |
| } // namespace framework |
| |
| #endif // #ifndef __FRAMEWORK_CLASSES_ADDONMENU_HXX_ |
