offapi/com/sun/star/ucb/NameClashResolveRequest.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 #ifndef __com_sun_star_ucb_NameClashResolveRequest_idl__
  21 #define __com_sun_star_ucb_NameClashResolveRequest_idl__
  22
  23 #include <com/sun/star/task/ClassifiedInteractionRequest.idl>
  24
  25
  26
  27 module com { module sun { module star { module ucb {
  28
  29 /** This request is used to indicate a name clash.
  30
  31     <p>For example, when copying a file there might be another file in the
  32     target folder that has the same file name as the source file.
  33
  34     <p>If this exception is passed to an
  35     com::sun::star::task::XInteractionHandler an
  36     XInteractionSupplyName and an
  37     XInteractionReplaceExistingData should be supplied with
  38     the com::sun::star::task::XInteractionRequest. On
  39     return the XInteractionSupplyName, if selected, will contain
  40     a new name supposed to resolve the name clash. The
  41     XInteractionReplaceExistingData will be selected if the
  42     clashing resource shall be overwritten.
  43
  44     @version    1.0
  45     @author     Kai Sommerfeld
  46 */
  47 published exception NameClashResolveRequest : com::sun::star::task::ClassifiedInteractionRequest
  48 {
  49     /** contains the URL of the folder that contains the clashing resource.
  50      */
  51     string TargetFolderURL;
  52
  53     /** contains the clashing name.
  54      */
  55     string ClashingName;
  56
  57     /** contains a proposal for a new new, non-clashing name.
  58         <p>This field may be left empty if the implementation is not able
  59         to suggest a new name.
  60      */
  61     string ProposedNewName;
  62 };
  63
  64
  65 }; }; }; };
  66
  67 #endif
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */