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_DispatchStatement_idl__
24#define __com_sun_star_frame_DispatchStatement_idl__
25
26#ifndef __com_sun_star_beans_PropertyValue_idl__
27#include <com/sun/star/beans/PropertyValue.idl>
28#endif
29
30//=============================================================================
31
32 module com {  module sun {  module star {  module frame {
33
34//=============================================================================
35
36// DocMerge from xml: struct com::sun::star::frame::DispatchStatement
37/** represents a dispatch statement from a recorded macro
38
39    @since OpenOffice 1.1.2
40 */
41published struct DispatchStatement
42{
43	// DocMerge from xml: field com::sun::star::frame::DispatchStatement::aCommand
44        /** specifies the dispatch command
45
46            <p>
47            That means the <var>URL</var> parameter of a corresponding <member>XDispatchProvider::queryDispatch()</member> request.
48            </p>
49         */
50	string aCommand;
51
52	//-------------------------------------------------------------------------
53
54
55        // DocMerge from xml: field com::sun::star::frame::DispatchStatement::aTarget
56        /** specifies the frame target
57
58            <p>
59            That means the <var>TargetFrameName</var> parameter of a corresponding <member>XDispatchProvider::queryDispatch()</member> request.
60            </p>
61         */
62        string aTarget;
63
64        //-------------------------------------------------------------------------
65
66        // DocMerge from xml: field com::sun::star::frame::DispatchStatement::aArgs
67        /** specifies the dispatch command arguments
68
69            <p>
70            That means the <var>Arguments</var> parameter of a corresponding <member>XDispatch::dispatch()</member> request.
71            </p>
72         */
73        sequence < com::sun::star::beans::PropertyValue > aArgs;
74
75        //-------------------------------------------------------------------------
76
77        // DocMerge from xml: field com::sun::star::frame::DispatchStatement::nFlags
78        /** specifies the optional search flags
79            <p>
80            That means the <var>SearchFlags</var> parameter of a corresponding <member>XDispatchProvider::queryDispatch()</member> request.
81            </p>
82         */
83        long nFlags;
84
85        //-------------------------------------------------------------------------
86
87        // DocMerge from xml: field com::sun::star::frame::DispatchStatement::bIsComment
88        /** specifies if this statement should be recorded as commented out or not
89
90            @see XDispatchRecorder::recordDispatchAsComment()
91         */
92        boolean bIsComment;
93
94        //-------------------------------------------------------------------------
95};
96
97//=============================================================================
98
99}; }; }; };
100
101#endif
102