/*************************************************************************
 *
 *  $RCSfile: DispatchDescriptor.idl,v $
 *
 *  $Revision: 1.4.16.2 $
 *
 *  last change: $Author: mi $ $Date: 2003/01/21 17:43:50 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_frame_DispatchDescriptor_idl__
#define __com_sun_star_frame_DispatchDescriptor_idl__

#ifndef __com_sun_star_util_URL_idl__
#include <com/sun/star/util/URL.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module frame {

//=============================================================================
/** describes a feature to be retrieved by a URL that
    has to be loaded into a specified frame

    <p>
    For a normal dispatch calls all needed parameters are seperated.
    For optimized remote functionality <member>XDispatch::queryDispatches()</member>
    it's neccessary to pack these parameters in a flat structure wich can be used
    in a simple manner.
    </p>

    @see XDispatchProvider::queryDispatches()
 */
struct DispatchDescriptor
{
	//-------------------------------------------------------------------------
    /** specifies the URL of the resource/function

        <p>
        Must be a full parsed URL. Use service <type scope="com::sun::star::util">URLTransformer</type>
        for that.
        </p>

        @see com::sun::star::util::URLTransformer
	 */
	com::sun::star::util::URL FeatureURL;

	//-------------------------------------------------------------------------
    /** name of the target frame

        <p>
        Special targets (e.g. "_blank", "_self") or realy existing target names can be used.
        </p>

        @see XDispatchProvider::queryDispatch()
	 */
	string FrameName;

	//-------------------------------------------------------------------------
    /** describes how the target frame is to be searched

        <p>
        This optional parameter is used if <var>FrameName</var> isn't a special target only.
        </p>

        @see FrameSearchFlag
	 */
	long SearchFlags;
};

//=============================================================================

}; }; }; };

#endif
