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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XDispatchProvider.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_frame_XDispatchProvider_idl__
  31 #define __com_sun_star_frame_XDispatchProvider_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_frame_XDispatch_idl__
  38 #include <com/sun/star/frame/XDispatch.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_util_URL_idl__
  42 #include <com/sun/star/util/URL.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_frame_DispatchDescriptor_idl__
  46 #include <com/sun/star/frame/DispatchDescriptor.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52  module com {  module sun {  module star {  module frame {
  53
  54 //=============================================================================
  55 /** provides <type>XDispatch</type> interfaces for certain functions which
  56     are useful at the UI.
  57
  58     @see XDispatch
  59  */
  60 published interface XDispatchProvider: com::sun::star::uno::XInterface
  61 {
  62     //-------------------------------------------------------------------------
  63     /** searches for an <type>XDispatch</type> for the specified URL within
  64         the specified target frame.
  65
  66         @param URL
  67             describe the feature which should be supported by returned dispatch object
  68
  69         @param TargetFrameName
  70             specify the frame which should be the target for this request
  71
  72         @param SearchFlags
  73             optional search parameter for finding the frame if no special
  74             <var>TargetFrameName</var> was used
  75
  76         @return
  77             the dispatch object which provides queried functionality
  78             <br>
  79             or <NULL/> if no dispatch object is available
  80
  81         @see XFrame::findFrame()
  82         @see XDispatchProvider::queryDispatches()
  83      */
  84     XDispatch queryDispatch(
  85         [in] com::sun::star::util::URL URL,
  86         [in] string TargetFrameName,
  87         [in] long SearchFlags );
  88
  89     //-------------------------------------------------------------------------
  90     /** actually this method is redundant to <member>XDispatchProvider::queryDispatch()</member>
  91         to avoid multiple remote calls.
  92
  93         @param Requests
  94             list of dispatch requests
  95
  96         @returns
  97             multiple dispatch interfaces for the specified descriptors at once
  98
  99             <p>
 100             It's not allowed to pack it - because every request must match
 101             to his real result. Means: don't delete <NULL/> entries inside this list.
 102             </p>
 103      */
 104     sequence< XDispatch > queryDispatches(
 105         [in] sequence<DispatchDescriptor> Requests);
 106 };
 107
 108 //=============================================================================
 109
 110 }; }; }; };
 111
 112 #endif