AOO410/main/udkapi/com/sun/star/beans/Defaulted.idl

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/


#ifndef __com_sun_star_beans_Defaulted_idl__
#define __com_sun_star_beans_Defaulted_idl__

module com {  module sun {  module star {  module beans {

/**
   A value of a given type that can be defaulted.

   <p>This structure is used as the type of interface attributes corresponding
   to instances of <type scopye="com::sun::star::beans">Property</type> that
   have the <const
   scope="com::sun::star::beans">PropertyAttribute::MAYBEDEFAULT</const>.</p>
 */
published struct Defaulted<T> {
    /**
       The underlying value of this structure instance.

       <p>Even if this structure instance is defaulted, this member should
       contain a useful value.  If there is no useful value for a defaulted
       structure instance, <type scope="com::sun::star::beans">Optional</type>
       can be used as the type of this member.</p>
     */
    T Value;

    /**
       Marks this structure instance as defaulted.
     */
    boolean IsDefaulted;
};

}; }; }; };

#endif