offapi/com/sun/star/accessibility/XAccessibleRelationSet.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
  20 module com { module sun { module star { module accessibility {
  21
  22 /** Implement this interface to give access to an object's set of relations.
  23
  24     <p>Such relation are modeled with the AccessibleRelation
  25     structure.  This interface is used for representing sets of relations
  26     between Accessible objects.  Most of the convenience
  27     methods of the corresponding AccessibleRelationSet interface of the Java
  28     Accessibility API have been removed from this interface in order to
  29     clean it up.  These methods are add(),
  30     addAll(), clear(), and
  31     remove().  The other methods have been renamed to achieve
  32     a greater conformance with the other accessibility interfaces.</p>
  33
  34     @since OOo 1.1.2
  35 */
  36 interface XAccessibleRelationSet : ::com::sun::star::uno::XInterface
  37 {
  38     /** Returns the number of relations in this relation set.
  39
  40         @return
  41             Returns the number of relations or zero if there are none.
  42     */
  43     long getRelationCount ();
  44
  45     /** Returns the relation of this relation set that is specified by
  46         the given index.
  47
  48         @param nIndex
  49             This index specifies the relation to return.
  50
  51         @return
  52             For a valid index, i.e. inside the range 0 to the number of
  53             relations minus one, the returned value is the requested
  54             relation.  If the index is invalid then the returned relation
  55             has the type INVALID.
  56
  57     */
  58     AccessibleRelation getRelation ([in] long nIndex)
  59         raises (::com::sun::star::lang::IndexOutOfBoundsException);
  60
  61     /** Tests whether the relation set contains a relation matching the
  62         specified key.
  63
  64         @param eRelationType
  65             The type of relation to look for in this set of relations.
  66
  67         @return
  68             Returns `TRUE` if there is a (at least one) relation of the
  69             given type and `FALSE` if there is no such relation in the set.
  70     */
  71     boolean containsRelation ([in] ::com::sun::star::accessibility::AccessibleRelationType eRelationType);
  72
  73     /** Retrieve and return the relation with the given relation type.
  74
  75         @param aRelationType
  76             The type of the relation to return.
  77
  78         @return
  79             If a relation with the given type could be found than (a copy
  80             of) this relation is returned.  Otherwise a relation with the
  81             type INVALID is returned.
  82     */
  83     AccessibleRelation getRelationByType ([in] ::com::sun::star::accessibility::AccessibleRelationType eRelationType);
  84 };
  85
  86 }; }; }; };
  87
  88 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */