offapi/com/sun/star/inspection/InteractiveSelectionResult.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 #ifndef __com_sun_star_inspection_InteractiveSelectionResult_idl__
  20 #define __com_sun_star_inspection_InteractiveSelectionResult_idl__
  21
  22 module com {  module sun {  module star {  module inspection {
  23
  24 /** describes possible results of an interactive selection of a property value
  25     in an object inspector
  26
  27     @see XPropertyHandler::onInteractivePropertySelection
  28
  29     @since OOo 2.0.3
  30 */
  31 enum InteractiveSelectionResult
  32 {
  33     /** The interactive selection of a property value was canceled.
  34     */
  35     Cancelled,
  36
  37     /** The interactive selection of a property value succeeded, and the
  38         new property value chosen by the user has already been set at the
  39         inspected component.
  40     */
  41     Success,
  42
  43     /** The interactive selection of a property value succeeded, a new
  44         property value has been obtained, but not yet set at the inspected
  45         component.
  46
  47         <p>In this case, the obtained value is passed to the caller of
  48         XPropertyHandler::onInteractivePropertySelection(), which is
  49         responsible for forwarding this value to the inspected component.</p>
  50     */
  51     ObtainedValue,
  52
  53     /** The interactive selection of a property value is still pending.
  54
  55         <p>This is usually used when this selection involves non-modal user interface.</p>
  56     */
  57     Pending
  58 };
  59
  60
  61 }; }; }; };
  62
  63 #endif
  64
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */