offapi/com/sun/star/text/AccessibleTextDocumentPageView.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 #ifndef __com_sun_star_text_AccessibleTextDocumentPageView_idl__
  20 #define __com_sun_star_text_AccessibleTextDocumentPageView_idl__
  21
  22 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  23 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  24 #include <com/sun/star/accessibility/XAccessibleSelection.idl>
  25 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  26
  27
  28
  29 module com {  module sun {  module star {  module text {
  30
  31
  32 /** The accessible page preview of a text document.
  33
  34      @since OOo 1.1.2
  35  */
  36 service AccessibleTextDocumentPageView
  37 {
  38     /** This interface gives access to page that are visible in the
  39           page preview of a text document.
  40         <ul>
  41             <li>The children returned by
  42                 <method scope="::com::sun::star::accessibility"
  43                 >XAccessibleContext::getAccessibleChild</type> all support
  44                 the interface XAccessible. Calling
  45                 <method scope="::com::sun::star::accessibility"
  46                 >XAccessible::getAccessibleContext</type> for these children
  47                 returns an object that supports one of the service
  48                 <type scope="::com::sun::star::text"
  49                 >AccessiblePageView</type>.
  50             <li>The role is <const scope="::com::sun::star::accessibility"
  51                 >AccessibleRole::DOCUMENT</const>.
  52             <li>The name is "document view" (or the equivalent term
  53                 in application's language).
  54             <li>The description also is "document view" (or the equivalent term
  55                 in application's language).
  56             <li>There are no relation sets.
  57             <li>The following states might be contained in the state set
  58                 returned by <method scope="::com::sun::star::accessibility"
  59                 >XAccessibleContext::getAccessibleStateSet</method>:
  60                 <ul>
  61                     <li><const scope="::com::sun::star::accessibility"
  62                         >AccessibleStateType::DEFUNC</const> (indicates that
  63                         the document window has been closed)
  64                     <li><const scope="::com::sun::star::accessibility"
  65                         >AccessibleStateType::ENABLED</const> (always
  66                         contained)
  67                     <li><const scope="::com::sun::star::accessibility"
  68                         >AccessibleStateType::OPAQUE</const> (always
  69                         contained)
  70                     <li><const scope="::com::sun::star::accessibility"
  71                         >AccessibleStateType::SHOWING</const>
  72                     <li><const scope="::com::sun::star::accessibility"
  73                         >AccessibleStateType::VISIBLE</const>
  74                 </ul>
  75             <li>The locale is the application's locale.
  76         </ul>
  77
  78     */
  79     interface ::com::sun::star::accessibility::XAccessibleContext;
  80
  81     /** This interface describes the graphical representation of a text
  82           document view.
  83     */
  84     interface ::com::sun::star::accessibility::XAccessibleComponent;
  85
  86     /** This is the interface for listeners
  87     */
  88     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
  89 };
  90
  91
  92 }; }; }; };
  93
  94 #endif
  95
  96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */