udkapi/com/sun/star/beans/Defaulted.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: Defaulted.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_beans_Defaulted_idl__
  31 #define __com_sun_star_beans_Defaulted_idl__
  32
  33 module com {  module sun {  module star {  module beans {
  34
  35 /**
  36    A value of a given type that can be defaulted.
  37
  38    <p>This structure is used as the type of interface attributes corresponding
  39    to instances of <type scopye="com::sun::star::beans">Property</type> that
  40    have the <const
  41    scope="com::sun::star::beans">PropertyAttribute::MAYBEDEFAULT</const>.</p>
  42  */
  43 struct Defaulted<T> {
  44     /**
  45        The underlying value of this structure instance.
  46
  47        <p>Even if this structure instance is defaulted, this member should
  48        contain a useful value.  If there is no useful value for a defaulted
  49        structure instance, <type scope="com::sun::star::beans">Optional</type>
  50        can be used as the type of this member.</p>
  51      */
  52     T Value;
  53
  54     /**
  55        Marks this structure instance as defaulted.
  56      */
  57     boolean IsDefaulted;
  58 };
  59
  60 }; }; }; };
  61
  62 #endif