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. More...
Public Member Functions | |
override void | Dispose () |
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... | |
void | Show (out HPS.LineAttributeKit out_kit) |
Copies all settings from this LineAttributeKit into the given LineAttributeKit. More... | |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.LineAttributeKit in_kit) |
Check if the source LineAttributeKit is equivalent to 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... | |
HPS.LineAttributeKit | UnsetPattern () |
Removes the line pattern setting for lines. More... | |
HPS.LineAttributeKit | UnsetWeight () |
Removes the weight setting for lines. More... | |
HPS.LineAttributeKit | UnsetEverything () |
Removes all settings from this object. 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... | |
![]() | |
IntPtr | GetClassID () |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
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... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
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... | |
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 | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
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.
|
inline |
Initializes an empty kit.
|
inline |
The copy constructor creates a new LineAttributeKit object that contains the same settings as the source object.
in_kit | The source object to copy. |
|
inlinevirtual |
Indicates whether this object has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source LineAttributeKit is equivalent to this object.
in_kit | The source <ref refid="class_h_p_s_1_1_line_attribute_kit" kindref="compound">LineAttributeKit</ref> to compare to this object. |
|
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.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
|
inline |
Copies all settings from the source LineAttributeKit into this object.
in_kit | The source <ref refid="class_h_p_s_1_1_line_attribute_kit" kindref="compound">LineAttributeKit</ref> to copy. |
|
inline |
Specifies the pattern of lines.
in_name | The name of a line pattern, defined in a portfolio that is accessible. |
|
inline |
Specifies the pattern of lines.
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. |
|
inline |
Sets the weight of lines.
in_weight | The weight value for lines. |
in_units | The units applied to in_weight. |
|
inline |
Sets the weight of lines.
in_weight | The weight value for lines. |
|
inline |
Copies all settings from this LineAttributeKit into the given LineAttributeKit.
out_kit | The <ref refid="class_h_p_s_1_1_line_attribute_kit" kindref="compound">LineAttributeKit</ref> to populate with the contents of this object. |
|
inline |
Shows the pattern used to draw lines.
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. |
|
inline |
Shows the weight of lines.
out_weight | The weight value for lines. |
out_units | The units applied to in_weight. |
|
inline |
Removes all settings from this object.
|
inline |
Removes the line pattern setting for lines.
|
inline |
Removes the weight setting for lines.