offapi/com/sun/star/accessibility/AccessibleEventObject.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 module com { module sun { module star { module accessibility {
  21
  22 /** this struct describes an accessible event, that is broadcasted from
  23     the XAccessibleEventBroadcaster and notified to
  24     XAccessibleEventListener.
  25
  26     <p>It is usually implemented by AccessibleContext.
  27
  28     @since OOo 1.1.2
  29 */
  30 struct AccessibleEventObject: ::com::sun::star::lang::EventObject
  31 {
  32     /** specifies the type of this event.
  33
  34         <p>For a list of possible events see AccessibleEventId.
  35      */
  36     short EventId;
  37
  38     /** for events that specifies a value change, this is
  39         the new value.
  40
  41         Depending on the #EventId, this can be void.
  42     */
  43     any NewValue;
  44
  45     /** for events that specifies a value change, this is
  46         the old value.
  47
  48         Depending on the #EventId, this can be void.
  49     */
  50     any OldValue;
  51
  52     /**
  53         For events like add/remove/update of a child, this specifies the index of the object.
  54         For anything else, it should be -1.
  55         @since LibreOffice 7.6
  56     */
  57     long IndexHint;
  58 };
  59
  60 }; }; }; };
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */