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