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