/src/libreoffice/include/comphelper/container.hxx
Line | Count | Source |
1 | | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ |
2 | | /* |
3 | | * This file is part of the LibreOffice project. |
4 | | * |
5 | | * This Source Code Form is subject to the terms of the Mozilla Public |
6 | | * License, v. 2.0. If a copy of the MPL was not distributed with this |
7 | | * file, You can obtain one at http://mozilla.org/MPL/2.0/. |
8 | | * |
9 | | * This file incorporates work covered by the following license notice: |
10 | | * |
11 | | * Licensed to the Apache Software Foundation (ASF) under one or more |
12 | | * contributor license agreements. See the NOTICE file distributed |
13 | | * with this work for additional information regarding copyright |
14 | | * ownership. The ASF licenses this file to you under the Apache |
15 | | * License, Version 2.0 (the "License"); you may not use this file |
16 | | * except in compliance with the License. You may obtain a copy of |
17 | | * the License at http://www.apache.org/licenses/LICENSE-2.0 . |
18 | | */ |
19 | | |
20 | | #pragma once |
21 | | |
22 | | #include <vector> |
23 | | #include <com/sun/star/uno/Reference.hxx> |
24 | | #include <comphelper/comphelperdllapi.h> |
25 | | |
26 | | |
27 | | namespace comphelper |
28 | | { |
29 | | |
30 | | |
31 | | //= IndexAccessIterator |
32 | | |
33 | | /** an iterator that iterates through all elements, starting from an XIndexAccess (pre-order) |
34 | | */ |
35 | | class COMPHELPER_DLLPUBLIC IndexAccessIterator |
36 | | { |
37 | | protected: |
38 | | css::uno::Reference< css::uno::XInterface> m_xStartingPoint; |
39 | | |
40 | | css::uno::Reference< css::uno::XInterface> m_xCurrentObject; |
41 | | // The current object |
42 | | ::std::vector<sal_Int32> m_arrChildIndizies; |
43 | | |
44 | | // I'm moving through a tree, but its elements have no GetNextSibling, |
45 | | // so I have to remember where each child is in relation to its parent. |
46 | | // That is the path from the root node to m_xCurrentObject |
47 | | |
48 | | public: |
49 | | IndexAccessIterator(css::uno::Reference< css::uno::XInterface> xStartingPoint); |
50 | | |
51 | | virtual ~IndexAccessIterator(); |
52 | | |
53 | | css::uno::Reference< css::uno::XInterface> const & Next(); |
54 | | |
55 | 0 | virtual void Invalidate() { m_xCurrentObject = nullptr; } |
56 | | |
57 | | protected: |
58 | 0 | virtual bool ShouldHandleElement(const css::uno::Reference< css::uno::XInterface>& /*rElement*/) { return true; } |
59 | | |
60 | | // This can be used to exclude certain elements; elements for which |
61 | | // this function returns sal_True will be simply skipped. |
62 | | // If this element is returned from Next(), then one can get |
63 | | // here get a little more information on the element. |
64 | | // That's why this method is not const. |
65 | 0 | virtual bool ShouldStepInto(const css::uno::Reference< css::uno::XInterface>& /*xContainer*/) const { return true; } |
66 | | }; |
67 | | |
68 | | |
69 | | } // namespace comphelper |
70 | | |
71 | | /* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |