offapi/com/sun/star/inspection/InteractiveSelectionResult.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: InteractiveSelectionResult.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_inspection_InteractiveSelectionResult_idl__
  31 #define __com_sun_star_inspection_InteractiveSelectionResult_idl__
  32
  33 //=============================================================================
  34 module com {  module sun {  module star {  module inspection {
  35
  36 //-----------------------------------------------------------------------------
  37 /** describes possible results of an interactive selection of a property value
  38     in an object inspector
  39
  40     @see XPropertyHandler::onInteractivePropertySelection
  41
  42     @since OOo 2.0.3
  43 */
  44 enum InteractiveSelectionResult
  45 {
  46     /** The interactive selection of a property value was cancelled.
  47     */
  48     Cancelled,
  49
  50     /** The interactive selection of a property value succeeded, and the
  51         new property value chosen by the user has already been set at the
  52         inspected component.
  53     */
  54     Success,
  55
  56     /** The interactive selection of a property value succeeded, a new
  57         property value has been obtained, but not yet set at the inspected
  58         component.
  59
  60         <p>In this case, the obtained value is passed to the caller of
  61         <member>XPropertyHandler::onInteractivePropertySelection<member>, which is
  62         responsible for forwarding this value to the inspected component.</p>
  63     */
  64     ObtainedValue,
  65
  66     /** The interactive selection of a property value is still pending.
  67
  68         <p>This is usually used when this selection involves non-modal user interface.</p>
  69     */
  70     Pending
  71 };
  72
  73 //=============================================================================
  74
  75 }; }; }; };
  76
  77 #endif
  78
  79