/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: DispatchStatement.idl,v $
 *
 *  $Revision: 1.9 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 00:59:10 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 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
 *
 ************************************************************************/
#ifndef __com_sun_star_frame_DispatchStatement_idl__
#define __com_sun_star_frame_DispatchStatement_idl__

#ifndef __com_sun_star_beans_PropertyValue_idl__
#include <com/sun/star/beans/PropertyValue.idl>
#endif

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

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

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

// DocMerge from xml: struct com::sun::star::frame::DispatchStatement
/** represents a dispatch statement from a recorded macro

    @since OOo 1.1.2
 */
published struct DispatchStatement
{
    // DocMerge from xml: field com::sun::star::frame::DispatchStatement::aCommand
        /** specifies the dispatch command

            <p>
            That means the <var>URL</var> parameter of a corresponding <member>XDispatchProvider::queryDispatch()</member> request.
            </p>
         */
    string aCommand;

    //-------------------------------------------------------------------------


        // DocMerge from xml: field com::sun::star::frame::DispatchStatement::aTarget
        /** specifies the frame target

            <p>
            That means the <var>TargetFrameName</var> parameter of a corresponding <member>XDispatchProvider::queryDispatch()</member> request.
            </p>
         */
        string aTarget;

        //-------------------------------------------------------------------------

        // DocMerge from xml: field com::sun::star::frame::DispatchStatement::aArgs
        /** specifies the dispatch command arguments

            <p>
            That means the <var>Arguments</var> parameter of a corresponding <member>XDispatch::dispatch()</member> request.
            </p>
         */
        sequence < com::sun::star::beans::PropertyValue > aArgs;

        //-------------------------------------------------------------------------

        // DocMerge from xml: field com::sun::star::frame::DispatchStatement::nFlags
        /** specifies the optional search flags
            <p>
            That means the <var>SearchFlags</var> parameter of a corresponding <member>XDispatchProvider::queryDispatch()</member> request.
            </p>
         */
        long nFlags;

        //-------------------------------------------------------------------------

        // DocMerge from xml: field com::sun::star::frame::DispatchStatement::bIsComment
        /** specifies if this statement should be recorded as commented out or not

            @see XDispatchRecorder::recordDispatchAsComment()
         */
        boolean bIsComment;

        //-------------------------------------------------------------------------
};

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

}; }; }; };

#endif
