include/framework/addonmenu.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 #ifndef INCLUDED_FRAMEWORK_ADDONMENU_HXX
  20 #define INCLUDED_FRAMEWORK_ADDONMENU_HXX
  21
  22 #include <com/sun/star/frame/XFrame.hpp>
  23 #include <com/sun/star/beans/PropertyValue.hpp>
  24 #include <com/sun/star/uno/Sequence.hxx>
  25 #include <com/sun/star/uno/XComponentContext.hpp>
  26 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  27
  28 #include <vcl/menu.hxx>
  29 #include <framework/fwedllapi.h>
  30
  31 #define ADDONMENU_ITEMID_START       2000
  32 #define ADDONMENU_ITEMID_END         3000
  33
  34 namespace framework
  35 {
  36
  37 class FWE_DLLPUBLIC AddonMenuManager
  38 {
  39     public:
  40         static bool       HasAddonMenuElements();
  41
  42         // Check if the context string matches the provided xModel context
  43         static bool IsCorrectContext(const OUString& rModuleIdentifier, const OUString& rContext);
  44
  45         // Create the Add-Ons menu
  46         static VclPtr<PopupMenu> CreateAddonMenu( const css::uno::Reference< css::frame::XFrame >& rFrame );
  47
  48         // Merge the Add-Ons help menu items into the given menu bar at a defined pos
  49         static void       MergeAddonHelpMenu( const css::uno::Reference< css::frame::XFrame >& rFrame,
  50                                               MenuBar* pMergeMenuBar );
  51
  52         // Merge the addon popup menus into the given menu bar at the provided pos.
  53         static void       MergeAddonPopupMenus( const css::uno::Reference< css::frame::XFrame >& rFrame,
  54                                                 sal_uInt16   nMergeAtPos,
  55                                                 MenuBar* pMergeMenuBar );
  56
  57         // Returns the next position to insert a menu item/sub menu
  58         static sal_uInt16     GetNextPos( sal_uInt16 nPos );
  59
  60         // Build up the menu item and sub menu into the provided pCurrentMenu. The sub menus should be of type nSubMenuType.
  61         static void       BuildMenu( PopupMenu*  pCurrentMenu,
  62                                      sal_uInt16      nInsPos,
  63                                      sal_uInt16&     nUniqueMenuId,
  64                                      const css::uno::Sequence< css::uno::Sequence< css::beans::PropertyValue > >& aAddonMenuDefinition,
  65                                      const css::uno::Reference< css::frame::XFrame >& rFrame,
  66                                      const ::rtl::OUString& rModuleIdentifier );
  67
  68         // Retrieve the menu entry property values from a sequence
  69         static void       GetMenuEntry( const css::uno::Sequence< css::beans::PropertyValue >& rAddonMenuEntry,
  70                                         OUString& rTitle,
  71                                         OUString& rURL,
  72                                         OUString& rTarget,
  73                                         OUString& rImageId,
  74                                         OUString& rContext,
  75                                         css::uno::Sequence< css::uno::Sequence< css::beans::PropertyValue > >& rAddonSubMenu );
  76 };
  77
  78 } // namespace framework
  79
  80 #endif // INCLUDED_FRAMEWORK_ADDONMENU_HXX
  81
  82 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */