offapi/com/sun/star/ucb/TransferInfo.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_TransferInfo_idl__
  20 #define __com_sun_star_ucb_TransferInfo_idl__
  21
  22
  23
  24 module com { module sun { module star { module ucb {
  25
  26 /** contains information needed to transfer objects from one location to another.
  27
  28     <p>The transfer command is always called on the target folder. For a
  29     details description of the transfer command refer to the documentation
  30     of service Content.
  31 */
  32 published struct TransferInfo
  33 {
  34     /** contains the flags describing whether the data shall be moved
  35         instead of copied.
  36     */
  37     boolean MoveData;
  38
  39     /** contains the URL of the source of the action (e.g. the URL of a
  40         file to move).
  41     */
  42     string SourceURL;
  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.</p>
  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".
  58
  59         <p>The value can be one of the NameClash constants.
  60
  61         <p>Implementations that are not able to detect whether there is a
  62         clashing resource may ignore NameClash::ERROR and
  63         NameClash::RENAME always write the new data.
  64     */
  65     long NameClash;
  66
  67 };
  68
  69
  70 }; }; }; };
  71
  72 #endif
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */