summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/ucb/GlobalTransferCommandArgument.idl
blob: e7b2125a4322bbb7253afcb2de2e893a2cb0c238 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_ucb_GlobalTransferCommandArgument_idl__
#define __com_sun_star_ucb_GlobalTransferCommandArgument_idl__

#include <com/sun/star/ucb/TransferCommandOperation.idl>


module com { module sun { module star { module ucb {

/** This struct contains information needed to transfer objects from one
    location to another.
*/
published struct GlobalTransferCommandArgument
{
    /** contains the action to perform ( COPY, MOVE, LINK ).
      */
    TransferCommandOperation Operation;

    /** contains the URL of the source object.
      */
    string SourceURL;

    /** contains the URL of the target folder.
      */
    string TargetURL;

    /** contains the title of the transferred object, if it is different
        from the original one.

        <p>If this field is filled, for example, a file will be renamed
        while it is being transferred.
      */
    string NewTitle;

    /** describes how to act in case of title clashes while transferring
        the data.

        <p>A title clash for instance occurs, if a file named "foo.txt" is
        to be transferred to a folder already containing another file named
        "foo.txt". Refer to NameClash for possible values for
        this field.
    */
    long NameClash;
};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */