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) 2003
20 : * the Initial Developer. All Rights Reserved.
21 : *
22 : * Contributor(s):
23 : * Aaron Leventhal <aaronleventhal@moonset.net> (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 of the GNU General Public License Version 2 or later (the "GPL"),
28 : * or 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 : #ifndef _nsAccTreeWalker_H_
41 : #define _nsAccTreeWalker_H_
42 :
43 : #include "nsAutoPtr.h"
44 : #include "nsIContent.h"
45 :
46 : class nsAccessible;
47 : class nsDocAccessible;
48 : struct WalkState;
49 :
50 : /**
51 : * This class is used to walk the DOM tree to create accessible tree.
52 : */
53 : class nsAccTreeWalker
54 : {
55 : public:
56 : nsAccTreeWalker(nsDocAccessible* aDoc, nsIContent* aNode,
57 : bool aWalkAnonymousContent, bool aWalkCache = false);
58 : virtual ~nsAccTreeWalker();
59 :
60 : /**
61 : * Return the next child accessible.
62 : *
63 : * @note Returned accessible is bound to the document, if the accessible is
64 : * rejected during tree creation then the caller should be unbind it
65 : * from the document.
66 : */
67 0 : inline nsAccessible* NextChild()
68 : {
69 0 : return NextChildInternal(false);
70 : }
71 :
72 : private:
73 :
74 : /**
75 : * Return the next child accessible.
76 : *
77 : * @param aNoWalkUp [in] specifies the walk direction, true means we
78 : * shouldn't go up through the tree if we failed find
79 : * accessible children.
80 : */
81 : nsAccessible* NextChildInternal(bool aNoWalkUp);
82 :
83 : /**
84 : * Create new state for the given node and push it on top of stack.
85 : *
86 : * @note State stack is used to navigate up/down the DOM subtree during
87 : * accessible children search.
88 : */
89 : bool PushState(nsIContent *aNode);
90 :
91 : /**
92 : * Pop state from stack.
93 : */
94 : void PopState();
95 :
96 : nsDocAccessible* mDoc;
97 : PRInt32 mChildFilter;
98 : bool mWalkCache;
99 : WalkState* mState;
100 : };
101 :
102 : #endif
|