1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_ucb_OpenCommandArgument_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_ucb_OpenCommandArgument_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_beans_Property_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/beans/Property.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski//============================================================================= 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module ucb { 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski//============================================================================= 39*b1cdbd2cSJim Jagielski/** The argument for commands like "open", "update", and "synchronize". 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski @see XCommandProcessor 42*b1cdbd2cSJim Jagielski*/ 43*b1cdbd2cSJim Jagielskipublished struct OpenCommandArgument 44*b1cdbd2cSJim Jagielski{ 45*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 46*b1cdbd2cSJim Jagielski /** A mode. 47*b1cdbd2cSJim Jagielski 48*b1cdbd2cSJim Jagielski <p>The value can be one of the <type>OpenMode</type> constants. 49*b1cdbd2cSJim Jagielski */ 50*b1cdbd2cSJim Jagielski long Mode; 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 53*b1cdbd2cSJim Jagielski /** The command's priority, in the range <code>0</code> (highest) to 54*b1cdbd2cSJim Jagielski <code>65535</code> (lowest). 55*b1cdbd2cSJim Jagielski */ 56*b1cdbd2cSJim Jagielski long Priority; 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 59*b1cdbd2cSJim Jagielski /** The data sink to write the contents into (supporting either 60*b1cdbd2cSJim Jagielski <type scope="com::sun::star::io">XActiveDataSink</type>, 61*b1cdbd2cSJim Jagielski <type scope="com::sun::star::io">XOutputStream</type> or 62*b1cdbd2cSJim Jagielski <type scope="com::sun::star::io">XActiveDataStreamer</type>). 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski <p>XActiveDataSink and XOutputStream give the caller read-only 65*b1cdbd2cSJim Jagielski access to the contents. XActiveDataStreamer offers both read and 66*b1cdbd2cSJim Jagielski write access to the contents. 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski <p>If an XActiveDataSink is supplied, the implementation of the command 69*b1cdbd2cSJim Jagielski needs to provide an implementation of an object implementing the 70*b1cdbd2cSJim Jagielski interface <type scope="com::sun::star::io">XInputStream</type>. It is 71*b1cdbd2cSJim Jagielski highly recommended that this object also implements the interface 72*b1cdbd2cSJim Jagielski <type scope="com::sun::star::io">XSeekable</type>, if this can be done 73*b1cdbd2cSJim Jagielski without wasting resources (i.e. allocating huge memory buffers). 74*b1cdbd2cSJim Jagielski The implementation object has to be supplied to the data sink. 75*b1cdbd2cSJim Jagielski */ 76*b1cdbd2cSJim Jagielski com::sun::star::uno::XInterface Sink; 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 79*b1cdbd2cSJim Jagielski /** The properties, for that the values shall be provided by the 80*b1cdbd2cSJim Jagielski <type>DynamicResultSet</type> returned by the command). 81*b1cdbd2cSJim Jagielski */ 82*b1cdbd2cSJim Jagielski sequence< com::sun::star::beans::Property > Properties; 83*b1cdbd2cSJim Jagielski}; 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski//============================================================================= 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski}; }; }; }; 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski#endif 90