| /************************************************************** |
| * |
| * 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_HELPER_ACTIONTRIGGERHELPER_HXX_ |
| #define __FRAMEWORK_HELPER_ACTIONTRIGGERHELPER_HXX_ |
| |
| #include <com/sun/star/container/XIndexContainer.hpp> |
| |
| // #110897# |
| #include <com/sun/star/lang/XMultiServiceFactory.hpp> |
| #include <vcl/menu.hxx> |
| #include <framework/fwedllapi.h> |
| |
| |
| namespace framework |
| { |
| class FWE_DLLPUBLIC ActionTriggerHelper |
| { |
| public: |
| // Fills the submitted menu with the structure contained in the second |
| // parameter rActionTriggerContainer |
| // @param pNewMenu = must be a valid and empty menu |
| // @param rActionTriggerContainer = must be an instance of service "com.sun.star.ui.ActionTriggerContaienr" |
| static void |
| CreateMenuFromActionTriggerContainer( |
| Menu* pNewMenu, |
| const com::sun::star::uno::Reference< com::sun::star::container::XIndexContainer >& rActionTriggerContainer ); |
| |
| // Creates a "com::sun::star::ui::ActionTriggerContainer" with the structure of the menu |
| // provided as a parameter. The implementation class stores the menu pointer |
| // to optimize the time of creation of a menu from a actiontrigger structure. |
| // IMPORTANT: The caller must ensure that the menu pointer is valid through the |
| // life time of the XIndexContainer object!!! |
| // |
| // @param pNewMenu = Must be a valid menu. Please be aware that this implementation is based on |
| // the above mentioned restriction!!! |
| |
| // #110897# |
| static com::sun::star::uno::Reference< com::sun::star::container::XIndexContainer > CreateActionTriggerContainerFromMenu( |
| const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& xServiceFactory, |
| const Menu* pMenu, const ::rtl::OUString* pMenuIdentifier ); |
| |
| // Fills the submitted rActionTriggerContainer with the structure of the menu |
| // provided as the second parameter |
| // @param rActionTriggerContainer = must be an instance of service "com.sun.star.ui.ActionTriggerContainer" |
| // @param pNewMenu = must be a valid menu |
| static void |
| FillActionTriggerContainerFromMenu( |
| com::sun::star::uno::Reference< com::sun::star::container::XIndexContainer >& rActionTriggerContainer, |
| const Menu* pMenu ); |
| |
| }; |
| } |
| |
| #endif // __FRAMEWORK_HELPER_ACTIONTRIGGERHELPER_HXX_ |
