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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_beans_Defaulted_idl__
  20 #define __com_sun_star_beans_Defaulted_idl__
  21
  22 module com {  module sun {  module star {  module beans {
  23
  24 /**
  25    A value of a given type that can be defaulted.
  26
  27    <p>This structure is used as the type of interface attributes corresponding
  28    to instances of com::sun::star::beans::Property that
  29    have the com::sun::star::beans::PropertyAttribute::MAYBEDEFAULT.</p>
  30  */
  31 struct Defaulted<T> {
  32     /**
  33        The underlying value of this structure instance.
  34
  35        <p>Even if this structure instance is defaulted, this member should
  36        contain a useful value.  If there is no useful value for a defaulted
  37        structure instance, com::sun::star::beans::Optional
  38        can be used as the type of this member.</p>
  39      */
  40     T Value;
  41
  42     /**
  43        Marks this structure instance as defaulted.
  44      */
  45     boolean IsDefaulted;
  46 };
  47
  48 }; }; }; };
  49
  50 #endif
  51
  52 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */