LibreOffice: com/sun/star/accessibility/XAccessibleRelationSet.idl Source File

LibreOffice LibreOffice 7.2 SDK API Reference

XAccessibleRelationSet.idl
Go to the documentation of this file.
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#ifndef __com_sun_star_accessibility_XAccessibleRelationSet_idl__
21#define __com_sun_star_accessibility_XAccessibleRelationSet_idl__
22
23#include <com/sun/star/accessibility/AccessibleRelation.idl>
24#include <com/sun/star/uno/XInterface.idl>
25#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
26
27module com { module sun { module star { module accessibility {
28
43 interface XAccessibleRelationSet : ::com::sun::star::uno::XInterface
44{
50 long getRelationCount ();
51
65 AccessibleRelation getRelation ([in] long nIndex)
66 raises (::com::sun::star::lang::IndexOutOfBoundsException);
67
80 boolean containsRelation ([in] short aRelationType);
81
93 AccessibleRelation getRelationByType ([in] short aRelationType);
94};
95
96}; }; }; };
97
98#endif
99
100/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
AccessibleRelation.idl
IndexOutOfBoundsException.idl
XInterface.idl
com::sun::star::lang::IndexOutOfBoundsException
This exception is thrown to indicate that a container has been accessed with an illegal index.
Definition: IndexOutOfBoundsException.idl:35
com::sun::star::accessibility::XAccessibleRelationSet
Implement this interface to give access to an object's set of relations.
Definition: XAccessibleRelationSet.idl:44
com::sun::star::accessibility::XAccessibleRelationSet::getRelation
AccessibleRelation getRelation([in] long nIndex)
Returns the relation of this relation set that is specified by the given index.
com::sun::star::accessibility::XAccessibleRelationSet::containsRelation
boolean containsRelation([in] short aRelationType)
Tests whether the relation set contains a relation matching the specified key.
com::sun::star::accessibility::XAccessibleRelationSet::getRelationByType
AccessibleRelation getRelationByType([in] short aRelationType)
Retrieve and return the relation with the given relation type.
com::sun::star::accessibility::XAccessibleRelationSet::getRelationCount
long getRelationCount()
Returns the number of relations in this relation set.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:48
com
Definition: Accessible.idl:22
com::sun::star::accessibility::AccessibleRelation
An AccessibleRelation object defines a one-to-many relation.
Definition: AccessibleRelation.idl:35