Class TSFString
Unit
Declaration
type TSFString = class(TX3DSingleField)
Description
X3D field containing a single string.
Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 642).
Hierarchy
- TObject
- TPersistent
- TX3DFileItem
- TX3DFieldOrEvent
- TX3DField
- TX3DSingleField
- TSFString
Overview
Methods
| Public | constructor Create(const AParentNode: TX3DFileItem; const AExposed: boolean; const AName: String; const AValue: String); |
| Public | procedure ParseValue(Lexer: TX3DLexer; Reader: TX3DReader); override; |
| Public | function EqualsDefaultValue: boolean; override; |
| Public | function Equals(SecondValue: TX3DField): boolean; override; |
| Public | function FastEqualsValue(SecondValue: TX3DField): boolean; override; |
| Public | procedure Assign(Source: TPersistent); override; |
| Public | procedure AssignValue(Source: TX3DField); override; |
| Public | procedure AssignDefaultValueFromValue; override; |
| Public | procedure UnassignDefaultValue; override; |
| Public | class function X3DType: String; override; |
| Public | class function CreateEvent(const AParentNode: TX3DFileItem; const AName: String; const AInEvent: boolean): TX3DEvent; override; |
| Public | procedure ParseXMLAttribute(const AttributeValue: String; Reader: TX3DReader); override; |
| Public | function SaveToXmlValue: TSaveToXmlMethod; override; |
| Public | procedure Send(const AValue: String); overload; |
Properties
| Public | property DefaultValue: String read FDefaultValue write SetDefaultValue; |
| Public | property DefaultValueExists: boolean
read FDefaultValueExists write FDefaultValueExists; |
| Public | property Value: String read FValue write SetValue; |
Description
Methods
| Public | constructor Create(const AParentNode: TX3DFileItem; const AExposed: boolean; const AName: String; const AValue: String); |
|
This item has no description. Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 657). | |
| Public | procedure ParseValue(Lexer: TX3DLexer; Reader: TX3DReader); override; |
|
This item has no description. Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 660). | |
| Public | function EqualsDefaultValue: boolean; override; |
|
This item has no description. Showing description inherited from TX3DField.EqualsDefaultValue.
Whether the value is equal to default. Returns always Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 662). | |
| Public | function Equals(SecondValue: TX3DField): boolean; override; |
|
This item has no description. Showing description inherited from TX3DField.Equals.
All descendants (that add some property that should be compared) should override this like Result := (inherited Equals(SecondValue)) and (SecondValue is TMyType) and (TMyType(SecondValue).MyProperty = MyProperty);
The floating-point fields may be compared with a small epsilon tolerance by this method. Note that this *doesn't* compare the default values of two fields instances. This compares only the current values of two fields instances, and eventually some other properties that affect parsing (like names for TSFEnum and TSFBitMask) or allowed future values (like TSFFloat.MustBeNonnegative). Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 663). | |
| Public | function FastEqualsValue(SecondValue: TX3DField): boolean; override; |
|
This item has no description. Showing description inherited from TX3DField.FastEqualsValue. Compare value of this field, with other field, fast. This compares only the values of the fields, not other properties (it doesn't care about names of the fields or such, or default values; only current values). In other words, it compares only the things copied by AssignValue. This tries to compare very fast, which means that for large (multi-valued) fields it may give up and answer Default implementation in this class ( Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 664). | |
| Public | procedure Assign(Source: TPersistent); override; |
|
This item has no description. Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 666). | |
| Public | procedure AssignValue(Source: TX3DField); override; |
|
This item has no description. Showing description inherited from TX3DField.AssignValue. Copies the current field value. Contrary to TPersistent.Assign, this doesn't copy the rest of properties. After setting, our ValueFromIsClause is always changed to
Descendants implementors notes: In this class, implementation takes care of setting our ValueFromIsClause to if Source is <appropriate class> then begin inherited; Value := Source.value; end else AssignValueRaiseInvalidClass(Source); Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 667). | |
| Public | procedure AssignDefaultValueFromValue; override; |
|
This item has no description. Showing description inherited from TX3DField.AssignDefaultValueFromValue. Set field's default value from the current value. Note that for now this doesn't guarantee that every possible field's value can be stored as default value. In case of trouble, it will silently record "no default is known" information, so e.g. EqualsDefaultValue will always return Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 668). | |
| Public | procedure UnassignDefaultValue; override; |
|
This item has no description. Showing description inherited from TX3DField.UnassignDefaultValue.
Remove default value, recording that "no default is known". In effect EqualsDefaultValue will always return Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 669). | |
| Public | class function X3DType: String; override; |
|
This item has no description. Showing description inherited from TX3DField.X3DType.
Field type in X3D, like Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 671). | |
| Public | class function CreateEvent(const AParentNode: TX3DFileItem; const AName: String; const AInEvent: boolean): TX3DEvent; override; |
|
This item has no description. Showing description inherited from TX3DField.CreateEvent. Create TX3DEvent descendant suitable as exposed event for this field. Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 672). | |
| Public | procedure ParseXMLAttribute(const AttributeValue: String; Reader: TX3DReader); override; |
|
This item has no description. Showing description inherited from TX3DField.ParseXMLAttribute. Parse field value from X3D XML encoded attribute. Implementation in this class creates a Lexer to parse the string, and calls ParseXMLAttributeLexer. Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 674). | |
| Public | function SaveToXmlValue: TSaveToXmlMethod; override; |
|
This item has no description. Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 675). | |
| Public | procedure Send(const AValue: String); overload; |
|
This item has no description. Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 677). | |
Properties
| Public | property DefaultValue: String read FDefaultValue write SetDefaultValue; |
|
This item has no description. Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 652). | |
| Public | property DefaultValueExists: boolean
read FDefaultValueExists write FDefaultValueExists; |
|
This item has no description. Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 653). | |
| Public | property Value: String read FValue write SetValue; |
|
This item has no description. Source: scene/x3d/castlefields_x3dsinglefield_descendants.inc (line 655). | |
Generated by PasDoc 0.17.0.snapshot.