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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ucb_GlobalTransferCommandArgument_idl__
  20 #define __com_sun_star_ucb_GlobalTransferCommandArgument_idl__
  21
  22 #include <com/sun/star/ucb/TransferCommandOperation.idl>
  23
  24
  25 module com { module sun { module star { module ucb {
  26
  27 /** This struct contains information needed to transfer objects from one
  28     location to another.
  29 */
  30 published struct GlobalTransferCommandArgument
  31 {
  32     /** contains the action to perform ( COPY, MOVE, LINK ).
  33       */
  34     TransferCommandOperation Operation;
  35
  36     /** contains the URL of the source object.
  37       */
  38     string SourceURL;
  39
  40     /** contains the URL of the target folder.
  41       */
  42     string TargetURL;
  43
  44     /** contains the title of the transferred object, if it is different
  45         from the original one.
  46
  47         <p>If this field is filled, for example, a file will be renamed
  48         while it is being transferred.
  49       */
  50     string NewTitle;
  51
  52     /** describes how to act in case of title clashes while transferring
  53         the data.
  54
  55         <p>A title clash for instance occurs, if a file named "foo.txt" is
  56         to be transferred to a folder already containing another file named
  57         "foo.txt". Refer to NameClash for possible values for
  58         this field.
  59     */
  60     long NameClash;
  61 };
  62
  63
  64 }; }; }; };
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */