offapi/com/sun/star/ucb/OpenCommandArgument.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: OpenCommandArgument.idl,v $
  10  * $Revision: 1.13 $
  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_ucb_OpenCommandArgument_idl__
  31 #define __com_sun_star_ucb_OpenCommandArgument_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_Property_idl__
  38 #include <com/sun/star/beans/Property.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com { module sun { module star { module ucb {
  44
  45 //=============================================================================
  46 /** The argument for commands like "open", "update", and "synchronize".
  47
  48     @see XCommandProcessor
  49 */
  50 published struct OpenCommandArgument
  51 {
  52     //-------------------------------------------------------------------------
  53     /** A mode.
  54
  55         <p>The value can be one of the <type>OpenMode</type> constants.
  56     */
  57     long Mode;
  58
  59     //-------------------------------------------------------------------------
  60     /** The command's priority, in the range <code>0</code> (highest) to
  61         <code>65535</code> (lowest).
  62     */
  63     long Priority;
  64
  65     //-------------------------------------------------------------------------
  66     /** The data sink to write the contents into (supporting either
  67         <type scope="com::sun::star::io">XActiveDataSink</type>,
  68         <type scope="com::sun::star::io">XOutputStream</type> or
  69         <type scope="com::sun::star::io">XActiveDataStreamer</type>).
  70
  71         <p>XActiveDataSink and XOutputStream give the caller read-only
  72         access to the contents. XActiveDataStreamer offers both read and
  73         write access to the contents.
  74
  75         <p>If an XActiveDataSink is supplied, the implementation of the command
  76         needs to provide an implementation of an object implementing the
  77         interface <type scope="com::sun::star::io">XInputStream</type>. It is
  78         highly recommended that this object also implements the interface
  79         <type scope="com::sun::star::io">XSeekable</type>, if this can be done
  80         without wasting resources (i.e. allocating huge memory buffers).
  81         The     implementation object has to be supplied to the data sink.
  82     */
  83     com::sun::star::uno::XInterface Sink;
  84
  85     //-------------------------------------------------------------------------
  86     /** The properties, for that the values shall be provided by the
  87         <type>DynamicResultSet</type> returned by the command).
  88     */
  89     sequence< com::sun::star::beans::Property > Properties;
  90 };
  91
  92 //=============================================================================
  93
  94 }; }; }; };
  95
  96 #endif