include/comphelper/dispatchcommand.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
  10 #ifndef INCLUDED_COMPHELPER_DISPATCHCOMMAND_HXX
  11 #define INCLUDED_COMPHELPER_DISPATCHCOMMAND_HXX
  12
  13 #include <comphelper/comphelperdllapi.h>
  14 #include <rtl/ustring.hxx>
  15 #include <com/sun/star/uno/Sequence.hxx>
  16 #include <com/sun/star/beans/PropertyValue.hpp>
  17 #include <com/sun/star/frame/XDispatchResultListener.hpp>
  18
  19 namespace comphelper
  20 {
  21
  22 /** Dispatch the given UNO command in the active frame.
  23
  24     @param rCommand the command to dispatch, like ".uno:Bold".
  25
  26     @return true on success.
  27 */
  28 COMPHELPER_DLLPUBLIC bool dispatchCommand(const OUString& rCommand,
  29         const css::uno::Sequence<css::beans::PropertyValue>& rArguments,
  30         const css::uno::Reference<css::frame::XDispatchResultListener>& aListener = css::uno::Reference<css::frame::XDispatchResultListener>());
  31
  32 }
  33
  34 #endif // INCLUDED_COMPHELPER_DISPATCHCOMMAND_HXX
  35
  36 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */