offapi/com/sun/star/form/runtime/FeatureState.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: FeatureState.idl,v $
  10  * $Revision: 1.4 $
  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_form_runtime_FeatureState_idl__
  31 #define __com_sun_star_form_runtime_FeatureState_idl__
  32
  33 //=============================================================================
  34
  35 module com { module sun { module star { module form { module runtime {
  36
  37 //=============================================================================
  38
  39 /** encapsulates the state of a FormFeature
  40
  41     @see XFormOperations
  42
  43     @since OpenOffice.org 2.2.0
  44  */
  45 struct FeatureState
  46 {
  47     /** determines whether the respective feature is enabled (i.e. available)
  48         in the current state of the form.
  49     */
  50     boolean Enabled;
  51
  52     /** determines the state of the feature. The concrete semantics depends
  53         on the concrete <type>FormFeature</type>.
  54     */
  55     any State;
  56 };
  57
  58 //=============================================================================
  59
  60 }; }; }; }; };
  61
  62 //=============================================================================
  63
  64 #endif
  65