office-gobmx/include/comphelper/container.hxx
Bjoern Michaelsen b9337e22ce execute move of global headers
see https://gerrit.libreoffice.org/#/c/3367/
and Change-Id: I00c96fa77d04b33a6f8c8cd3490dfcd9bdc9e84a for details

Change-Id: I199a75bc4042af20817265d5ef85b1134a96ff5a
2013-04-23 22:20:31 +02:00

80 lines
3.3 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef _COMPHELPER_CONTAINER_HXX_
#define _COMPHELPER_CONTAINER_HXX_
#include <vector>
#include "com/sun/star/uno/Reference.hxx"
#include "comphelper/comphelperdllapi.h"
//.........................................................................
namespace comphelper
{
//.........................................................................
//========================================================================
//= IndexAccessIterator
//========================================================================
/** an iterator that iterates through all elements, starting from an XIndexAccess (pre-order)
*/
class COMPHELPER_DLLPUBLIC IndexAccessIterator
{
protected:
::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface> m_xStartingPoint;
::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface> m_xCurrentObject;
// The current object
::std::vector<sal_Int32> m_arrChildIndizies;
// I'm moving through a tree, but its elements have no GetNextSibling,
// so I have to remember where each child is in relation to its parent.
// That is the path from the root node to m_xCurrentObject
OUString m_ustrProperty;
// The Name of the requested property
public:
IndexAccessIterator(::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface> xStartingPoint);
virtual ~IndexAccessIterator();
::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface> Next();
virtual void Invalidate() { m_xCurrentObject = NULL; }
protected:
virtual sal_Bool ShouldHandleElement(const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface>& /*rElement*/) { return sal_True; }
// This can be used to exclude certain elements; elements for which
// this function returns sal_True will be simply skipped.
// If this element is returned from Next(), then one can get
// here get a little more information on the element.
// That's why this method is not const.
virtual sal_Bool ShouldStepInto(const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface>& /*xContainer*/) const { return sal_True; }
};
//.........................................................................
} // namespace comphelper
//.........................................................................
#endif // _COMPHELPER_CONTAINER_HXX_
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */