1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_frame_DispatchDescriptor_idl__
24#define __com_sun_star_frame_DispatchDescriptor_idl__
25
26#ifndef __com_sun_star_util_URL_idl__
27#include <com/sun/star/util/URL.idl>
28#endif
29
30
31//=============================================================================
32
33 module com {  module sun {  module star {  module frame {
34
35//=============================================================================
36/** describes a feature to be retrieved by a URL that
37    has to be loaded into a specified frame
38
39    <p>
40    For a normal dispatch calls all needed parameters are seperated.
41    For optimized remote functionality <member>XDispatch::queryDispatches()</member>
42    it's neccessary to pack these parameters in a flat structure wich can be used
43    in a simple manner.
44    </p>
45
46    @see XDispatchProvider::queryDispatches()
47 */
48published struct DispatchDescriptor
49{
50	//-------------------------------------------------------------------------
51    /** specifies the URL of the resource/function
52
53        <p>
54        Must be a full parsed URL. Use service <type scope="com::sun::star::util">URLTransformer</type>
55        for that.
56        </p>
57
58        @see com::sun::star::util::URLTransformer
59	 */
60	com::sun::star::util::URL FeatureURL;
61
62	//-------------------------------------------------------------------------
63    /** name of the target frame
64
65        <p>
66        Special targets (e.g. "_blank", "_self") or realy existing target names can be used.
67        </p>
68
69        @see XDispatchProvider::queryDispatch()
70	 */
71	string FrameName;
72
73	//-------------------------------------------------------------------------
74    /** describes how the target frame is to be searched
75
76        <p>
77        This optional parameter is used if <var>FrameName</var> isn't a special target only.
78        </p>
79
80        @see FrameSearchFlag
81	 */
82	long SearchFlags;
83};
84
85//=============================================================================
86
87}; }; }; };
88
89#endif
90