offapi/com/sun/star/frame/status/ItemState.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: ItemState.idl,v $
  10  * $Revision: 1.5 $
  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_frame_status_ItemState_idl__
  31 #define __com_sun_star_frame_status_ItemState_idl__
  32
  33
  34 //=============================================================================
  35
  36 module com {  module sun {  module star {  module frame { module status {
  37
  38 //=============================================================================
  39
  40 /** these constants describe a state of a <type>ItemStatus</type>.
  41
  42     @see ItemStatus
  43
  44     @since OOo 2.0
  45  */
  46 constants ItemState
  47 {
  48     //-------------------------------------------------------------------------
  49     /** specifies an unknown state.
  50      */
  51     const short unknown        = 0;
  52
  53     //-------------------------------------------------------------------------
  54     /** specifies that the property is currently disabled.
  55      */
  56     const short disabled       = 1;
  57
  58     //-------------------------------------------------------------------------
  59     /** specifies that the property is currently read-only.
  60      */
  61     const short read_only      = 2;
  62
  63     //-------------------------------------------------------------------------
  64     /** specifies that the property is currently in a don't care state.
  65
  66         <p>
  67         This is normally used if a selection provides more than one state
  68         for a property at the same time.
  69         </p>
  70      */
  71     const short dont_care      = 16;
  72
  73     //-------------------------------------------------------------------------
  74     /** specifies that the property is currently in a default state.
  75     */
  76     const short default_value  = 32;
  77
  78     //-------------------------------------------------------------------------
  79     /** specifies that the property is currently in a set state.
  80     */
  81     const short set            = 64;
  82 };
  83
  84 //=============================================================================
  85
  86 }; }; }; }; };
  87
  88 #endif