offapi/com/sun/star/drawing/AccessibleImageBullet.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_drawing_AccessibleImageBullet_idl__
  28 #define __com_sun_star_drawing_AccessibleImageBullet_idl__
  29
  30 #ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
  31 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
  35 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_accessibility_XAccessibleEditableText_idl__
  39 #include <com/sun/star/accessibility/XAccessibleEditableText.idl>
  40 #endif
  41
  42
  43 //=============================================================================
  44
  45 module com {  module sun {  module star {  module drawing {
  46
  47 //=============================================================================
  48
  49 /** The accessible view of an image bullet.
  50
  51      @since OOo 1.1.2
  52  */
  53 service AccessibleImageBullet
  54 {
  55     /** This interface gives access to an image bullet within a text
  56           paragraph fragment that is at least partially visible on the
  57           screen.
  58
  59         <ul>
  60             <li>The parent returned by
  61                 <method scope="::com::sun::star::accessibility"
  62                 >XAccessibleContext::getAccessibleParent</method>
  63                 is the accessible object of a text paragraph.
  64             <li>There are no children returned by
  65                 <method scope="::com::sun::star::accessibility"
  66                 >XAccessibleContext::getAccessibleChild</method>.
  67             <li>The role is <const scope="::com::sun::star::accessibility"
  68                 >AccessibleRole::GRAPHIC</const>.
  69             <li>The name is "image bullet" (or the equivalent term
  70                 in application's language).
  71             <li>The description contains the term "image bullet" (or the equivalent
  72                 term in application's language) and the number of the paragraph
  73                 within this bullet appears.
  74             <li>There are no relations.
  75             <li>The following states are supported by the
  76                 <type scope="::com::sun::star::accessibility"
  77                 >XAccessibleStateSet</type> returned by
  78                 <method scope="::com::sun::star::accessibility"
  79                 >XAccessibleContext::getAccessibleStateSet</method>.
  80                 <ul>
  81                     <li><const scope="::com::sun::star::accessibility"
  82                         >AccessibleStateType::DEFUNC</const> (indicates that
  83                         the document window has been closed or the image bullet
  84                         is not existing any longer).
  85                     <li><const scope="::com::sun::star::accessibility"
  86                         >AccessibleStateType::ENABLED</const> (always
  87                         contained)
  88                     <li><const scope="::com::sun::star::accessibility"
  89                         >AccessibleStateType::SHOWING</const>
  90                     <li><const scope="::com::sun::star::accessibility"
  91                         >AccessibleStateType::VISIBLE</const>
  92                     <li><const scope="::com::sun::star::accessibility"
  93                         >AccessibleStateType::INVALID</const>
  94                 </ul>
  95         </ul>
  96
  97      */
  98     interface ::com::sun::star::accessibility::XAccessibleContext;
  99
 100     /** This interface describes the graphical representation of an image
 101           bullet.
 102      */
 103     interface ::com::sun::star::accessibility::XAccessibleComponent;
 104
 105 };
 106
 107 //=============================================================================
 108
 109 }; }; }; };
 110
 111 #endif