offapi/com/sun/star/ucb/XInteractionSupplyName.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: XInteractionSupplyName.idl,v $
  10  * $Revision: 1.4 $
  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_XInteractionSupplyName_idl__
  31 #define __com_sun_star_ucb_XInteractionSupplyName_idl__
  32
  33 #ifndef __com_sun_star_task_XInteractionContinuation_idl__
  34 #include <com/sun/star/task/XInteractionContinuation.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com { module sun { module star { module ucb {
  40
  41 //=============================================================================
  42 /** is an interaction continuation used to hand back a new name for something.
  43
  44     <p>For example, this continuation can be selected when handling a
  45     <type>NameClashResolveRequest</type> in order to supply a new name
  46     for a clashing resource.
  47
  48      @version  1.0
  49      @author   Kai Sommerfeld
  50 */
  51 published interface XInteractionSupplyName : com::sun::star::task::XInteractionContinuation
  52 {
  53     //-------------------------------------------------------------------------
  54     /** sets the name to supply.
  55
  56         @parem Name
  57         contains the name to supply.
  58     */
  59     void setName( [in] string Name );
  60 };
  61
  62 //=============================================================================
  63
  64 }; }; }; };
  65
  66 #endif