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