0031939: Coding - correction of spelling errors in comments [part 4]
[occt.git] / src / IFSelect / IFSelect_ParamEditor.hxx
1 // Created on: 1998-07-30
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_ParamEditor_HeaderFile
18 #define _IFSelect_ParamEditor_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <TCollection_AsciiString.hxx>
24 #include <IFSelect_Editor.hxx>
25 #include <Standard_Integer.hxx>
26 #include <Standard_CString.hxx>
27 #include <Standard_Boolean.hxx>
28 #include <TColStd_HSequenceOfHAsciiString.hxx>
29 class Interface_TypedValue;
30 class TCollection_AsciiString;
31 class IFSelect_EditForm;
32 class TCollection_HAsciiString;
33 class Standard_Transient;
34 class Interface_InterfaceModel;
35
36 class IFSelect_ParamEditor;
37 DEFINE_STANDARD_HANDLE(IFSelect_ParamEditor, IFSelect_Editor)
38
39 //! A ParamEditor gives access for edition to a list of TypedValue
40 //! (i.e. of Static too)
41 //! Its definition is made of the TypedValue to edit themselves,
42 //! and can add some constants, which can then be displayed but
43 //! not changed (for instance, system name, processor version ...)
44 //!
45 //! I.E. it gives a way of editing or at least displaying
46 //! parameters as global
47 class IFSelect_ParamEditor : public IFSelect_Editor
48 {
49
50 public:
51
52   //! Creates a ParamEditor, empty, with a maximum count of params
53   //! (default is 100)
54   //! And a label, by default it will be "Param Editor"
55   Standard_EXPORT IFSelect_ParamEditor(const Standard_Integer nbmax = 100, const Standard_CString label = "");
56
57   //! Adds a TypedValue
58   //! By default, its short name equates its complete name, it can be made explicit
59   Standard_EXPORT void AddValue (const Handle(Interface_TypedValue)& val,
60                                  const Standard_CString shortname = "");
61
62   //! Adds a Constant Text, it will be Read Only
63   //! By default, its long name equates its shortname
64   Standard_EXPORT void AddConstantText (const Standard_CString val, const Standard_CString shortname, const Standard_CString completename = "");
65   
66   Standard_EXPORT TCollection_AsciiString Label() const Standard_OVERRIDE;
67   
68   Standard_EXPORT Standard_Boolean Recognize (const Handle(IFSelect_EditForm)& form) const Standard_OVERRIDE;
69   
70   Standard_EXPORT Handle(TCollection_HAsciiString) StringValue (const Handle(IFSelect_EditForm)& form, const Standard_Integer num) const Standard_OVERRIDE;
71   
72   Standard_EXPORT Standard_Boolean Load (const Handle(IFSelect_EditForm)& form, const Handle(Standard_Transient)& ent, const Handle(Interface_InterfaceModel)& model) const Standard_OVERRIDE;
73   
74   Standard_EXPORT Standard_Boolean Apply (const Handle(IFSelect_EditForm)& form, const Handle(Standard_Transient)& ent, const Handle(Interface_InterfaceModel)& model) const Standard_OVERRIDE;
75   
76   //! Returns a ParamEditor to work on the Static Parameters of
77   //! which names are listed in <list>
78   //! Null Handle if <list> is null or empty
79   Standard_EXPORT static Handle(IFSelect_ParamEditor) StaticEditor (const Handle(TColStd_HSequenceOfHAsciiString)& list, const Standard_CString label = "");
80
81   DEFINE_STANDARD_RTTIEXT(IFSelect_ParamEditor,IFSelect_Editor)
82
83 private:
84
85   TCollection_AsciiString thelabel;
86
87 };
88
89 #endif // _IFSelect_ParamEditor_HeaderFile