xref: /trunk/main/offapi/com/sun/star/ucb/GlobalTransferCommandArgument.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_ucb_GlobalTransferCommandArgument_idl__
#define __com_sun_star_ucb_GlobalTransferCommandArgument_idl__

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

//=============================================================================

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 <type>NameClash</type> for possible values for
        this field.
    */
    long NameClash;
};

//=============================================================================

}; }; }; };

#endif