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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: NameClash.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_ucb_NameClash_idl__
  31 #define __com_sun_star_ucb_NameClash_idl__
  32
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module ucb {
  37
  38 //=============================================================================
  39 /** These are the possible values for <member>TransferInfo::NameClash</member>.
  40 */
  41 published constants NameClash
  42 {
  43     //-------------------------------------------------------------------------
  44     /** Means to set an error and cancel the operation.
  45     */
  46     const long ERROR = 0;
  47
  48     //-------------------------------------------------------------------------
  49     /** Means to overwrite the object in the target folder with the object to
  50         transfer.
  51     */
  52     const long OVERWRITE = 1;
  53
  54     //-------------------------------------------------------------------------
  55     /** Means to rename the object to transfer to solve the clash.
  56
  57         <p>The implementation needs to supply and set a suitable new name.
  58     */
  59     const long RENAME = 2;
  60
  61     //-------------------------------------------------------------------------
  62     /** Deprecated. Do not use!
  63
  64         @deprecated
  65     */
  66     const long KEEP = 3;
  67
  68     //-------------------------------------------------------------------------
  69     /** Means to use a <type>NameClashResolveRequest</type> in order to solve
  70         the name clash.
  71
  72         @see com::sun::star::task::XInteractionHandler
  73     */
  74     const long ASK = 4;
  75 };
  76
  77 //=============================================================================
  78
  79 }; }; }; };
  80
  81 #endif