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
  20
  21
  22 module com { module sun { module star { module ucb {
  23
  24 /** contains information needed to transfer objects from one location to another.
  25
  26     <p>The transfer command is always called on the target folder. For a
  27     details description of the transfer command refer to the documentation
  28     of service Content.
  29 */
  30 published struct TransferInfo
  31 {
  32     /** contains the flags describing whether the data shall be moved
  33         instead of copied.
  34     */
  35     boolean MoveData;
  36
  37     /** contains the URL of the source of the action (e.g. the URL of a
  38         file to move).
  39     */
  40     string SourceURL;
  41
  42     /** contains the title of the transferred object, if it is different
  43         from the original one.
  44
  45         <p>If this field is filled, for example, a file will be renamed
  46         while it is being transferred.</p>
  47     */
  48     string NewTitle;
  49
  50     /** describes how to act in case of title clashes while transferring
  51         the data.
  52
  53         <p>A title clash for instance occurs, if a file named "foo.txt" is
  54         to be transferred to a folder already containing another file named
  55         "foo.txt".
  56
  57         <p>The value can be one of the NameClash constants.
  58
  59         <p>Implementations that are not able to detect whether there is a
  60         clashing resource may ignore NameClash::ERROR and
  61         NameClash::RENAME always write the new data.
  62     */
  63     long NameClash;
  64
  65 };
  66
  67
  68 }; }; }; };
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */