offapi/com/sun/star/frame/DispatchStatement.idl

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