1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir#ifndef __com_sun_star_accessibility_XAccessibleRelationSet_idl__ 29*cdf0e10cSrcweir#define __com_sun_star_accessibility_XAccessibleRelationSet_idl__ 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir#ifndef __com_sun_star_accessibility_AccessibleRelation_idl__ 32*cdf0e10cSrcweir#include <com/sun/star/accessibility/AccessibleRelation.idl> 33*cdf0e10cSrcweir#endif 34*cdf0e10cSrcweir 35*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 36*cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 37*cdf0e10cSrcweir#endif 38*cdf0e10cSrcweir#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__ 39*cdf0e10cSrcweir#include <com/sun/star/lang/IndexOutOfBoundsException.idl> 40*cdf0e10cSrcweir#endif 41*cdf0e10cSrcweir 42*cdf0e10cSrcweirmodule com { module sun { module star { module accessibility { 43*cdf0e10cSrcweir 44*cdf0e10cSrcweir/** Implement this interface to give access to an object's set of relations. 45*cdf0e10cSrcweir 46*cdf0e10cSrcweir <p>Such relation are modeled with the <type>AccessibleRelation</type> 47*cdf0e10cSrcweir structure. This interface is used for representing sets of relations 48*cdf0e10cSrcweir between <type>Accessible</type> objects. Most of the convenience 49*cdf0e10cSrcweir methods of the corresponding AccessibleRelationSet interface of the Java 50*cdf0e10cSrcweir Accessibility API have been removed from this interface in order to 51*cdf0e10cSrcweir clean it up. These methods are <member>add</member>, 52*cdf0e10cSrcweir <member>addAll</member>, <member>clear</member>, and 53*cdf0e10cSrcweir <member>remove</member>. The other methods have been renamed to achieve 54*cdf0e10cSrcweir a geater conformance with the other accessibility interfaces.</p> 55*cdf0e10cSrcweir 56*cdf0e10cSrcweir @since OOo 1.1.2 57*cdf0e10cSrcweir*/ 58*cdf0e10cSrcweirpublished interface XAccessibleRelationSet : ::com::sun::star::uno::XInterface 59*cdf0e10cSrcweir{ 60*cdf0e10cSrcweir /** Returns the number of relations in this relation set. 61*cdf0e10cSrcweir 62*cdf0e10cSrcweir @return 63*cdf0e10cSrcweir Returns the number of relations or zero if there are none. 64*cdf0e10cSrcweir */ 65*cdf0e10cSrcweir long getRelationCount (); 66*cdf0e10cSrcweir 67*cdf0e10cSrcweir /** Returns the relation of this relation set that is specified by 68*cdf0e10cSrcweir the given index. 69*cdf0e10cSrcweir 70*cdf0e10cSrcweir @param nIndex 71*cdf0e10cSrcweir This index specifies the relatio to return. 72*cdf0e10cSrcweir 73*cdf0e10cSrcweir @return 74*cdf0e10cSrcweir For a valid index, i.e. inside the range 0 to the number of 75*cdf0e10cSrcweir relations minus one, the returned value is the requested 76*cdf0e10cSrcweir relation. If the index is invalid then the returned relation 77*cdf0e10cSrcweir has the type INVALID. 78*cdf0e10cSrcweir 79*cdf0e10cSrcweir */ 80*cdf0e10cSrcweir AccessibleRelation getRelation ([in] long nIndex) 81*cdf0e10cSrcweir raises (::com::sun::star::lang::IndexOutOfBoundsException); 82*cdf0e10cSrcweir 83*cdf0e10cSrcweir /** Tests whether the relation set contains a relation matching the 84*cdf0e10cSrcweir specified key. 85*cdf0e10cSrcweir 86*cdf0e10cSrcweir @param aRelationType 87*cdf0e10cSrcweir The type of relation to look for in this set of relations. This 88*cdf0e10cSrcweir has to be one of the constants of 89*cdf0e10cSrcweir <type>AccessibleRelationType</type>. 90*cdf0e10cSrcweir 91*cdf0e10cSrcweir @return 92*cdf0e10cSrcweir Returns <TRUE/> if there is a (at least one) relation of the 93*cdf0e10cSrcweir given type and <FALSE/> if there is no such relation in the set. 94*cdf0e10cSrcweir */ 95*cdf0e10cSrcweir boolean containsRelation ([in] short aRelationType); 96*cdf0e10cSrcweir 97*cdf0e10cSrcweir /** Retrieve and return the relation with the given relation type. 98*cdf0e10cSrcweir 99*cdf0e10cSrcweir @param aRelationType 100*cdf0e10cSrcweir The type of the relation to return. This has to be one of the 101*cdf0e10cSrcweir constants of <type>AccessibleRelationType</type>. 102*cdf0e10cSrcweir 103*cdf0e10cSrcweir @return 104*cdf0e10cSrcweir If a relation with the given type could be found than (a copy 105*cdf0e10cSrcweir of) this relation is returned. Otherwise a relation with the 106*cdf0e10cSrcweir type INVALID is returned. 107*cdf0e10cSrcweir */ 108*cdf0e10cSrcweir AccessibleRelation getRelationByType ([in] short aRelationType); 109*cdf0e10cSrcweir}; 110*cdf0e10cSrcweir 111*cdf0e10cSrcweir}; }; }; }; 112*cdf0e10cSrcweir 113*cdf0e10cSrcweir#endif 114