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