< Home

< Table of Contents

REFERENCE MANUAL

HPS.LineAttributeKit Class Reference

The LineAttributeKit class is a user space object, useful for carrying a group of attribute settings related to lines. More...

Inheritance diagram for HPS.LineAttributeKit:
HPS.Object

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. 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...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 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...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Static Public Member Functions

static HPS.LineAttributeKit GetDefault ()
 Creates a LineAttributeKit which contains the default settings. More...
 
static bool operator!= (HPS.LineAttributeKit a, HPS.LineAttributeKit b)
 
static bool operator== (HPS.LineAttributeKit a, HPS.LineAttributeKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The LineAttributeKit class is a user space object, useful for carrying a group of attribute settings related to lines.

Calling LineAttributeKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

HPS.LineAttributeKit.LineAttributeKit ( )

Initializes an empty kit.

HPS.LineAttributeKit.LineAttributeKit ( HPS.LineAttributeKit  in_kit)

The copy constructor creates a new LineAttributeKit object that contains the same settings as the source object.

Parameters
in_kitThe source object to copy.

Member Function Documentation

override bool HPS.LineAttributeKit.Empty ( )
virtual

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.

bool HPS.LineAttributeKit.Equals ( HPS.LineAttributeKit  in_kit)

Check if the source LineAttributeKit is equivalent to this object.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_line_attribute_kit" kindref="compound">LineAttributeKit</ref> to compare to this object.
Returns
true if the objects are equivalent, false otherwise.
static HPS.LineAttributeKit HPS.LineAttributeKit.GetDefault ( )
static

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.
override HPS.Type HPS.LineAttributeKit.ObjectType ( )
virtual

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.Object.

void HPS.LineAttributeKit.Set ( HPS.LineAttributeKit  in_kit)

Copies all settings from the source LineAttributeKit into this object.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_line_attribute_kit" kindref="compound">LineAttributeKit</ref> to copy.
HPS.LineAttributeKit HPS.LineAttributeKit.SetPattern ( string  in_name)

Specifies the pattern of lines.

Returns
A reference to this object.
HPS.LineAttributeKit HPS.LineAttributeKit.SetPattern ( string  in_name,
HPS.LinePatternOptionsKit  in_options 
)

Specifies the pattern of lines.

Parameters
in_optionsA set of options that modify how the named line pattern is applied.
Returns
A reference to this object.
HPS.LineAttributeKit HPS.LineAttributeKit.SetWeight ( float  in_weight,
HPS.Line.SizeUnits  in_units 
)

Sets the weight of lines.

Parameters
in_weightThe weight value for lines.
in_unitsThe units applied to in_weight.
Returns
A reference to this object.
HPS.LineAttributeKit HPS.LineAttributeKit.SetWeight ( float  in_weight)

Sets the weight of lines.

Parameters
in_weightThe weight value for lines.
Returns
A reference to this object.
void HPS.LineAttributeKit.Show ( out HPS.LineAttributeKit  out_kit)

Copies all settings from this LineAttributeKit into the given LineAttributeKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_line_attribute_kit" kindref="compound">LineAttributeKit</ref> to populate with the contents of this object.
bool HPS.LineAttributeKit.ShowPattern ( out string  out_pattern,
out HPS.LinePatternOptionsKit  out_options 
)

Shows the pattern used to draw lines.

Parameters
out_patternThe name of a line pattern, defined in a portfolio that is accessible.
out_optionsA set of options that modify how the named line pattern is applied.
Returns
true if the setting is valid, false otherwise.
bool HPS.LineAttributeKit.ShowWeight ( out float  out_weight,
out HPS.Line.SizeUnits  out_units 
)

Shows the weight of lines.

Parameters
out_weightThe weight value for lines.
out_unitsThe units applied to in_weight.
Returns
true if the setting is valid, false otherwise.
HPS.LineAttributeKit HPS.LineAttributeKit.UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.
HPS.LineAttributeKit HPS.LineAttributeKit.UnsetPattern ( )

Removes the line pattern setting for lines.

Returns
A reference to this object.
HPS.LineAttributeKit HPS.LineAttributeKit.UnsetWeight ( )

Removes the weight setting for lines.

Returns
A reference to this object.

The documentation for this class was generated from the following file: