offapi/com/sun/star/text/AccessibleTextGraphicObject.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
  21
  22 module com {  module sun {  module star {  module text {
  23
  24
  25 /** The accessible view of graphics.
  26
  27      @since OOo 1.1.2
  28  */
  29 service AccessibleTextGraphicObject
  30 {
  31     /** This interface comprises the basic accessibility of text graphics.
  32
  33         <ul>
  34             <li>The parent returned by
  35                 ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent()
  36                 is the accessible view of a paragraph if the graphic is bound as
  37                 character, and the accessible view of the document (or of a
  38                 page in the page preview) in any other case.
  39             <li>There are no children returned by
  40                 ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild().
  41             <li>The role is
  42                 ::com::sun::star::accessibility::AccessibleRole::GRAPHIC
  43             <li>The name is the one assigned to the graphic in the text
  44                 document. This means that it is not internationalized.
  45             <li>The description is the one assigned to the graphic in the text
  46                 document. This means that it is not internationalized. If no
  47                 description has been set, the description equals the name.
  48             <li>There are no relations.
  49             <li>The following states might be contained in the state set
  50                 returned by
  51                 ::com::sun::star::accessibility::XAccessibleContext::getAccessibleStateSet():
  52                 <ul>
  53                     <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC
  54                         (indicates that
  55                         the document window has been closed or the graphic
  56                         is not existing any longer)
  57                     <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE
  58                     <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED
  59                         (always contained)
  60                     <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE
  61                     <li>::com::sun::star::accessibility::AccessibleStateType::SELECTABLE
  62                     <li>::com::sun::star::accessibility::AccessibleStateType::SELECTED
  63                     <li>::com::sun::star::accessibility::AccessibleStateType::FOCUSABLE
  64                     <li>::com::sun::star::accessibility::AccessibleStateType::FOCUSED
  65                     <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING
  66                     <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE
  67                 </ul>
  68             <li>The locale is the one the text document itself.
  69         </ul>
  70
  71      */
  72     interface ::com::sun::star::accessibility::XAccessibleContext;
  73
  74     /** This interface describes the graphical representation of a
  75           graphic.
  76      */
  77     interface ::com::sun::star::accessibility::XAccessibleComponent;
  78
  79     /** This interface gives access to the image size and its description.
  80      */
  81     interface ::com::sun::star::accessibility::XAccessibleImage;
  82
  83     /** This is the interface for listeners */
  84     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
  85 };
  86
  87
  88 }; }; }; };
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */