← Back to branch summary

~ubuntu-branches/ubuntu/precise/kompozer/precise

« back to all changes in this revision

Viewing changes to mozilla/accessible/src/atk/nsAppRootAccessible.h

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Yarusso
  • Date: 2007-08-27 01:11:03 UTC
  • Revision ID: james.westby@ubuntu.com-20070827011103-2jgf4s6532gqu2ka
Tags: upstream-0.7.10
Import upstream version 0.7.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
mozilla/accessible/src/atk/nsAppRootAccessible.h
 
1
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
 
2
/* vim:expandtab:shiftwidth=4:tabstop=4:
 
3
 */
 
4
/* ***** BEGIN LICENSE BLOCK *****
 
5
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 
6
 *
 
7
 *
 
8
 * The contents of this file are subject to the Mozilla Public
 
9
 * License Version 1.1 (the "License"); you may not use this file
 
10
 * except in compliance with the License. You may obtain a copy of
 
11
 * the License at http://www.mozilla.org/MPL/
 
12
 *
 
13
 * Software distributed under the License is distributed on an "AS
 
14
 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
 
15
 * implied. See the License for the specific language governing
 
16
 * rights and limitations under the License.
 
17
 *
 
18
 * The Original Code is mozilla.org code.
 
19
 *
 
20
 * The Initial Developer of the Original Code is Sun Microsystems, Inc.
 
21
 * Portions created by Sun Microsystems are Copyright (C) 2002 Sun
 
22
 * Microsystems, Inc. All Rights Reserved.
 
23
 *
 
24
 * Original Author: Bolian Yin (bolian.yin@sun.com)
 
25
 *
 
26
 * Contributor(s): 
 
27
 *
 
28
 * Alternatively, the contents of this file may be used under the terms of
 
29
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 
30
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 
31
 * in which case the provisions of the GPL or the LGPL are applicable instead
 
32
 * of those above. If you wish to allow use of your version of this file only
 
33
 * under the terms of either the GPL or the LGPL, and not to allow others to
 
34
 * use your version of this file under the terms of the NPL, indicate your
 
35
 * decision by deleting the provisions above and replace them with the notice
 
36
 * and other provisions required by the GPL or the LGPL. If you do not delete
 
37
 * the provisions above, a recipient may use your version of this file under
 
38
 * the terms of any one of the NPL, the GPL or the LGPL.
 
39
 *
 
40
 * ***** END LICENSE BLOCK ***** */
 
41
 
 
42
#ifndef __NS_APP_ROOT_ACCESSIBLE_H__
 
43
#define __NS_APP_ROOT_ACCESSIBLE_H__
 
44
 
 
45
#include "nsArray.h"
 
46
#include "nsIAccessibleDocument.h"
 
47
#include "nsAccessibilityService.h"
 
48
#include "nsAccessibleWrap.h"
 
49
#include "nsRootAccessibleWrap.h"
 
50
 
 
51
#define MAI_TYPE_APP_ROOT (MAI_TYPE_ATK_OBJECT)
 
52
 
 
53
/* nsAppRootAccessible is for the whole application of Mozilla.
 
54
 * Only one instance of nsAppRootAccessible exists for one Mozilla instance.
 
55
 * And this one should be created when Mozilla Startup (if accessibility
 
56
 * feature has been enabled) and destroyed when Mozilla Shutdown.
 
57
 *
 
58
 * All the accessibility objects for toplevel windows are direct children of
 
59
 * the nsAppRootAccessible instance.
 
60
 */
 
61
class nsAppRootAccessible;
 
62
class nsAppRootAccessible: public nsAccessibleWrap
 
63
{
 
64
public:
 
65
    virtual ~nsAppRootAccessible();
 
66
#ifdef MAI_LOGGING
 
67
    //    virtual void DumpMaiObjectInfo(int aDepth);
 
68
#endif
 
69
 
 
70
    static nsAppRootAccessible *Create();
 
71
 
 
72
public:
 
73
    nsAppRootAccessible();
 
74
 
 
75
    /* virtual functions from nsAccessibleNode */
 
76
    NS_IMETHOD Init();
 
77
    NS_IMETHOD Shutdown();
 
78
 
 
79
    /* virtual functions from nsAccessible */
 
80
    NS_IMETHOD GetName(nsAString & aName);
 
81
    NS_IMETHOD GetDescription(nsAString & aDescription);
 
82
    NS_IMETHOD GetRole(PRUint32 *aRole);
 
83
    NS_IMETHOD GetParent(nsIAccessible * *aParent);
 
84
    NS_IMETHOD GetNextSibling(nsIAccessible * *aNextSibling);
 
85
    NS_IMETHOD GetPreviousSibling(nsIAccessible **aPreviousSibling);
 
86
    NS_IMETHOD GetChildAt(PRInt32 aChildNum, nsIAccessible **aChild);
 
87
 
 
88
    NS_IMETHOD GetFirstChild(nsIAccessible * *aFirstChild);
 
89
    NS_IMETHOD GetChildCount(PRInt32 *aAccChildCount);
 
90
 
 
91
    // return the atk object for app root accessible
 
92
    NS_IMETHOD GetNativeInterface(void **aOutAccessible);
 
93
 
 
94
    nsresult AddRootAccessible(nsRootAccessibleWrap *aRootAccWrap);
 
95
    nsresult RemoveRootAccessible(nsRootAccessibleWrap *aRootAccWrap);
 
96
private:
 
97
    nsCOMPtr<nsIMutableArray> mChildren;
 
98
    PRBool mInitialized;
 
99
};
 
100
 
 
101
#endif   /* __NS_APP_ROOT_ACCESSIBLE_H__ */