udkapi/com/sun/star/beans/XPropertySetInfo.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_XPropertySetInfo_idl__
  20 #define __com_sun_star_beans_XPropertySetInfo_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/beans/Property.idl>
  25
  26 #include <com/sun/star/beans/UnknownPropertyException.idl>
  27
  28
  29
  30 module com {  module sun {  module star {  module beans {
  31
  32
  33 /** specifies a set of properties.
  34
  35     <p>There are three kinds of properties:
  36     <ul>
  37         <li>bound properties</li>
  38         <li>constrained properties</li>
  39         <li>free properties</li>
  40     </ul>
  41
  42     <p>The specification only describes the properties, it does not contain
  43     any values.</p>
  44  */
  45 published interface XPropertySetInfo: com::sun::star::uno::XInterface
  46 {
  47
  48     /** @returns
  49             a sequence with all property descriptors which are specified
  50             within this XPropertySetInfo.
  51      */
  52     sequence<com::sun::star::beans::Property> getProperties();
  53
  54
  55     /** @returns
  56             the property with the specified name from the object.
  57
  58         @param aName
  59             specifies the name of the property.
  60
  61         @throws UnknownPropertyException
  62             if the property does not exist.
  63      */
  64     com::sun::star::beans::Property getPropertyByName( [in] string aName )
  65             raises( com::sun::star::beans::UnknownPropertyException );
  66
  67
  68     /** @returns
  69             `TRUE` if a property with the specified name exist;
  70             otherwise `FALSE` is returned.
  71
  72         @param Name
  73             specifies the name of the property.
  74      */
  75     boolean hasPropertyByName( [in] string Name );
  76
  77 };
  78
  79
  80 }; }; }; };
  81
  82 #endif
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */