diff options
Diffstat (limited to 'offapi/com/sun/star/frame/DispatchStatement.idl')
-rw-r--r-- | offapi/com/sun/star/frame/DispatchStatement.idl | 137 |
1 files changed, 137 insertions, 0 deletions
diff --git a/offapi/com/sun/star/frame/DispatchStatement.idl b/offapi/com/sun/star/frame/DispatchStatement.idl new file mode 100644 index 000000000..4089c7ba5 --- /dev/null +++ b/offapi/com/sun/star/frame/DispatchStatement.idl @@ -0,0 +1,137 @@ +/************************************************************************* + * + * $RCSfile: DispatchStatement.idl,v $ + * + * $Revision: 1.5 $ + * + * last change: $Author: hr $ $Date: 2003-03-26 13:54:27 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 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 + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#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 + */ +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 |