accessible/src/xul/nsXULTreeGridAccessible.h

   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  * Mozilla Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2009
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Alexander Surkov <surkov.alexander@gmail.com> (original author)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef __nsXULTreeGridAccessible_h__
  40 #define __nsXULTreeGridAccessible_h__
  41
  42 #include "nsIAccessibleTable.h"
  43
  44 #include "nsXULTreeAccessible.h"
  45
  46 /**
  47  * Represents accessible for XUL tree in the case when it has multiple columns.
  48  */
  49 class nsXULTreeGridAccessible : public nsXULTreeAccessible,
  50                                 public nsIAccessibleTable
  51 {
  52 public:
  53   nsXULTreeGridAccessible(nsIContent *aContent, nsIWeakReference *aShell);
  54
  55   // nsISupports
  56   NS_DECL_ISUPPORTS_INHERITED
  57
  58   // nsIAccessibleTable
  59   NS_DECL_NSIACCESSIBLETABLE
  60
  61   // nsAccessible
  62   virtual PRUint32 NativeRole();
  63
  64 protected:
  65
  66   // nsXULTreeAccessible
  67   virtual already_AddRefed<nsAccessible> CreateTreeItemAccessible(PRInt32 aRow);
  68 };
  69
  70
  71 /**
  72  * Represents accessible for XUL tree item in the case when XUL tree has
  73  * multiple columns.
  74  */
  75 class nsXULTreeGridRowAccessible : public nsXULTreeItemAccessibleBase
  76 {
  77 public:
  78   using nsAccessible::GetChildCount;
  79   using nsAccessible::GetChildAt;
  80   using nsAccessible::GetChildAtPoint;
  81
  82   nsXULTreeGridRowAccessible(nsIContent *aContent, nsIWeakReference *aShell,
  83                              nsAccessible *aParent, nsITreeBoxObject *aTree,
  84                              nsITreeView *aTreeView, PRInt32 aRow);
  85
  86   // nsISupports and cycle collection
  87   NS_DECL_ISUPPORTS_INHERITED
  88   NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(nsXULTreeGridRowAccessible,
  89                                            nsAccessible)
  90
  91   // nsAccessNode
  92   virtual void Shutdown();
  93
  94   // nsAccessible
  95   virtual PRUint32 NativeRole();
  96   virtual nsresult GetChildAtPoint(PRInt32 aX, PRInt32 aY,
  97                                    PRBool aDeepestChild,
  98                                    nsIAccessible **aChild);
  99
 100   virtual nsAccessible* GetChildAt(PRUint32 aIndex);
 101   virtual PRInt32 GetChildCount();
 102
 103   // nsXULTreeItemAccessibleBase
 104   virtual nsAccessible* GetCellAccessible(nsITreeColumn *aColumn);
 105   virtual void RowInvalidated(PRInt32 aStartColIdx, PRInt32 aEndColIdx);
 106
 107 protected:
 108
 109   // nsAccessible
 110   virtual void CacheChildren();
 111
 112   // nsXULTreeItemAccessibleBase
 113   nsAccessibleHashtable mAccessibleCache;
 114 };
 115
 116
 117 /**
 118  * Represents an accessible for XUL tree cell in the case when XUL tree has
 119  * multiple columns.
 120  */
 121
 122 #define NS_XULTREEGRIDCELLACCESSIBLE_IMPL_CID         \
 123 {  /* 84588ad4-549c-4196-a932-4c5ca5de5dff */         \
 124   0x84588ad4,                                         \
 125   0x549c,                                             \
 126   0x4196,                                             \
 127   { 0xa9, 0x32, 0x4c, 0x5c, 0xa5, 0xde, 0x5d, 0xff }  \
 128 }
 129
 130 class nsXULTreeGridCellAccessible : public nsLeafAccessible,
 131                                     public nsIAccessibleTableCell
 132 {
 133 public:
 134   using nsAccessible::GetParent;
 135
 136   nsXULTreeGridCellAccessible(nsIContent *aContent, nsIWeakReference *aShell,
 137                               nsXULTreeGridRowAccessible *aRowAcc,
 138                               nsITreeBoxObject *aTree, nsITreeView *aTreeView,
 139                               PRInt32 aRow, nsITreeColumn* aColumn);
 140
 141   // nsISupports
 142   NS_DECL_ISUPPORTS_INHERITED
 143
 144   // nsIAccessible
 145   NS_IMETHOD GetFocusedChild(nsIAccessible **aFocusedChild);
 146
 147   NS_IMETHOD GetName(nsAString& aName);
 148   NS_IMETHOD GetBounds(PRInt32 *aX, PRInt32 *aY,
 149                        PRInt32 *aWidth, PRInt32 *aHeight);
 150
 151   NS_IMETHOD GetNumActions(PRUint8 *aCount);
 152   NS_IMETHOD GetActionName(PRUint8 aIndex, nsAString& aName);
 153   NS_IMETHOD DoAction(PRUint8 aIndex);
 154
 155   // nsIAccessibleTableCell
 156   NS_DECL_NSIACCESSIBLETABLECELL
 157
 158   // nsAccessNode
 159   virtual PRBool IsDefunct();
 160   virtual PRBool Init();
 161   virtual bool IsPrimaryForNode() const;
 162
 163   // nsAccessible
 164   virtual nsresult GetAttributesInternal(nsIPersistentProperties *aAttributes);
 165   virtual PRUint32 NativeRole();
 166   virtual nsresult GetStateInternal(PRUint32 *aState, PRUint32 *aExtraState);
 167   virtual PRInt32 GetIndexInParent() const;
 168
 169   // nsXULTreeGridCellAccessible
 170   NS_DECLARE_STATIC_IID_ACCESSOR(NS_XULTREEGRIDCELLACCESSIBLE_IMPL_CID)
 171
 172   /**
 173    * Return index of the column.
 174    */
 175   PRInt32 GetColumnIndex() const;
 176
 177   /**
 178    * Fire name or state change event if the accessible text or value has been
 179    * changed.
 180    */
 181   void CellInvalidated();
 182
 183 protected:
 184   // nsAccessible
 185   virtual nsAccessible* GetSiblingAtOffset(PRInt32 aOffset,
 186                                            nsresult *aError = nsnull);
 187   virtual void DispatchClickEvent(nsIContent *aContent, PRUint32 aActionIndex);
 188
 189   // nsXULTreeGridCellAccessible
 190
 191   /**
 192    * Return true if value of cell can be modified.
 193    */
 194   PRBool IsEditable() const;
 195
 196   enum { eAction_Click = 0 };
 197
 198   nsCOMPtr<nsITreeBoxObject> mTree;
 199   nsCOMPtr<nsITreeView> mTreeView;
 200
 201   PRInt32 mRow;
 202   nsCOMPtr<nsITreeColumn> mColumn;
 203
 204   nsString mCachedTextEquiv;
 205 };
 206
 207 NS_DEFINE_STATIC_IID_ACCESSOR(nsXULTreeGridCellAccessible,
 208                               NS_XULTREEGRIDCELLACCESSIBLE_IMPL_CID)
 209
 210 #endif