offapi/com/sun/star/ucb/InsertCommandArgument.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_ucb_InsertCommandArgument_idl__
  28 #define __com_sun_star_ucb_InsertCommandArgument_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_io_XInputStream_idl__
  35 #include <com/sun/star/io/XInputStream.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module ucb {
  41
  42 //=============================================================================
  43 /** The argument for the command "insert".
  44
  45     @see XCommandProcessor
  46 */
  47 published struct InsertCommandArgument
  48 {
  49     //-------------------------------------------------------------------------
  50     /** A stream containing document data.
  51
  52         <p>This member can be left blank, if no (new) document data shall be
  53         written by the implementation of the "insert" command.
  54     */
  55     com::sun::star::io::XInputStream Data;
  56
  57     //-------------------------------------------------------------------------
  58     /** A flag indicating whether a possibly existing content (and its data)
  59         shall be overwritten.
  60
  61         <p>Implementations that are not able to detect whether there are
  62         previous data may ignore this parameter and will always write the
  63         new data.
  64     */
  65     boolean ReplaceExisting;
  66 };
  67
  68 //=============================================================================
  69
  70 }; }; }; };
  71
  72 #endif