
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.LineAttributeKit in_kit) |
Check if the source LineAttributeKit is equivalent to this object. More... | |
override int | GetHashCode () |
LineAttributeKit () | |
Initializes an empty kit. More... | |
LineAttributeKit (HPS.LineAttributeKit in_kit) | |
The copy constructor creates a new LineAttributeKit object that contains the same settings as the source object. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.LineAttributeKit in_kit) |
Copies all settings from the source LineAttributeKit into this object. More... | |
HPS.LineAttributeKit | SetPattern (string in_name) |
Specifies the pattern of lines. More... | |
HPS.LineAttributeKit | SetPattern (string in_name, HPS.LinePatternOptionsKit in_options) |
Specifies the pattern of lines. More... | |
HPS.LineAttributeKit | SetWeight (float in_weight, HPS.Line.SizeUnits in_units) |
Sets the weight of lines. More... | |
HPS.LineAttributeKit | SetWeight (float in_weight) |
Sets the weight of lines. More... | |
void | Show (out HPS.LineAttributeKit out_kit) |
Copies all settings from this LineAttributeKit into the given LineAttributeKit. More... | |
bool | ShowPattern (out string out_pattern, out HPS.LinePatternOptionsKit out_options) |
Shows the pattern used to draw lines. More... | |
bool | ShowWeight (out float out_weight, out HPS.Line.SizeUnits out_units) |
Shows the weight of lines. More... | |
HPS.LineAttributeKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.LineAttributeKit | UnsetPattern () |
Removes the line pattern setting for lines. More... | |
HPS.LineAttributeKit | UnsetWeight () |
Removes the weight setting for lines. More... | |
![]() | |
Kit (HPS.Kit in_that) | |
override HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Static Public Member Functions | |
static HPS.LineAttributeKit | GetDefault () |
Creates a LineAttributeKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default. More... | |
static bool | operator!= (HPS.LineAttributeKit a, HPS.LineAttributeKit b) |
static bool | operator== (HPS.LineAttributeKit a, HPS.LineAttributeKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The HPS.LineAttributeKit class is a user space object, useful for carrying a group of attribute settings related to lines. Calling HPS.LineAttributeKit.GetDefault() will return a kit with values found in this table.
Constructor & Destructor Documentation
|
inline |
Initializes an empty kit.
|
inline |
The copy constructor creates a new LineAttributeKit object that contains the same settings as the source object.
- Parameters
-
in_kit The source object to copy.
Member Function Documentation
|
inlinevirtual |
Indicates whether this object has any values set on it.
- Returns
- true if no values are set on this object, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source LineAttributeKit is equivalent to this object.
- Parameters
-
in_kit The source LineAttributeKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinestatic |
Creates a LineAttributeKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
- Returns
- A LineAttributeKit with the default settings.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Kit.
|
inline |
Copies all settings from the source LineAttributeKit into this object.
- Parameters
-
in_kit The source LineAttributeKit to copy.
|
inline |
Specifies the pattern of lines.
- Parameters
-
in_name The name of a line pattern, defined in a portfolio that is accessible.
- Returns
- A reference to this object.
|
inline |
Specifies the pattern of lines.
- Parameters
-
in_name The name of a line pattern, defined in a portfolio that is accessible. in_options A set of options that modify how the named line pattern is applied.
- Returns
- A reference to this object.
|
inline |
Sets the weight of lines.
- Parameters
-
in_weight The weight value for lines. in_units The units applied to in_weight.
- Returns
- A reference to this object.
|
inline |
Sets the weight of lines.
- Parameters
-
in_weight The weight value for lines.
- Returns
- A reference to this object.
|
inline |
Copies all settings from this LineAttributeKit into the given LineAttributeKit.
- Parameters
-
out_kit The LineAttributeKit to populate with the contents of this object.
|
inline |
Shows the pattern used to draw lines.
- Parameters
-
out_pattern The name of a line pattern, defined in a portfolio that is accessible. out_options A set of options that modify how the named line pattern is applied.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the weight of lines.
- Parameters
-
out_weight The weight value for lines. out_units The units applied to in_weight.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Removes all settings from this object.
- Returns
- A reference to this object.
|
inline |
Removes the line pattern setting for lines.
- Returns
- A reference to this object.
|
inline |
Removes the weight setting for lines.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.LineAttributeKit.cs