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