/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* * This file is part of the LibreOffice project. * * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. * * This file incorporates work covered by the following license notice: * * 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 . */ #ifndef __com_sun_star_text_AccessibleParagraphView_idl__ #define __com_sun_star_text_AccessibleParagraphView_idl__ #include #include #include #include #include module com { module sun { module star { module text { /** The accessible view of a paragraph fragment. @since OOo 1.1.2 */ service AccessibleParagraphView { /** This interface gives access to a paragraph fragment that is at least partially visible on the screen. A paragraph fragment is the portion of a paragraph that is displayed on a single page or a in a single column.
  • The parent returned by ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent() is the accessible view of a text document (in this case the paragraph is contained in a page body) or the accessible view of a header, footer, footnote, endnote, table cell, text frame, page or shape.
  • The children returned by ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild() are the graphics, text boxes and OLE objects that are bound as character within the paragraph. Graphics, text boxes and OLE objects that are bound to the paragraph or to a character within the paragraph are not children of the paragraph fragment but of the document view itself.
  • The role is either ::com::sun::star::accessibility::AccessibleRole::PARAGRAPH or ::com::sun::star::accessibility::AccessibleRole::HEADING. The later one is returned if the paragraph's style is contained in the chapter numbering of a text document.
  • The name is "paragraph" or "heading" (or the equivalent term in application's language) with a number appended.
  • The description contains the term "paragraph" (or the equivalent term in application's language) and the first sentence of the paragraph.
  • There are no relations.
  • The following states are supported by the ::com::sun::star::accessibility::XAccessibleStateSet returned by ::com::sun::star::accessibility::XAccessibleContext::getAccessibleStateSet().
    • ::com::sun::star::accessibility::AccessibleStateType::DEFUNC (indicates that the document window has been closed or the paragraph fragment is not existing any longer).
    • ::com::sun::star::accessibility::AccessibleStateType::EDITABLE
    • ::com::sun::star::accessibility::AccessibleStateType::ENABLED (always contained)
    • ::com::sun::star::accessibility::AccessibleStateType::MULTI_LINE (always contained)
    • ::com::sun::star::accessibility::AccessibleStateType::MULTI_SELECTABLE (always contained)
    • ::com::sun::star::accessibility::AccessibleStateType::OPAQUE
    • ::com::sun::star::accessibility::AccessibleStateType::SHOWING
    • ::com::sun::star::accessibility::AccessibleStateType::VISIBLE
    • ::com::sun::star::accessibility::AccessibleStateType::FOCUSED
  • Depending of the application's region setting, the locale is the western, Asian or complex language of the paragraph.
*/ interface ::com::sun::star::accessibility::XAccessibleContext; /** This interface describes the graphical representation of a paragraph fragment. */ interface ::com::sun::star::accessibility::XAccessibleComponent; /** This interface gives access to a paragraph fragment's text. The text contains the paragraph's editable text as well as generated text, like chapter numbers, hyphens or fields. Characters of generated text contribute to the text's character indexing. However, it is not possible to set the caret or start a selection within generated text.

For text frames, graphics, etc. that are bound as character some text is generated that contains the objects description.

The attributes (or properties) returned by ::com::sun::star::accessibility::XAccessibleText::getCharacterAttributes() are a sub set of the properties described by the service ::com::sun::star::style::CharacterProperties. For properties that have Asian and complex counterparts, the value that is visible is returned. This can be in fact the western, Asian or complex value. It's not possible to change the value of any property by using ::com::sun::star::accessibility::XAccessibleEditableText::setAttributes().

TODO: If there is a demand, some attributes might be added that tells whether the character at a certain index is editable or generated. */ [optional] interface ::com::sun::star::accessibility::XAccessibleEditableText; /** This interface is a subset of ::com::sun::star::accessibility::XAccessibleEditableText and gives access to a paragraph fragment's text in a read-only mode. The text contains the paragraph's text (changeable as well as generated text, like chapter numbers, hyphens or fields). Characters of generated text contribute to the text's character indexing.

For text frames, graphics, etc. that are bound as character some text is generated that contains the objects description.

The attributes (or properties) returned by ::com::sun::star::accessibility::XAccessibleText::getCharacterAttributes() are a sub set of the properties described by the service ::com::sun::star::style::CharacterProperties. For properties that have Asian and complex counterparts, the value that is visible is returned. This can be in fact the western, Asian or complex value.

TODO: If there is a demand, some attributes might be added that tells whether the character at a certain index is changeable or generated. */ interface ::com::sun::star::accessibility::XAccessibleText; /** This interface is for selecting the paragraph's children. Multi selection is supported only for children that are multi selectable in the GUI, too. */ [optional] interface ::com::sun::star::accessibility::XAccessibleSelection; /** This is the interface for listeners. */ interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster; /** This interface gives access to the default attributes of a paragraph and to the run attributes of a certain character in a paragraph @since OOo 2.0.4 */ [optional] interface ::com::sun::star::accessibility::XAccessibleTextAttributes; }; }; }; }; }; #endif /* vim:set shiftwidth=4 softtabstop=4 expandtab: */