xref: /AOO41X/main/offapi/com/sun/star/ucb/InsertCommandArgument.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_ucb_InsertCommandArgument_idl__
24#define __com_sun_star_ucb_InsertCommandArgument_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_io_XInputStream_idl__
31#include <com/sun/star/io/XInputStream.idl>
32#endif
33
34//=============================================================================
35
36module com { module sun { module star { module ucb {
37
38//=============================================================================
39/** The argument for the command "insert".
40
41    @see XCommandProcessor
42*/
43published struct InsertCommandArgument
44{
45    //-------------------------------------------------------------------------
46    /** A stream containing document data.
47
48        <p>This member can be left blank, if no (new) document data shall be
49        written by the implementation of the "insert" command.
50    */
51    com::sun::star::io::XInputStream Data;
52
53    //-------------------------------------------------------------------------
54    /** A flag indicating whether a possibly existing content (and its data)
55        shall be overwritten.
56
57        <p>Implementations that are not able to detect whether there are
58        previous data may ignore this parameter and will always write the
59        new data.
60    */
61    boolean ReplaceExisting;
62};
63
64//=============================================================================
65
66}; }; }; };
67
68#endif
69