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