0026377: Passing Handle objects as arguments to functions as non-const reference...
[occt.git] / src / IFSelect / IFSelect_SignMultiple.hxx
1 // Created on: 1998-01-28
2 // Created by: Christian CAILLET
3 // Copyright (c) 1998-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_SignMultiple_HeaderFile
18 #define _IFSelect_SignMultiple_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <TColStd_SequenceOfTransient.hxx>
24 #include <TColStd_SequenceOfInteger.hxx>
25 #include <IFSelect_Signature.hxx>
26 #include <Standard_CString.hxx>
27 #include <Standard_Integer.hxx>
28 #include <Standard_Boolean.hxx>
29 class IFSelect_Signature;
30 class Standard_Transient;
31 class Interface_InterfaceModel;
32 class TCollection_AsciiString;
33
34
35 class IFSelect_SignMultiple;
36 DEFINE_STANDARD_HANDLE(IFSelect_SignMultiple, IFSelect_Signature)
37
38 //! Multiple Signature : ordered list of other Signatures
39 //! It concatenates on a same line the result of its sub-items
40 //! separated by sets of 3 blanks
41 //! It is possible to define tabulations between sub-items
42 //! Moreover, match rules are specific
43 class IFSelect_SignMultiple : public IFSelect_Signature
44 {
45
46 public:
47
48   
49   //! Creates an empty SignMultiple with a Name
50   //! This name should take expected tabulations into account
51   Standard_EXPORT IFSelect_SignMultiple(const Standard_CString name);
52   
53   //! Adds a Signature. Width, if given, gives the tabulation
54   //! If <maxi> is True, it is a forced tabulation (overlength is
55   //! replaced by a final dot)
56   //! If <maxi> is False, just 3 blanks follow an overlength
57   Standard_EXPORT void Add (const Handle(IFSelect_Signature)& subsign, const Standard_Integer width = 0, const Standard_Boolean maxi = Standard_False);
58   
59   //! Concatenates the values of sub-signatures, with their
60   //! tabulations
61   Standard_EXPORT Standard_CString Value (const Handle(Standard_Transient)& ent, const Handle(Interface_InterfaceModel)& model) const Standard_OVERRIDE;
62   
63   //! Specialized Match Rule
64   //! If <exact> is False, simply checks if at least one sub-item
65   //! matches
66   //! If <exact> is True, standard match with Value
67   //! (i.e. tabulations must be respected)
68   Standard_EXPORT virtual Standard_Boolean Matches (const Handle(Standard_Transient)& ent, const Handle(Interface_InterfaceModel)& model, const TCollection_AsciiString& text, const Standard_Boolean exact) const Standard_OVERRIDE;
69
70
71
72
73   DEFINE_STANDARD_RTTIEXT(IFSelect_SignMultiple,IFSelect_Signature)
74
75 protected:
76
77
78
79
80 private:
81
82
83   TColStd_SequenceOfTransient thesubs;
84   TColStd_SequenceOfInteger thetabs;
85
86
87 };
88
89
90
91
92
93
94
95 #endif // _IFSelect_SignMultiple_HeaderFile