1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_frame_XDispatchHelper_idl__ 24cdf0e10cSrcweir#define __com_sun_star_frame_XDispatchHelper_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_frame_XDispatchProvider_idl__ 31cdf0e10cSrcweir#include <com/sun/star/frame/XDispatchProvider.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_beans_PropertyValue_idl__ 35cdf0e10cSrcweir#include <com/sun/star/beans/PropertyValue.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir//============================================================================= 39cdf0e10cSrcweir 40cdf0e10cSrcweir module com { module sun { module star { module frame { 41cdf0e10cSrcweir 42cdf0e10cSrcweir//============================================================================= 43cdf0e10cSrcweir/** provides an easy way to dispatch functions useful at UI level. 44cdf0e10cSrcweir 45cdf0e10cSrcweir @see XDispatch 46cdf0e10cSrcweir 47*c4dc0a1aSJürgen Schmidt @since OpenOffice 1.1.2 48cdf0e10cSrcweir */ 49cdf0e10cSrcweirpublished interface XDispatchHelper : com::sun::star::uno::XInterface 50cdf0e10cSrcweir{ 51cdf0e10cSrcweir //------------------------------------------------------------------------- 52cdf0e10cSrcweir /** executes the dispatch. 53cdf0e10cSrcweir 54cdf0e10cSrcweir Listeners are not supported here! 55cdf0e10cSrcweir 56cdf0e10cSrcweir @param DispatchProvider 57cdf0e10cSrcweir points to the provider, which should be asked for valid dispatch objects 58cdf0e10cSrcweir 59cdf0e10cSrcweir @param URL 60cdf0e10cSrcweir describes the feature which should be supported by internally used dispatch object 61cdf0e10cSrcweir 62cdf0e10cSrcweir @param TargetFrameName 63cdf0e10cSrcweir specifies the frame which should be the target for this request 64cdf0e10cSrcweir 65cdf0e10cSrcweir @param SearchFlags 66cdf0e10cSrcweir optional search parameter for finding the frame if no special 67cdf0e10cSrcweir <var>TargetFrameName</var> was used 68cdf0e10cSrcweir 69cdf0e10cSrcweir @param Arguments 70cdf0e10cSrcweir optional arguments for this request 71cdf0e10cSrcweir They depend on the real implementation of the dispatch object. 72cdf0e10cSrcweir 73cdf0e10cSrcweir @return 74cdf0e10cSrcweir A possible result of the executed internal dispatch. 75cdf0e10cSrcweir The information behind this <atom>any</atom> depends on the dispatch! 76cdf0e10cSrcweir 77cdf0e10cSrcweir @see XDispatch::dispatch() 78cdf0e10cSrcweir */ 79cdf0e10cSrcweir 80cdf0e10cSrcweir any executeDispatch( 81cdf0e10cSrcweir [in] XDispatchProvider DispatchProvider, 82cdf0e10cSrcweir [in] string URL, 83cdf0e10cSrcweir [in] string TargetFrameName, 84cdf0e10cSrcweir [in] long SearchFlags, 85cdf0e10cSrcweir [in] sequence< com::sun::star::beans::PropertyValue > Arguments ); 86cdf0e10cSrcweir}; 87cdf0e10cSrcweir 88cdf0e10cSrcweir//============================================================================= 89cdf0e10cSrcweir 90cdf0e10cSrcweir}; }; }; }; 91cdf0e10cSrcweir 92cdf0e10cSrcweir#endif 93