Back to index

salome-kernel  6.5.0
DF_ChildIterator.hxx
Go to the documentation of this file.
00001 // Copyright (C) 2007-2012  CEA/DEN, EDF R&D, OPEN CASCADE
00002 //
00003 // This library is free software; you can redistribute it and/or
00004 // modify it under the terms of the GNU Lesser General Public
00005 // License as published by the Free Software Foundation; either
00006 // version 2.1 of the License.
00007 //
00008 // This library is distributed in the hope that it will be useful,
00009 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00010 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00011 // Lesser General Public License for more details.
00012 //
00013 // You should have received a copy of the GNU Lesser General Public
00014 // License along with this library; if not, write to the Free Software
00015 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
00016 //
00017 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
00018 //
00019 
00020 #ifndef DFCHILDITERATOR_HXX
00021 #define DFCHILDITERATOR_HXX
00022 
00023 #include "DF_definitions.hxx"
00024 #include "DF_Label.hxx"
00025 
00026 #include <string>
00027 
00028 //Class DF_ChildIterator is used to iterate a tree of Labels in the Document
00029 class DF_ChildIterator {
00030 public:
00031   //Constructor
00032   Standard_EXPORT DF_ChildIterator(const DF_Label& theLabel, bool allLevels = false);
00033 
00034   Standard_EXPORT DF_ChildIterator();
00035 
00036   Standard_EXPORT ~DF_ChildIterator();
00037 
00038   //Initializes the iterator, if allLevels is true the iterator before iterating the next
00039   //brother of the current Label iterates the Label children
00040   Standard_EXPORT void Init(const DF_Label& theLabel, bool allLevels = false);
00041 
00042   //Returns a current Label
00043   Standard_EXPORT DF_Label Value();
00044 
00045   //Returns true if there is a current Label
00046   Standard_EXPORT bool More();
00047 
00048   //Moves to the next Label
00049   Standard_EXPORT void Next();
00050 
00051 private:
00052   DF_LabelNode*    _root;
00053   DF_LabelNode*    _current;
00054   bool             _allLevels;
00055 };
00056 
00057 #endif