1 : /* ***** BEGIN LICENSE BLOCK *****
2 : * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3 : *
4 : * The contents of this file are subject to the Mozilla Public License Version
5 : * 1.1 (the "License"); you may not use this file except in compliance with
6 : * the License. You may obtain a copy of the License at
7 : * http://www.mozilla.org/MPL/
8 : *
9 : * Software distributed under the License is distributed on an "AS IS" basis,
10 : * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11 : * for the specific language governing rights and limitations under the
12 : * License.
13 : *
14 : * The Original Code is mozilla.org code.
15 : *
16 : * The Initial Developer of the Original Code is
17 : * Mozilla Foundation.
18 : * Portions created by the Initial Developer are Copyright (C) 2010
19 : * the Initial Developer. All Rights Reserved.
20 : *
21 : * Contributor(s):
22 : * Alexander Surkov <surkov.alexander@gmail.com> (original author)
23 : *
24 : * Alternatively, the contents of this file may be used under the terms of
25 : * either the GNU General Public License Version 2 or later (the "GPL"), or
26 : * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 : * in which case the provisions of the GPL or the LGPL are applicable instead
28 : * of those above. If you wish to allow use of your version of this file only
29 : * under the terms of either the GPL or the LGPL, and not to allow others to
30 : * use your version of this file under the terms of the MPL, indicate your
31 : * decision by deleting the provisions above and replace them with the notice
32 : * and other provisions required by the GPL or the LGPL. If you do not delete
33 : * the provisions above, a recipient may use your version of this file under
34 : * the terms of any one of the MPL, the GPL or the LGPL.
35 : *
36 : * ***** END LICENSE BLOCK ***** */
37 :
38 : #ifndef AccCollector_h_
39 : #define AccCollector_h_
40 :
41 : #include "filters.h"
42 :
43 : #include "nscore.h"
44 : #include "nsTArray.h"
45 :
46 : /**
47 : * Collect accessible children complying with filter function. Provides quick
48 : * access to accessible by index.
49 : */
50 : class AccCollector
51 : {
52 : public:
53 : AccCollector(nsAccessible* aRoot, filters::FilterFuncPtr aFilterFunc);
54 : virtual ~AccCollector();
55 :
56 : /**
57 : * Return accessible count within the collection.
58 : */
59 : PRUint32 Count();
60 :
61 : /**
62 : * Return an accessible from the collection at the given index.
63 : */
64 : nsAccessible* GetAccessibleAt(PRUint32 aIndex);
65 :
66 : /**
67 : * Return index of the given accessible within the collection.
68 : */
69 : virtual PRInt32 GetIndexAt(nsAccessible* aAccessible);
70 :
71 : protected:
72 : /**
73 : * Ensure accessible at the given index is stored and return it.
74 : */
75 : nsAccessible* EnsureNGetObject(PRUint32 aIndex);
76 :
77 : /**
78 : * Ensure index for the given accessible is stored and return it.
79 : */
80 : PRInt32 EnsureNGetIndex(nsAccessible* aAccessible);
81 :
82 : /**
83 : * Append the object to collection.
84 : */
85 : virtual void AppendObject(nsAccessible* aAccessible);
86 :
87 : filters::FilterFuncPtr mFilterFunc;
88 : nsAccessible* mRoot;
89 : PRInt32 mRootChildIdx;
90 :
91 : nsTArray<nsAccessible*> mObjects;
92 :
93 : private:
94 : AccCollector();
95 : AccCollector(const AccCollector&);
96 : AccCollector& operator =(const AccCollector&);
97 : };
98 :
99 : /**
100 : * Collect embedded objects. Provide quick access to accessible by index and
101 : * vice versa.
102 : */
103 : class EmbeddedObjCollector : public AccCollector
104 : {
105 : public:
106 0 : virtual ~EmbeddedObjCollector() { };
107 :
108 : public:
109 : virtual PRInt32 GetIndexAt(nsAccessible* aAccessible);
110 :
111 : protected:
112 : // Make sure it's used by nsAccessible class only.
113 0 : EmbeddedObjCollector(nsAccessible* aRoot) :
114 0 : AccCollector(aRoot, filters::GetEmbeddedObject) { }
115 :
116 : virtual void AppendObject(nsAccessible* aAccessible);
117 :
118 : friend class nsAccessible;
119 : };
120 :
121 : #endif
|