offapi/com/sun/star/ucb/InsertCommandArgument.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: InsertCommandArgument.idl,v $
  10  * $Revision: 1.7 $
  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_InsertCommandArgument_idl__
  31 #define __com_sun_star_ucb_InsertCommandArgument_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_io_XInputStream_idl__
  38 #include <com/sun/star/io/XInputStream.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com { module sun { module star { module ucb {
  44
  45 //=============================================================================
  46 /** The argument for the command "insert".
  47
  48     @see XCommandProcessor
  49 */
  50 published struct InsertCommandArgument
  51 {
  52     //-------------------------------------------------------------------------
  53     /** A stream containing document data.
  54
  55         <p>This member can be left blank, if no (new) document data shall be
  56         written by the implementation of the "insert" command.
  57     */
  58     com::sun::star::io::XInputStream Data;
  59
  60     //-------------------------------------------------------------------------
  61     /** A flag indicating whether a possibly existing content (and its data)
  62         shall be overwritten.
  63
  64         <p>Implementations that are not able to detect whether there are
  65         previous data may ignore this parameter and will always write the
  66         new data.
  67     */
  68     boolean ReplaceExisting;
  69 };
  70
  71 //=============================================================================
  72
  73 }; }; }; };
  74
  75 #endif