Back to index

lightning-sunbird  0.9+nobinonly
nsAppRootAccessible.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* vim:expandtab:shiftwidth=4:tabstop=4:
00003  */
00004 /* ***** BEGIN LICENSE BLOCK *****
00005  * Version: NPL 1.1/GPL 2.0/LGPL 2.1
00006  *
00007  *
00008  * The contents of this file are subject to the Mozilla Public
00009  * License Version 1.1 (the "License"); you may not use this file
00010  * except in compliance with the License. You may obtain a copy of
00011  * the License at http://www.mozilla.org/MPL/
00012  *
00013  * Software distributed under the License is distributed on an "AS
00014  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
00015  * implied. See the License for the specific language governing
00016  * rights and limitations under the License.
00017  *
00018  * The Original Code is mozilla.org code.
00019  *
00020  * The Initial Developer of the Original Code is Sun Microsystems, Inc.
00021  * Portions created by Sun Microsystems are Copyright (C) 2002 Sun
00022  * Microsystems, Inc. All Rights Reserved.
00023  *
00024  * Original Author: Bolian Yin (bolian.yin@sun.com)
00025  *
00026  * Contributor(s): 
00027  *
00028  * Alternatively, the contents of this file may be used under the terms of
00029  * either the GNU General Public License Version 2 or later (the "GPL"), or
00030  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00031  * in which case the provisions of the GPL or the LGPL are applicable instead
00032  * of those above. If you wish to allow use of your version of this file only
00033  * under the terms of either the GPL or the LGPL, and not to allow others to
00034  * use your version of this file under the terms of the NPL, indicate your
00035  * decision by deleting the provisions above and replace them with the notice
00036  * and other provisions required by the GPL or the LGPL. If you do not delete
00037  * the provisions above, a recipient may use your version of this file under
00038  * the terms of any one of the NPL, the GPL or the LGPL.
00039  *
00040  * ***** END LICENSE BLOCK ***** */
00041 
00042 #ifndef __NS_APP_ROOT_ACCESSIBLE_H__
00043 #define __NS_APP_ROOT_ACCESSIBLE_H__
00044 
00045 #include "nsArray.h"
00046 #include "nsIAccessibleDocument.h"
00047 #include "nsAccessibilityService.h"
00048 #include "nsAccessibleWrap.h"
00049 #include "nsRootAccessibleWrap.h"
00050 
00051 #define MAI_TYPE_APP_ROOT (MAI_TYPE_ATK_OBJECT)
00052 
00053 /* nsAppRootAccessible is for the whole application of Mozilla.
00054  * Only one instance of nsAppRootAccessible exists for one Mozilla instance.
00055  * And this one should be created when Mozilla Startup (if accessibility
00056  * feature has been enabled) and destroyed when Mozilla Shutdown.
00057  *
00058  * All the accessibility objects for toplevel windows are direct children of
00059  * the nsAppRootAccessible instance.
00060  */
00061 class nsAppRootAccessible;
00062 class nsAppRootAccessible: public nsAccessibleWrap
00063 {
00064 public:
00065     virtual ~nsAppRootAccessible();
00066 #ifdef MAI_LOGGING
00067     //    virtual void DumpMaiObjectInfo(int aDepth);
00068 #endif
00069 
00070     static nsAppRootAccessible *Create();
00071     static void Unload();
00072 
00073 public:
00074     nsAppRootAccessible();
00075 
00076     /* virtual function from nsAccessNode */
00077     NS_IMETHOD Init();
00078 
00079     /* virtual functions from nsAccessible */
00080     NS_IMETHOD GetName(nsAString & aName);
00081     NS_IMETHOD GetDescription(nsAString & aDescription);
00082     NS_IMETHOD GetRole(PRUint32 *aRole);
00083     NS_IMETHOD GetFinalRole(PRUint32 *aFinalRole);
00084     NS_IMETHOD GetParent(nsIAccessible * *aParent);
00085     NS_IMETHOD GetNextSibling(nsIAccessible * *aNextSibling);
00086     NS_IMETHOD GetPreviousSibling(nsIAccessible **aPreviousSibling);
00087     NS_IMETHOD GetChildAt(PRInt32 aChildNum, nsIAccessible **aChild);
00088 
00089     NS_IMETHOD GetFirstChild(nsIAccessible * *aFirstChild);
00090     NS_IMETHOD GetChildCount(PRInt32 *aAccChildCount);
00091 
00092     // return the atk object for app root accessible
00093     NS_IMETHOD GetNativeInterface(void **aOutAccessible);
00094 
00095     nsresult AddRootAccessible(nsRootAccessibleWrap *aRootAccWrap);
00096     nsresult RemoveRootAccessible(nsRootAccessibleWrap *aRootAccWrap);
00097 private:
00098     nsCOMPtr<nsIMutableArray> mChildren;
00099     PRBool mInitialized;
00100 };
00101 
00102 #endif   /* __NS_APP_ROOT_ACCESSIBLE_H__ */