42cf5bc1 |
1 | // Created by: DAUTRY Philippe |
2 | // Copyright (c) 1997-1999 Matra Datavision |
3 | // Copyright (c) 1999-2014 OPEN CASCADE SAS |
4 | // |
5 | // This file is part of Open CASCADE Technology software library. |
6 | // |
7 | // This library is free software; you can redistribute it and/or modify it under |
8 | // the terms of the GNU Lesser General Public License version 2.1 as published |
9 | // by the Free Software Foundation, with special exception defined in the file |
10 | // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT |
11 | // distribution for complete text of the license and disclaimer of any warranty. |
12 | // |
13 | // Alternatively, this file may be used under the terms of Open CASCADE |
14 | // commercial license or contractual agreement. |
15 | |
16 | #ifndef _TDocStd_XLinkIterator_HeaderFile |
17 | #define _TDocStd_XLinkIterator_HeaderFile |
18 | |
19 | #include <Standard.hxx> |
20 | #include <Standard_DefineAlloc.hxx> |
21 | #include <Standard_Handle.hxx> |
22 | |
23 | #include <TDocStd_XLinkPtr.hxx> |
24 | #include <Standard_Boolean.hxx> |
25 | class Standard_NoMoreObject; |
26 | class TDocStd_Document; |
27 | |
28 | |
29 | //! Iterates on Reference attributes. |
30 | //! This is an iterator giving all the external references |
31 | //! of a Document. |
32 | class TDocStd_XLinkIterator |
33 | { |
34 | public: |
35 | |
36 | DEFINE_STANDARD_ALLOC |
37 | |
38 | |
39 | //! Returns an empty iterator; |
40 | Standard_EXPORT TDocStd_XLinkIterator(); |
41 | |
42 | //! Creates an iterator on Reference of <D>. |
43 | Standard_EXPORT TDocStd_XLinkIterator(const Handle(TDocStd_Document)& D); |
44 | |
45 | //! Restarts an iteration with <D>. |
46 | Standard_EXPORT void Initialize (const Handle(TDocStd_Document)& D); |
47 | |
48 | //! Returns True if there is a current Item in the |
49 | //! iteration. |
50 | Standard_Boolean More() const; |
51 | |
52 | //! Move to the next item; raises if there is no more item. |
53 | Standard_EXPORT void Next(); |
54 | |
55 | //! Returns the current item; a null handle if there is none. |
56 | TDocStd_XLinkPtr Value() const; |
57 | |
58 | |
59 | |
60 | |
61 | protected: |
62 | |
63 | |
64 | |
65 | |
66 | |
67 | private: |
68 | |
69 | |
70 | Standard_EXPORT void Init (const Handle(TDocStd_Document)& D); |
71 | |
72 | |
73 | TDocStd_XLinkPtr myValue; |
74 | |
75 | |
76 | }; |
77 | |
78 | |
79 | #include <TDocStd_XLinkIterator.lxx> |
80 | |
81 | |
82 | |
83 | |
84 | |
85 | #endif // _TDocStd_XLinkIterator_HeaderFile |