diff options
Diffstat (limited to 'include/framework/actiontriggerhelper.hxx')
-rw-r--r-- | include/framework/actiontriggerhelper.hxx | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/include/framework/actiontriggerhelper.hxx b/include/framework/actiontriggerhelper.hxx new file mode 100644 index 000000000000..e942de94924f --- /dev/null +++ b/include/framework/actiontriggerhelper.hxx @@ -0,0 +1,67 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * 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 . + */ + +#ifndef __FRAMEWORK_HELPER_ACTIONTRIGGERHELPER_HXX_ +#define __FRAMEWORK_HELPER_ACTIONTRIGGERHELPER_HXX_ + +#include <com/sun/star/container/XIndexContainer.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!!! + + static com::sun::star::uno::Reference< com::sun::star::container::XIndexContainer > CreateActionTriggerContainerFromMenu( + const Menu* pMenu, const 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_ + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |