xref: /trunk/main/offapi/com/sun/star/accessibility/XAccessibleContext.idl (revision a893be29)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
#define __com_sun_star_accessibility_XAccessibleContext_idl__

#ifndef __com_sun_star_accessibility_IllegalAccessibleComponentStateException_idl__
#include <com/sun/star/accessibility/IllegalAccessibleComponentStateException.idl>
#endif

#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
#endif

#ifndef __com_sun_star_beans_XPropertyChangeListener_idl__
#include <com/sun/star/beans/XPropertyChangeListener.idl>
#endif

#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif

module com { module sun { module star { module accessibility {

 published interface XAccessible;
 published interface XAccessibleRelationSet;
 published interface XAccessibleSelection;
 published interface XAccessibleStateSet;

/** Implement this interface for exposing various aspects of a class'
    content.

    <p>This interface serves two purposes: On the one hand it gives access
    to the tree structure in which all accessible objects are
    organized. Each node in this tree supports this interface.  On the other
    hand it gives access to objects that expose the represented content.
    That are role, state, name, description, and relations to other objects.
    Take an OK button of a dialog as an example.  Its role is
    <const>AccessibleRole::BUTTON</const>, its name is 'OK', and its description
    is something like 'Accepts all changes made in the dialog'.</p>

    @since OpenOffice 1.1.2
*/
published interface XAccessibleContext : ::com::sun::star::uno::XInterface
{
    /** Return the number of children.

        <p>Returns the number of accessible children of the object.</p>

        @return
            The returned value is non-negative.
    */
    long getAccessibleChildCount();

    /** Returns the i-th child of this object.

        <p>The order in which the children are enumerated is implementation
        dependend.</p>

        @param i
            The index may have any value.  If it is outside the range from 0
            to n-1, with n being the number of children as returned by
            <member>XAccessibleContext::getAccessibleChild</member> an empty
            reference is returned.
        @return
            If the object has an i-th child the returned value is a
            reference to that child.  Otherwise an empty reference is
            returned.
        @throws ::com::sun::star::lang::IndexOutOfBoundsException
            If no child with the given index exists then an
            <type scope="::com::sun::star::lang">IndexOutOfBoundsException</type>
            exception is thrown.
    */
    XAccessible getAccessibleChild ([in] long i)
        raises (::com::sun::star::lang::IndexOutOfBoundsException);

    /** Returns the parent of this object.

        <p>This function may be called for every node, including the root
        node, of the accessible tree.</p>

        @return
            The returned reference points to a valid object for all but the
            root node.  If called for the root node an empty reference is
            returned.
    */
    XAccessible getAccessibleParent ();

    /** Returns the index of this object in its accessible parent.

        <p>If you call getAccessibeChild on the object's parent with the
        index returned by this function you get a reference to this
        object.</p>

        @return
           The returned index is zero based.
    */
    long getAccessibleIndexInParent ();

    /** Returns the role of this object.

        <p>The role is a generic description of an objects function.  The
        relation between role and name is similar to the relation between
        class and object.</p>

        @return
            The returned value is a role defined in the enumeration
            AccessibleRole.

        @see AccessibleRole
            for a list of the available roles.
    */
    short getAccessibleRole ();

    /** Returns the object's description.

        <p>Returns the object's localized description.  The description should
        complement the more generic descriptions given by an object's role
        and name.</p>

        @return
            The returned string is the object's localized description.
    */
    string getAccessibleDescription ();

    /** Return the object's localized name.

        <p>See <member>XAccessibleContext::getAccessibleRole</member>'s
        documentation for the relation between an object's name and role.
        Names should be unique, at least between children of the same
        parent, although the uniqueness is neither enforced nor used inside
        the API.</p>

        @return
            The returned string is the object's localized name.
    */
    string  getAccessibleName ();

    /** Returns the set of relations defined for this object.

        <p>The returned set of relations is a copy of this objects relation
        set: changing the returned object does not change this objects
        relations.</p>

        <p>aThere are two ways to represent an empty list of relations:
        Return an empty reference or return a valid object that contains an
        empty list.

        @return
           The returned value is either an empty reference or a reference to
           a valid object that represents a copy of the objects list of
           relations.
    */
    XAccessibleRelationSet getAccessibleRelationSet ();

    /** Returns the set of states that are currently active for this
        object.

        <p>The returned state set is a copy: Changing the returned state set
        will not be refelected by changing the object's set of states.  See
        the documentation of <type>XAccessibleStateSet</type> for a
        description of the individual states.</p>

        @return
            A reference to this object's state set or an empty reference if
            states are not supported.

        @see XAccessibleStateSet
    */
    XAccessibleStateSet getAccessibleStateSet ();

    /** Returns the locale of the component.

        <p>This locale is used for example to determine the language to use
        for the name and description texts.</p>

        @return
            If this object does not have a locale, the locale of its parent
            is returned.  If it does not have (yet) a parent it throws the
            exception <type>IllegalAccessibleComponentStateException</type>.

        @throws IllegalAccessibleComponentStateException
            when this object does not (yet) have a parent.
    */
    ::com::sun::star::lang::Locale getLocale ()
        raises (IllegalAccessibleComponentStateException);
};

}; }; }; };

#endif