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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XPropertySetInfo.idl,v $
  10  * $Revision: 1.12 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_beans_XPropertySetInfo_idl__
  31 #define __com_sun_star_beans_XPropertySetInfo_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_Property_idl__
  38 #include <com/sun/star/beans/Property.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_beans_UnknownPropertyException_idl__
  42 #include <com/sun/star/beans/UnknownPropertyException.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module beans {
  49
  50 //=============================================================================
  51
  52 /** specifies a set of properties.
  53
  54     <p>There are three kinds of properties:
  55     <ul>
  56         <li>bound properties</li>
  57         <li>constrained properties</li>
  58         <li>free properties</li>
  59     </ul>
  60
  61     <p>The specification only describes the properties, it does not contain
  62     any values.</p>
  63  */
  64 published interface XPropertySetInfo: com::sun::star::uno::XInterface
  65 {
  66     //-------------------------------------------------------------------------
  67
  68     /** @returns
  69             a sequence with all property descriptors which are specified
  70             within this <type>XPropertySetInfo</type>.
  71      */
  72     sequence<com::sun::star::beans::Property> getProperties();
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** @returns
  77             the property with the specified name from the object.
  78
  79         @param aName
  80             specifies the name of the property.
  81
  82         @throws UnknownPropertyException
  83             if the property does not exist.
  84      */
  85     com::sun::star::beans::Property getPropertyByName( [in] string aName )
  86             raises( com::sun::star::beans::UnknownPropertyException );
  87
  88     //-------------------------------------------------------------------------
  89
  90     /** @returns
  91             <TRUE/> if a property with the specified name exist;
  92             otherwise <FALSE/> is returned.
  93
  94         @param aName
  95             specifies the name of the property.
  96      */
  97     boolean hasPropertyByName( [in] string Name );
  98
  99 };
 100
 101 //=============================================================================
 102
 103 }; }; }; };
 104
 105 #endif