1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_frame_DispatchStatement_idl__
28#define __com_sun_star_frame_DispatchStatement_idl__
29
30#ifndef __com_sun_star_beans_PropertyValue_idl__
31#include <com/sun/star/beans/PropertyValue.idl>
32#endif
33
34//=============================================================================
35
36 module com {  module sun {  module star {  module frame {
37
38//=============================================================================
39
40// DocMerge from xml: struct com::sun::star::frame::DispatchStatement
41/** represents a dispatch statement from a recorded macro
42
43    @since OOo 1.1.2
44 */
45published struct DispatchStatement
46{
47	// DocMerge from xml: field com::sun::star::frame::DispatchStatement::aCommand
48        /** specifies the dispatch command
49
50            <p>
51            That means the <var>URL</var> parameter of a corresponding <member>XDispatchProvider::queryDispatch()</member> request.
52            </p>
53         */
54	string aCommand;
55
56	//-------------------------------------------------------------------------
57
58
59        // DocMerge from xml: field com::sun::star::frame::DispatchStatement::aTarget
60        /** specifies the frame target
61
62            <p>
63            That means the <var>TargetFrameName</var> parameter of a corresponding <member>XDispatchProvider::queryDispatch()</member> request.
64            </p>
65         */
66        string aTarget;
67
68        //-------------------------------------------------------------------------
69
70        // DocMerge from xml: field com::sun::star::frame::DispatchStatement::aArgs
71        /** specifies the dispatch command arguments
72
73            <p>
74            That means the <var>Arguments</var> parameter of a corresponding <member>XDispatch::dispatch()</member> request.
75            </p>
76         */
77        sequence < com::sun::star::beans::PropertyValue > aArgs;
78
79        //-------------------------------------------------------------------------
80
81        // DocMerge from xml: field com::sun::star::frame::DispatchStatement::nFlags
82        /** specifies the optional search flags
83            <p>
84            That means the <var>SearchFlags</var> parameter of a corresponding <member>XDispatchProvider::queryDispatch()</member> request.
85            </p>
86         */
87        long nFlags;
88
89        //-------------------------------------------------------------------------
90
91        // DocMerge from xml: field com::sun::star::frame::DispatchStatement::bIsComment
92        /** specifies if this statement should be recorded as commented out or not
93
94            @see XDispatchRecorder::recordDispatchAsComment()
95         */
96        boolean bIsComment;
97
98        //-------------------------------------------------------------------------
99};
100
101//=============================================================================
102
103}; }; }; };
104
105#endif
106