accessible/public/nsIAccessibleTreeCache.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2002
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Louie Zhao <Louie.Zhao@sun.com> (original author)
  24  *   Alexander Surkov <surkov.alexander@gmail.com>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #include "nsISupports.idl"
  41 #include "nsITreeColumns.idl"
  42
  43 interface nsIAccessible;
  44
  45 /**
  46  * A private interface to operate with tree accessible.
  47  *
  48  * @status UNDER_REVIEW
  49  */
  50 [uuid(1dde5c3b-bede-43d1-aabf-dabc461113bd)]
  51 interface nsIAccessibleTreeCache : nsISupports
  52 {
  53   /**
  54    * Get tree item from cache according to row and column, create if doesn't
  55    * exist in cache.
  56    *
  57    * @param aRow     the given row index
  58    * @param aColumn  the given column object. If is is nsnull then primary
  59    *                 column is used. It makes sense for ATK only.
  60    */
  61   nsIAccessible getCachedTreeitemAccessible(in long aRow,
  62                                             in nsITreeColumn aColumn);
  63
  64   /**
  65    * Invalidates the number of cached treeitem accessibles.
  66    *
  67    * @param aRow    row index the invalidation starts from
  68    * @param aCount  the number of treeitem accessibles to invalidate,
  69    *                the number sign specifies whether rows have been
  70    *                inserted (plus) or removed (minus)
  71    */
  72   void invalidateCache(in long aRow, in long aCount);
  73
  74   /**
  75    * Fires name change events for invalidated area of tree.
  76    *
  77    * @param aStartRow  row index invalidation starts from
  78    * @param aEndRow    row index invalidation ends, -1 means last row index
  79    * @param aStartCol  column index invalidation starts from
  80    * @param aEndCol    column index invalidation ends, -1 mens last column
  81    *                   index
  82    */
  83   void treeViewInvalidated(in long aStartRow, in long aEndRow,
  84                            in long aStartCol, in long aEndCol);
  85
  86   /**
  87    * Invalidates children created for previous tree view.
  88    */
  89   void treeViewChanged();
  90
  91 };
  92
  93 [uuid(b71532f9-53b2-4647-a5b2-1c5f57e9aed6)]
  94 interface nsPIAccessibleTreeItem : nsISupports
  95 {
  96   /**
  97    * Get/set cached name.
  98    */
  99   attribute AString cachedName;
 100 };
 101