offapi/com/sun/star/frame/XDispatchProvider.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
  22  module com {  module sun {  module star {  module frame {
  23
  24 /** provides XDispatch interfaces for certain functions which
  25     are useful at the UI.
  26
  27     @see XDispatch
  28  */
  29 published interface XDispatchProvider: com::sun::star::uno::XInterface
  30 {
  31     /** searches for an XDispatch for the specified URL within
  32         the specified target frame.
  33
  34         @param URL
  35             describe the feature which should be supported by returned dispatch object
  36
  37         @param TargetFrameName
  38             specify the frame which should be the target for this request
  39
  40         @param SearchFlags
  41             optional search parameter for finding the frame if no special
  42             <var>TargetFrameName</var> was used
  43
  44         @return
  45             the dispatch object which provides queried functionality
  46             <br>
  47             or `NULL` if no dispatch object is available
  48
  49         @see XFrame::findFrame()
  50         @see XDispatchProvider::queryDispatches()
  51      */
  52     XDispatch queryDispatch(
  53         [in] com::sun::star::util::URL URL,
  54         [in] string TargetFrameName,
  55         [in] long SearchFlags );
  56
  57     /** actually this method is redundant to XDispatchProvider::queryDispatch()
  58         to avoid multiple remote calls.
  59
  60         @param Requests
  61             list of dispatch requests
  62
  63         @returns
  64             multiple dispatch interfaces for the specified descriptors at once
  65
  66             <p>
  67             It's not allowed to pack it - because every request must match
  68             to its real result. Means: don't delete `NULL` entries inside this list.
  69             </p>
  70      */
  71     sequence< XDispatch > queryDispatches(
  72         [in] sequence<DispatchDescriptor> Requests);
  73 };
  74
  75
  76 }; }; }; };
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */