include/comphelper/container.hxx

   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 #ifndef INCLUDED_COMPHELPER_CONTAINER_HXX
  21 #define INCLUDED_COMPHELPER_CONTAINER_HXX
  22
  23 #include <vector>
  24 #include <com/sun/star/uno/Reference.hxx>
  25 #include <comphelper/comphelperdllapi.h>
  26
  27
  28 namespace comphelper
  29 {
  30
  31
  32 //= IndexAccessIterator
  33
  34 /** an iterator that iterates through all elements, starting from an XIndexAccess (pre-order)
  35 */
  36 class COMPHELPER_DLLPUBLIC IndexAccessIterator
  37 {
  38 protected:
  39     css::uno::Reference< css::uno::XInterface>    m_xStartingPoint;
  40
  41     css::uno::Reference< css::uno::XInterface>    m_xCurrentObject;
  42         // The current object
  43     ::std::vector<sal_Int32>                      m_arrChildIndizies;
  44
  45         // I'm moving through a tree, but its elements have no GetNextSibling,
  46         // so I have to remember where each child is in relation to its parent.
  47         // That is the path from the root node to m_xCurrentObject
  48
  49 public:
  50     IndexAccessIterator(css::uno::Reference< css::uno::XInterface> xStartingPoint);
  51
  52     virtual ~IndexAccessIterator();
  53
  54     css::uno::Reference< css::uno::XInterface> const &    Next();
  55
  56     virtual void Invalidate() { m_xCurrentObject = nullptr; }
  57
  58 protected:
  59     virtual bool ShouldHandleElement(const css::uno::Reference< css::uno::XInterface>& /*rElement*/) { return true; }
  60
  61         // This can be used to exclude certain elements; elements for which
  62         // this function returns sal_True will be simply skipped.
  63         // If this element is returned from Next(), then one can get
  64         // here get a little more information on the element.
  65         // That's why this method is not const.
  66     virtual bool ShouldStepInto(const css::uno::Reference< css::uno::XInterface>& /*xContainer*/) const { return true; }
  67 };
  68
  69
  70 }   // namespace comphelper
  71
  72
  73 #endif // INCLUDED_COMPHELPER_CONTAINER_HXX
  74
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */