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