offapi/com/sun/star/frame/XDispatchHelper.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: XDispatchHelper.idl,v $
  10  * $Revision: 1.8 $
  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_XDispatchHelper_idl__
  31 #define __com_sun_star_frame_XDispatchHelper_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_XDispatchProvider_idl__
  38 #include <com/sun/star/frame/XDispatchProvider.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_beans_PropertyValue_idl__
  42 #include <com/sun/star/beans/PropertyValue.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47  module com {  module sun {  module star {  module frame {
  48
  49 //=============================================================================
  50 /** provides an easy way to dispatch functions useful at UI level.
  51
  52     @see XDispatch
  53
  54     @since OOo 1.1.2
  55  */
  56 published interface XDispatchHelper : com::sun::star::uno::XInterface
  57 {
  58     //-------------------------------------------------------------------------
  59         /** executes the dispatch.
  60
  61         Listeners are not supported here!
  62
  63         @param DispatchProvider
  64              points to the provider, which should be asked for valid dispatch objects
  65
  66         @param URL
  67             describes the feature which should be supported by internally used dispatch object
  68
  69         @param TargetFrameName
  70             specifies 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         @param Arguments
  77             optional arguments for this request
  78             They depend on the real implementation of the dispatch object.
  79
  80         @return
  81             A possible result of the executed internal dispatch.
  82             The information behind this <atom>any</atom> depends on the dispatch!
  83
  84         @see XDispatch::dispatch()
  85         */
  86
  87         any executeDispatch(
  88                 [in] XDispatchProvider DispatchProvider,
  89                 [in] string URL,
  90                 [in] string TargetFrameName,
  91                 [in] long SearchFlags,
  92                 [in] sequence< com::sun::star::beans::PropertyValue > Arguments );
  93 };
  94
  95 //=============================================================================
  96
  97 }; }; }; };
  98
  99 #endif