offapi/com/sun/star/ucb/GlobalTransferCommandArgument.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: GlobalTransferCommandArgument.idl,v $
  10  * $Revision: 1.4 $
  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_GlobalTransferCommandArgument_idl__
  31 #define __com_sun_star_ucb_GlobalTransferCommandArgument_idl__
  32
  33 #ifndef __com_sun_star_ucb_TransferCommandOperation_idl__
  34 #include <com/sun/star/ucb/TransferCommandOperation.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com { module sun { module star { module ucb {
  40
  41 //=============================================================================
  42 /** This struct contains information needed to transfer objects from one
  43     location to another.
  44 */
  45 published struct GlobalTransferCommandArgument
  46 {
  47     //-------------------------------------------------------------------------
  48     /** contains the action to perform ( COPY, MOVE, LINK ).
  49       */
  50     TransferCommandOperation Operation;
  51
  52     //-------------------------------------------------------------------------
  53     /** contains the URL of the source object.
  54       */
  55     string SourceURL;
  56
  57     //-------------------------------------------------------------------------
  58     /** contains the URL of the target folder.
  59       */
  60     string TargetURL;
  61
  62     //-------------------------------------------------------------------------
  63     /** contains the title of the transferred object, if it is different
  64         from the original one.
  65
  66         <p>If this field is filled, for example, a file will be renamed
  67         while it is being transferred.
  68       */
  69     string NewTitle;
  70
  71     //-------------------------------------------------------------------------
  72     /** describes how to act in case of title clashes while transferring
  73         the data.
  74
  75         <p>A title clash for instance occurs, if a file named "foo.txt" is
  76         to be transferred to a folder already containing another file named
  77         "foo.txt". Refer to <type>NameClash</type> for possible values for
  78         this field.
  79     */
  80     long NameClash;
  81 };
  82
  83 //=============================================================================
  84
  85 }; }; }; };
  86
  87 #endif