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 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_frame_status_ItemState_idl__
  28 #define __com_sun_star_frame_status_ItemState_idl__
  29
  30
  31 //=============================================================================
  32
  33 module com {  module sun {  module star {  module frame { module status {
  34
  35 //=============================================================================
  36
  37 /** these constants describe a state of a <type>ItemStatus</type>.
  38
  39     @see ItemStatus
  40
  41     @since OOo 2.0
  42  */
  43 constants ItemState
  44 {
  45     //-------------------------------------------------------------------------
  46     /** specifies an unknown state.
  47      */
  48     const short unknown        = 0;
  49
  50     //-------------------------------------------------------------------------
  51     /** specifies that the property is currently disabled.
  52      */
  53     const short disabled       = 1;
  54
  55     //-------------------------------------------------------------------------
  56     /** specifies that the property is currently read-only.
  57      */
  58     const short read_only      = 2;
  59
  60     //-------------------------------------------------------------------------
  61     /** specifies that the property is currently in a don't care state.
  62
  63         <p>
  64         This is normally used if a selection provides more than one state
  65         for a property at the same time.
  66         </p>
  67      */
  68     const short dont_care      = 16;
  69
  70     //-------------------------------------------------------------------------
  71     /** specifies that the property is currently in a default state.
  72     */
  73     const short default_value  = 32;
  74
  75     //-------------------------------------------------------------------------
  76     /** specifies that the property is currently in a set state.
  77     */
  78     const short set            = 64;
  79 };
  80
  81 //=============================================================================
  82
  83 }; }; }; }; };
  84
  85 #endif