office-gobmx/include/framework/actiontriggerhelper.hxx
Noel Grandin 039d9b97b7 loplugin:constparams in framework
Change-Id: Iecd19a0cbb3cc78158c17bfa064cc23bafc44b18
Reviewed-on: https://gerrit.libreoffice.org/40206
Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
2017-07-20 09:19:54 +02:00

67 lines
3.1 KiB
C++

/* -*- 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 INCLUDED_FRAMEWORK_ACTIONTRIGGERHELPER_HXX
#define INCLUDED_FRAMEWORK_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.ActionTriggerContainer"
static void
CreateMenuFromActionTriggerContainer(
Menu* pNewMenu,
const css::uno::Reference< css::container::XIndexContainer >& rActionTriggerContainer );
// Creates a "css::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 css::uno::Reference< css::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(
css::uno::Reference< css::container::XIndexContainer > const & rActionTriggerContainer,
const Menu* pMenu );
};
}
#endif // INCLUDED_FRAMEWORK_ACTIONTRIGGERHELPER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */