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