← Back to branch summary

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

« back to all changes in this revision

Viewing changes to mozilla/accessible/src/base/nsAccessible.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/base/nsAccessible.h
 
1
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 
2
/* ***** BEGIN LICENSE BLOCK *****
 
3
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 
4
 *
 
5
 * The contents of this file are subject to the Netscape Public License
 
6
 * Version 1.1 (the "License"); you may not use this file except in
 
7
 * compliance with the License. You may obtain a copy of the License at
 
8
 * http://www.mozilla.org/NPL/
 
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) 1998
 
20
 * the Initial Developer. All Rights Reserved.
 
21
 *
 
22
 * Contributor(s):
 
23
 *      John Gaunt (jgaunt@netscape.com)
 
24
 *
 
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 NPL, 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 NPL, the GPL or the LGPL. *
 
37
 * ***** END LICENSE BLOCK ***** */
 
38
 
 
39
#ifndef _nsAccessible_H_
 
40
#define _nsAccessible_H_
 
41
 
 
42
#include "nsAccessNodeWrap.h"
 
43
#include "nsIAccessible.h"
 
44
#include "nsPIAccessible.h"
 
45
#include "nsWeakReference.h"
 
46
#include "nsIDOMNodeList.h"
 
47
#include "nsString.h"
 
48
 
 
49
struct nsRect;
 
50
class nsIContent;
 
51
class nsIFrame;
 
52
class nsIPresShell;
 
53
class nsIDOMNode;
 
54
class nsIAtom;
 
55
 
 
56
// When mNextSibling is set to this, it indicates there ar eno more siblings
 
57
#define DEAD_END_ACCESSIBLE NS_STATIC_CAST(nsIAccessible*, (void*)1)
 
58
 
 
59
class nsAccessible : public nsAccessNodeWrap, 
 
60
                     public nsIAccessible, 
 
61
                     public nsPIAccessible
 
62
{
 
63
public:
 
64
  // to eliminate the confusion of "magic numbers" -- if ( 0 ){ foo; }
 
65
  enum { eAction_Switch=0, eAction_Jump=0, eAction_Click=0, eAction_Select=0 };
 
66
  // how many actions
 
67
  enum { eNo_Action=0, eSingle_Action=1 };
 
68
 
 
69
  nsAccessible(nsIDOMNode* aNode, nsIWeakReference* aShell);
 
70
  virtual ~nsAccessible();
 
71
 
 
72
  NS_DECL_ISUPPORTS_INHERITED
 
73
  NS_DECL_NSIACCESSIBLE
 
74
  NS_DECL_NSPIACCESSIBLE
 
75
 
 
76
  static nsresult GetFocusedNode(nsIDOMNode *aCurrentNode, nsIDOMNode **aFocusedNode);
 
77
 
 
78
  // nsIAccessNode
 
79
  NS_IMETHOD Shutdown();
 
80
 
 
81
#ifdef MOZ_ACCESSIBILITY_ATK
 
82
  static nsresult GetParentBlockNode(nsIPresShell *aPresShell, nsIDOMNode *aCurrentNode, nsIDOMNode **aBlockNode);
 
83
  static nsIFrame* GetParentBlockFrame(nsIFrame *aFrame);
 
84
  static PRBool FindTextFrame(PRInt32 &index, nsIPresContext *aPresContext, nsIFrame *aCurFrame, 
 
85
                                   nsIFrame **aFirstTextFrame, const nsIFrame *aTextFrame);
 
86
#endif
 
87
 
 
88
  static PRBool IsCorrectFrameType(nsIFrame* aFrame, nsIAtom* aAtom);
 
89
 
 
90
protected:
 
91
  virtual nsIFrame* GetBoundsFrame();
 
92
  virtual void GetBoundsRect(nsRect& aRect, nsIFrame** aRelativeFrame);
 
93
  PRBool IsPartiallyVisible(PRBool *aIsOffscreen); 
 
94
  NS_IMETHOD AppendLabelText(nsIDOMNode *aLabelNode, nsAString& _retval);
 
95
  NS_IMETHOD AppendLabelFor(nsIContent *aLookNode, const nsAString *aId, nsAString *aLabel);
 
96
  NS_IMETHOD GetHTMLName(nsAString& _retval);
 
97
  NS_IMETHOD GetXULName(nsAString& _retval);
 
98
  NS_IMETHOD AppendFlatStringFromSubtree(nsIContent *aContent, nsAString *aFlatString);
 
99
  NS_IMETHOD AppendFlatStringFromContentNode(nsIContent *aContent, nsAString *aFlatString);
 
100
  NS_IMETHOD AppendStringWithSpaces(nsAString *aFlatString, const nsAString& textEquivalent);
 
101
 
 
102
  // helper method to verify frames
 
103
  static nsresult GetFullKeyName(const nsAString& aModifierName, const nsAString& aKeyName, nsAString& aStringOut);
 
104
  static nsresult GetTranslatedString(const nsAString& aKey, nsAString& aStringOut);
 
105
  void GetScrollOffset(nsRect *aRect);
 
106
  void GetScreenOrigin(nsIPresContext *aPresContext, nsIFrame *aFrame, nsRect *aRect);
 
107
  nsresult AppendFlatStringFromSubtreeRecurse(nsIContent *aContent, nsAString *aFlatString);
 
108
  void CacheChildren(PRBool aWalkNormalDOM);
 
109
 
 
110
  // Data Members
 
111
  nsCOMPtr<nsIAccessible> mParent;
 
112
  nsIAccessible *mFirstChild, *mNextSibling;
 
113
};
 
114
 
 
115
#endif  
 
116