xref: /aoo41x/main/udkapi/com/sun/star/beans/Optional.idl (revision cdf0e10c)
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_Optional_idl__
28#define __com_sun_star_beans_Optional_idl__
29
30module com {  module sun {  module star {  module beans {
31
32/**
33   An optional value of a given type.
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::MAYBEVOID</const>.  It might
39   also be useful in other situations, for example as the return type of an
40   interface method.</p>
41 */
42published struct Optional<T> {
43    /**
44       Marks this structure instance as having an actual value.
45     */
46    boolean IsPresent;
47
48    /**
49       The actual value of this structure instance.
50
51       <p>If no actual value is present, a producer of such a structure instance
52       should leave this member defaulted, and a consumer of such a structure
53       instance should ignore the specific value stored in this member.</p>
54     */
55    T Value;
56};
57
58}; }; }; };
59
60#endif
61