offapi/com/sun/star/accessibility/AccessibleRelation.idl

   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_accessibility_AccessibleRelation_idl__
  28 #define __com_sun_star_accessibility_AccessibleRelation_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 module com { module sun { module star { module accessibility {
  35
  36 /** An <type>AccessibleRelation</type> object defines a one-to-many
  37     relation.
  38
  39     <p>The represented relation points from the implementing object to a set
  40     of target objects.</p>
  41
  42     @since OOo 1.1.2
  43 */
  44 published struct AccessibleRelation
  45 {
  46     /** Type of the relation.
  47
  48         <p>Its value has to be one of the constants defined by
  49         <type>AccessibleRelationType</type>.  If that value is INVALID then
  50         the whole relation is regarded as invalid.  The content of the
  51         targetSet is then undefined.</p>
  52
  53         @see AccessibleRelationType
  54     */
  55     short RelationType;
  56
  57     /** Set of objects that are the relation's targets.
  58
  59         <p>The content of this set is undefined if the relation's type is
  60         INVALID.  The set must not contain references to one object more
  61         than once.</p>
  62     */
  63     sequence< ::com::sun::star::uno::XInterface> TargetSet;
  64 };
  65
  66 }; }; }; };
  67
  68 #endif