1 -- Created on: 1995-01-13
3 -- Copyright (c) 1995-1999 Matra Datavision
4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
6 -- This file is part of Open CASCADE Technology software library.
8 -- This library is free software; you can redistribute it and / or modify it
9 -- under the terms of the GNU Lesser General Public 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.
14 -- Alternatively, this file may be used under the terms of Open CASCADE
15 -- commercial license or contractual agreement.
17 class MarkMapEntry from Aspect
21 ---Purpose: This class defines a markmap entrys.
22 -- A markmap entry is an association between
23 -- a MarkerStyle object and an index in the markmap.
29 MarkerStyle from Aspect
36 returns MarkMapEntry from Aspect;
38 ---Purpose: Creates an unallocated markmap entry
40 Create ( index : Integer from Standard;
41 style : MarkerStyle from Aspect)
44 ---Purpose: Creates an allocated markmap entry
46 Create ( entry : MarkMapEntry from Aspect )
49 ---Purpose: Creates an allocated markmap entry.
50 -- Warning: Raises error if the markmap entry <entry>
52 raises BadAccess from Aspect;
54 SetValue ( me: in out; index : Integer from Standard;
55 style : MarkerStyle from Aspect );
57 ---Purpose: Sets markmap entry value and allocates it.
59 SetValue ( me: in out; entry : MarkMapEntry from Aspect);
61 ---Purpose: Sets markmap entry value and allocates it.
62 ---C++: alias operator =
64 SetStyle ( me: in out; Style : MarkerStyle from Aspect );
66 ---Purpose: Sets the marker style of markmap entry.
68 Style ( me ) returns MarkerStyle from Aspect
69 ---Warning: Raises error if the markmap entry is unallocated .
70 raises BadAccess from Aspect;
71 ---C++: return const &
73 SetIndex ( me: in out; index : Integer from Standard);
75 ---Purpose: Sets index value of a markmap entry.
77 Index ( me ) returns Integer from Standard
79 ---Purpose: Returns index value of a markmap entry.
80 -- Warning: Raises error if the markmap entry is unallocated .
81 raises BadAccess from Aspect;
85 ---Purpose: Unallocates the markmap entry.
87 IsAllocated ( me ) returns Boolean from Standard;
89 ---Purpose: Returns True if the markmap entry is allocated.
90 -- Warning: A markmap entry is allocated when the marker and
91 -- the index is defined.
97 MyStyle : MarkerStyle from Aspect;
98 MyIndex : Integer from Standard;
99 MyStyleIsDef : Boolean from Standard;
100 MyIndexIsDef : Boolean from Standard;
102 end MarkMapEntry from Aspect;