0031939: Coding - correction of spelling errors in comments [part 4]
[occt.git] / src / IFSelect / IFSelect_SelectionIterator.hxx
1 // Created on: 1992-11-17
2 // Created by: Christian CAILLET
3 // Copyright (c) 1992-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _IFSelect_SelectionIterator_HeaderFile
18 #define _IFSelect_SelectionIterator_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Standard_Integer.hxx>
25 #include <IFSelect_HSeqOfSelection.hxx>
26 #include <IFSelect_TSeqOfSelection.hxx>
27 #include <Standard_Boolean.hxx>
28 class Standard_NoSuchObject;
29 class IFSelect_Selection;
30
31 //! Defines an Iterator on a list of Selections
32 class IFSelect_SelectionIterator 
33 {
34 public:
35
36   DEFINE_STANDARD_ALLOC
37
38   //! Creates an empty iterator, ready to be filled
39   Standard_EXPORT IFSelect_SelectionIterator();
40   
41   //! Creates an iterator from a Selection : it lists the Selections
42   //! from which <sel> depends (given by its method FillIterator)
43   Standard_EXPORT IFSelect_SelectionIterator(const Handle(IFSelect_Selection)& sel);
44   
45   //! Adds to an iterator the content of another one
46   //! (each selection is present only once in the result)
47   Standard_EXPORT void AddFromIter (IFSelect_SelectionIterator& iter);
48   
49   //! Adds a Selection to an iterator (if not yet noted)
50   Standard_EXPORT void AddItem (const Handle(IFSelect_Selection)& sel);
51   
52   //! Adds a list of Selections to an iterator (this list comes
53   //! from the description of a Selection or a Dispatch, etc...)
54   Standard_EXPORT void AddList (const IFSelect_TSeqOfSelection& list);
55   
56   //! Returns True if there are more Selections to get
57   Standard_EXPORT Standard_Boolean More() const;
58   
59   //! Sets iterator to the next item
60   Standard_EXPORT void Next();
61
62   //! Returns the current Selection being iterated
63   //! Error if count of Selection has been passed
64   Standard_EXPORT const Handle(IFSelect_Selection)& Value() const;
65
66 private:
67
68   Standard_Integer thecurr;
69   Handle(IFSelect_HSeqOfSelection) thelist;
70
71 };
72
73 #endif // _IFSelect_SelectionIterator_HeaderFile