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

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