offapi/com/sun/star/frame/XDispatchHelper.idl

   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
  20
  21  module com {  module sun {  module star {  module frame {
  22
  23 /** provides an easy way to dispatch functions useful at UI level.
  24
  25     @see XDispatch
  26
  27     @since OOo 1.1.2
  28  */
  29 published interface XDispatchHelper : com::sun::star::uno::XInterface
  30 {
  31         /** executes the dispatch.
  32
  33         Listeners are not supported here!
  34
  35         @param DispatchProvider
  36              points to the provider, which should be asked for valid dispatch objects
  37
  38         @param URL
  39             describes the feature which should be supported by internally used dispatch object
  40
  41         @param TargetFrameName
  42             specifies the frame which should be the target for this request
  43
  44         @param SearchFlags
  45             optional search parameter for finding the frame if no special
  46             <var>TargetFrameName</var> was used
  47
  48         @param Arguments
  49             optional arguments for this request
  50             They depend on the real implementation of the dispatch object.
  51
  52         @return
  53             A possible result of the executed internal dispatch.
  54             The information behind this `any` depends on the dispatch!
  55
  56         @see XDispatch::dispatch()
  57         */
  58
  59         any executeDispatch(
  60                 [in] XDispatchProvider DispatchProvider,
  61                 [in] string URL,
  62                 [in] string TargetFrameName,
  63                 [in] long SearchFlags,
  64                 [in] sequence< com::sun::star::beans::PropertyValue > Arguments );
  65 };
  66
  67
  68 }; }; }; };
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */