offapi/com/sun/star/frame/status/ItemState.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
  20
  21
  22 module com {  module sun {  module star {  module frame { module status {
  23
  24
  25 /** these constants describe a state of an ItemStatus.
  26
  27     @see ItemStatus
  28
  29     @since OOo 2.0
  30  */
  31 constants ItemState
  32 {
  33     /** specifies an unknown state.
  34      */
  35     const short UNKNOWN        = 0;
  36
  37     /** specifies that the property is currently disabled.
  38      */
  39     const short DISABLED       = 1;
  40
  41     /** specifies that the property is currently read-only.
  42      *
  43      * Deprecated: There is no equivalent in SfxItemState
  44      * anymore due to not being used, so remove for simplification
  45      * reasons and to prepare rework of Item/ItemSet/ItemPool stuff.
  46      *
  47      * There are only three usages of com::sun::star::frame::status::ItemState
  48      * in the code which all set the internal SfxItem to SfxVoidItem when
  49      * triggered, which is equivalent to state SfxItemState::DISABLED (see e.g.
  50      * SfxItemSet::GetItemState), so READ_ONLY gets not used in internal
  51      * handling, even when eventually existing UNO API usages hand it over the
  52      * office.
  53      */
  54     const short READ_ONLY      = 2;
  55
  56     /** specifies that the property is currently in a don't care state.
  57
  58         <p>
  59         This is normally used if a selection provides more than one state
  60         for a property at the same time.
  61         </p>
  62      */
  63     const short DONT_CARE      = 16;
  64
  65     /** specifies that the property is currently in a default state.
  66     */
  67     const short DEFAULT_VALUE  = 32;
  68
  69     /** specifies that the property is currently in a set state.
  70     */
  71     const short SET            = 64;
  72 };
  73
  74
  75 }; }; }; }; };
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */