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