1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_frame_XDispatchHelper_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_frame_XDispatchHelper_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 31*cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 32*cdf0e10cSrcweir#endif 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir#ifndef __com_sun_star_frame_XDispatchProvider_idl__ 35*cdf0e10cSrcweir#include <com/sun/star/frame/XDispatchProvider.idl> 36*cdf0e10cSrcweir#endif 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir#ifndef __com_sun_star_beans_PropertyValue_idl__ 39*cdf0e10cSrcweir#include <com/sun/star/beans/PropertyValue.idl> 40*cdf0e10cSrcweir#endif 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir//============================================================================= 43*cdf0e10cSrcweir 44*cdf0e10cSrcweir module com { module sun { module star { module frame { 45*cdf0e10cSrcweir 46*cdf0e10cSrcweir//============================================================================= 47*cdf0e10cSrcweir/** provides an easy way to dispatch functions useful at UI level. 48*cdf0e10cSrcweir 49*cdf0e10cSrcweir @see XDispatch 50*cdf0e10cSrcweir 51*cdf0e10cSrcweir @since OOo 1.1.2 52*cdf0e10cSrcweir */ 53*cdf0e10cSrcweirpublished interface XDispatchHelper : com::sun::star::uno::XInterface 54*cdf0e10cSrcweir{ 55*cdf0e10cSrcweir //------------------------------------------------------------------------- 56*cdf0e10cSrcweir /** executes the dispatch. 57*cdf0e10cSrcweir 58*cdf0e10cSrcweir Listeners are not supported here! 59*cdf0e10cSrcweir 60*cdf0e10cSrcweir @param DispatchProvider 61*cdf0e10cSrcweir points to the provider, which should be asked for valid dispatch objects 62*cdf0e10cSrcweir 63*cdf0e10cSrcweir @param URL 64*cdf0e10cSrcweir describes the feature which should be supported by internally used dispatch object 65*cdf0e10cSrcweir 66*cdf0e10cSrcweir @param TargetFrameName 67*cdf0e10cSrcweir specifies the frame which should be the target for this request 68*cdf0e10cSrcweir 69*cdf0e10cSrcweir @param SearchFlags 70*cdf0e10cSrcweir optional search parameter for finding the frame if no special 71*cdf0e10cSrcweir <var>TargetFrameName</var> was used 72*cdf0e10cSrcweir 73*cdf0e10cSrcweir @param Arguments 74*cdf0e10cSrcweir optional arguments for this request 75*cdf0e10cSrcweir They depend on the real implementation of the dispatch object. 76*cdf0e10cSrcweir 77*cdf0e10cSrcweir @return 78*cdf0e10cSrcweir A possible result of the executed internal dispatch. 79*cdf0e10cSrcweir The information behind this <atom>any</atom> depends on the dispatch! 80*cdf0e10cSrcweir 81*cdf0e10cSrcweir @see XDispatch::dispatch() 82*cdf0e10cSrcweir */ 83*cdf0e10cSrcweir 84*cdf0e10cSrcweir any executeDispatch( 85*cdf0e10cSrcweir [in] XDispatchProvider DispatchProvider, 86*cdf0e10cSrcweir [in] string URL, 87*cdf0e10cSrcweir [in] string TargetFrameName, 88*cdf0e10cSrcweir [in] long SearchFlags, 89*cdf0e10cSrcweir [in] sequence< com::sun::star::beans::PropertyValue > Arguments ); 90*cdf0e10cSrcweir}; 91*cdf0e10cSrcweir 92*cdf0e10cSrcweir//============================================================================= 93*cdf0e10cSrcweir 94*cdf0e10cSrcweir}; }; }; }; 95*cdf0e10cSrcweir 96*cdf0e10cSrcweir#endif 97