summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/beans/Defaulted.idl
blob: dc47fbb85e0147352af71ff1bc0ec9958d036177 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */
#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>
 */
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

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */