offapi/com/sun/star/text/AccessibleTextDocumentPageView.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: AccessibleTextDocumentPageView.idl,v $
  10  * $Revision: 1.8 $
  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_text_AccessibleTextDocumentPageView_idl__
  31 #define __com_sun_star_text_AccessibleTextDocumentPageView_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_XAccessibleSelection_idl__
  42 #include <com/sun/star/accessibility/XAccessibleSelection.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
  46 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module text {
  53
  54 //=============================================================================
  55
  56 /** The accessible page preview of a text document.
  57
  58      @since OOo 1.1.2
  59  */
  60 published service AccessibleTextDocumentPageView
  61 {
  62     /** This interface gives access to page that are visible in the
  63           page preview of a text document.
  64         <ul>
  65             <li>The children returned by
  66                 <method scope="::com::sun::star::accessibility"
  67                 >XAccessibleContext::getAccessibleChild</type> all support
  68                 the interface XAccessible. Calling
  69                 <method scope="::com::sun::star::accessibility"
  70                 >XAccessible::getAccessibleContext</type> for these children
  71                 returns an object that supports one of the service
  72                 <type scope="::com::sun::star::text"
  73                 >AccessiblePageView</type>.
  74             <li>The role is <const scope="::com::sun::star::accessibility"
  75                 >AccessibleRole::DOCUMENT</const>.
  76             <li>The name is "document view" (or the equivalent term
  77                 in application's language).
  78             <li>The description also is "document view" (or the equivalent term
  79                 in application's language).
  80             <li>There are no relation sets.
  81             <li>The following states might be contained in the state set
  82                 returned by <method scope="::com::sun::star::accessibility"
  83                 >XAccessibleContext::getAccessibleStateSet</method>:
  84                 <ul>
  85                     <li><const scope="::com::sun::star::accessibility"
  86                         >AccessibleStateType::DEFUNC</const> (indicates that
  87                         the document window has been closed)
  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::OPAQUE</const> (always
  93                         contained)
  94                     <li><const scope="::com::sun::star::accessibility"
  95                         >AccessibleStateType::SHOWING</const>
  96                     <li><const scope="::com::sun::star::accessibility"
  97                         >AccessibleStateType::VISIBLE</const>
  98                 </ul>
  99             <li>The locale is the application's locale.
 100         </ul>
 101
 102     */
 103     interface ::com::sun::star::accessibility::XAccessibleContext;
 104
 105     /** This interface describes the graphical representation of a text
 106           document view.
 107     */
 108     interface ::com::sun::star::accessibility::XAccessibleComponent;
 109
 110     /** This is the interface for listeners
 111     */
 112     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 113 };
 114
 115 //=============================================================================
 116
 117 }; }; }; };
 118
 119 #endif