xref: /aoo41x/main/udkapi/com/sun/star/beans/Optional.idl (revision 408a4873)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_beans_Optional_idl__
24#define __com_sun_star_beans_Optional_idl__
25
26module com {  module sun {  module star {  module beans {
27
28/**
29   An optional value of a given type.
30
31   <p>This structure is used as the type of interface attributes corresponding
32   to instances of <type scopye="com::sun::star::beans">Property</type> that
33   have the <const
34   scope="com::sun::star::beans">PropertyAttribute::MAYBEVOID</const>.  It might
35   also be useful in other situations, for example as the return type of an
36   interface method.</p>
37 */
38published struct Optional<T> {
39    /**
40       Marks this structure instance as having an actual value.
41     */
42    boolean IsPresent;
43
44    /**
45       The actual value of this structure instance.
46
47       <p>If no actual value is present, a producer of such a structure instance
48       should leave this member defaulted, and a consumer of such a structure
49       instance should ignore the specific value stored in this member.</p>
50     */
51    T Value;
52};
53
54}; }; }; };
55
56#endif
57