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