offapi/com/sun/star/ucb/PropertyValueState.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: PropertyValueState.idl,v $
  10  * $Revision: 1.7 $
  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_PropertyValueState_idl__
  31 #define __com_sun_star_ucb_PropertyValueState_idl__
  32
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module ucb {
  37
  38 //=============================================================================
  39 /** defines the states of a property value in the process of obtaining the
  40     value (asynchronously).
  41
  42     @see PropertyValueInfo
  43 */
  44 published enum PropertyValueState
  45 {
  46     //-------------------------------------------------------------------------
  47     /** The property value was not obtained yet.
  48     */
  49     UNPROCESSED,
  50
  51     //-------------------------------------------------------------------------
  52     /** The value was obtained.
  53
  54         <p>The value is stored in <member>PropertyValueInfo::Value</member>.
  55     */
  56     PROCESSED,
  57
  58     //-------------------------------------------------------------------------
  59     /** The given property name/handle is invalid.
  60     */
  61     INVALID_NAME,
  62
  63     //-------------------------------------------------------------------------
  64     /** The given property type is invalid.
  65     */
  66     INVALID_TYPE
  67
  68 };
  69
  70 //=============================================================================
  71
  72 }; }; }; };
  73
  74 #endif