/************************************************************** * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * *************************************************************/ #ifndef __com_sun_star_sheet_AccessibleSpreadsheetDocumentView_idl__ #define __com_sun_star_sheet_AccessibleSpreadsheetDocumentView_idl__ #ifndef __com_sun_star_accessibility_XAccessibleContext_idl__ #include #endif #ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__ #include #endif #ifndef __com_sun_star_accessibility_XAccessibleSelection_idl__ #include #endif #ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__ #include #endif //============================================================================= module com { module sun { module star { module sheet { //============================================================================= /** The accessible view of a spreadsheet document @since OpenOffice 1.1.2 */ published service AccessibleSpreadsheetDocumentView { /** This interface gives access to any object that is contained in this document.
  • The parent returned by getAccessibleParent is the window wich contains the view of these document.
  • The children returned by getAccessibleChild all support the interface XAccessible. Calling getAccessibleContext for these children returns an object that supports one of the following services.
    • AccessibleSpreadsheet: A child where calling getAccessibleChild an object that supports this service is returned for the current spreadsheet which is showing in this document window. There is everytime one child which supports this service, because it is only possible to have one spreadsheet in the current document window.
    • AccessibleShape: A child where calling getAccessibleChild an object that supports this service is returned for every shape that is at the current table. These objects are children of the AccessibleSpreadsheetDocumentView regardless whether they are bound to a table or a cell.
    • AccessibleParagraphView: A child where calling getAccessibleChild an object that supports this service is returned for the current cell in edit mode. This is necessary to have an object which allows event listeners. It exists only if a cell is in edit mode.
    • AccessibleContext: A child where calling getAccessibleChild an object that supports this service is returned for the current OLE object in edit mode. It exists only if a OLE object is in edit mode.

    The following rules apply to the children order. General it represents the paint order. The object in the background came first and than all over lying objects. The last painted object is also the last child.

    • Graphics, embedded objects and shapes appear before the other childs if they are painted in the background. Their order reflects the z order.
    • The current table is painted after the background and so it comes after all background objects.
    • Graphics, embedded objects and shapes appear behind any other children except controls if they are painted in the foreground. Their order reflects the z order.
    • Controls appear behind the other graphic objects. Their order reflects the z order.
    • The temporary object for the cell or OLE in edit mode (only one can exist in the same time) is the last object.
  • The description is ???.
  • The name is Spreadsheet Document View with a unique number.
  • The role is AccessibleRole::DOCUMENT
  • There are no relations.
  • The following states are supported:
    • AccessibleStateType::DEFUNC is always false until the document is closed.
    • AccessibleStateType::EDITABLE is always true.
    • AccessibleStateType::ENABLED is always true.
    • AccessibleStateType::MULTI_LINE makes no sense in on a document and so it is left out of the list.
    • AccessibleStateType::MULTI_SELECTABLE is always false, because a document is not selectable. Only the children are selectable. So it is left out of the list.
    • AccessibleStateType::OPAQUE is always true.
    • AccessibleStateType::RESIZEABLE is always false, because you can resize the window, but not the document. So it is left out of the list.
    • AccessibleStateType::SELECTABLE is always false, because a document is not selectable. Only the children are selectable. So it is left out of the list.
    • AccessibleStateType::SELECTED is always false, because a document is not selectable. Only the children are selectable. So it is left out of the list.
    • AccessibleStateType::SHOWINGIs true if the Bounding Box lies in the Bounding Box of the parent. Otherwise it is false.
    • AccessibleStateType::VISIBLEIs always true.
*/ interface ::com::sun::star::accessibility::XAccessibleContext; /** This interface gives access to the visibility of the document. */ interface ::com::sun::star::accessibility::XAccessibleComponent; /** This interface is for selecting the document's children like shapes or the whole table. */ interface ::com::sun::star::accessibility::XAccessibleSelection; /** This is the interface for listeners */ interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster; }; //============================================================================= }; }; }; }; #endif