REFERENCE MANUAL
The AttributeLockKit class provides support for attribute locking, which allows temporarily override of an attribute setting for a segment and its descendants. More...
Public Member Functions | |
AttributeLockKit () | |
Initializes an empty kit. More... | |
AttributeLockKit (HPS.AttributeLockKit in_kit) | |
Copies the kit in_kit into this kit. More... | |
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.AttributeLockKit in_kit) |
Check if the source AttributeLockKit is equivalent to this object. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.AttributeLockKit in_kit) |
Copies the source AttributeLockKit into this object. More... | |
HPS.AttributeLockKit | SetLock (HPS.AttributeLock.Type in_type, bool in_state) |
Applies an attribute lock that prevents attributes of the chosen type from being modified in child segments. More... | |
HPS.AttributeLockKit | SetLock (HPS.AttributeLock.Type in_type) |
Applies an attribute lock that prevents attributes of the chosen type from being modified in child segments. More... | |
HPS.AttributeLockKit | SetLock (HPS.AttributeLock.Type[] in_types, bool[] in_states) |
Applies attribute locks that prevents attributes of the chosen types from being modified in child segments. More... | |
HPS.AttributeLockKit | SetSubsegmentLockOverride (HPS.AttributeLock.Type in_type, bool in_state) |
Normally, if a segment applies an attribute lock it will defeat an existing lock set in a parent segment. More... | |
HPS.AttributeLockKit | SetSubsegmentLockOverride (HPS.AttributeLock.Type in_type) |
Normally, if a segment applies an attribute lock it will defeat an existing lock set in a parent segment. More... | |
HPS.AttributeLockKit | SetSubsegmentLockOverride (HPS.AttributeLock.Type[] in_types, bool[] in_states) |
Normally, if a segment applies an attribute lock it will defeat an existing lock set in a parent segment. More... | |
void | Show (out HPS.AttributeLockKit out_kit) |
Copies this object into the given AttributeLockKit. More... | |
bool | ShowLock (HPS.AttributeLock.Type in_type, out bool out_state) |
Shows the state of a particular attribute lock. More... | |
bool | ShowLock (out HPS.AttributeLock.Type[] out_types, out bool[] out_states) |
Shows the state of all attribute locks. More... | |
bool | ShowSubsegmentLockOverride (HPS.AttributeLock.Type in_type, out bool out_state) |
Shows the state of a particular subsegment lock override. More... | |
bool | ShowSubsegmentLockOverride (out HPS.AttributeLock.Type[] out_types, out bool[] out_states) |
Shows the state of all subsegment lock overrides. More... | |
HPS.AttributeLockKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.AttributeLockKit | UnsetLock (HPS.AttributeLock.Type in_type) |
Removes an attribute lock setting. More... | |
HPS.AttributeLockKit | UnsetLock () |
Removes an attribute lock setting. More... | |
HPS.AttributeLockKit | UnsetLock (HPS.AttributeLock.Type[] in_types) |
Removes a collection of attribute lock settings. More... | |
HPS.AttributeLockKit | UnsetSubsegmentLockOverride (HPS.AttributeLock.Type in_type) |
Removes a subsegment lock override setting. More... | |
HPS.AttributeLockKit | UnsetSubsegmentLockOverride () |
Removes a subsegment lock override setting. More... | |
HPS.AttributeLockKit | UnsetSubsegmentLockOverride (HPS.AttributeLock.Type[] in_types) |
Removes a collection of subsegment lock override settings. More... | |
![]() | |
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.AttributeLockKit | GetDefault () |
Creates an AttributeLockKit which contains the default settings. More... | |
static bool | operator!= (HPS.AttributeLockKit a, HPS.AttributeLockKit b) |
static bool | operator== (HPS.AttributeLockKit a, HPS.AttributeLockKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The AttributeLockKit class provides support for attribute locking, which allows temporarily override of an attribute setting for a segment and its descendants.
This control is used to set and unset attribute locks at the segment level. Calling AttributeLockKit::GetDefault() will return a kit with values found in this table.
HPS.AttributeLockKit.AttributeLockKit | ( | ) |
Initializes an empty kit.
HPS.AttributeLockKit.AttributeLockKit | ( | HPS.AttributeLockKit | in_kit | ) |
Copies the kit in_kit into this kit.
|
virtual |
Indicates whether this object has any values set on it.
Reimplemented from HPS.Object.
bool HPS.AttributeLockKit.Equals | ( | HPS.AttributeLockKit | in_kit | ) |
Check if the source AttributeLockKit is equivalent to this object.
in_kit | The source <ref refid="class_h_p_s_1_1_attribute_lock_kit" kindref="compound">AttributeLockKit</ref> to compare to this object. |
|
static |
Creates an AttributeLockKit 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.
|
virtual |
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.
void HPS.AttributeLockKit.Set | ( | HPS.AttributeLockKit | in_kit | ) |
Copies the source AttributeLockKit into this object.
in_kit | The source object to copy. |
HPS.AttributeLockKit HPS.AttributeLockKit.SetLock | ( | HPS.AttributeLock.Type | in_type, |
bool | in_state | ||
) |
Applies an attribute lock that prevents attributes of the chosen type from being modified in child segments.
in_type | The type of attribute to lock or unlock. |
in_state | Whether the attribute should be locked. |
Attribute lock default value
HPS.AttributeLockKit HPS.AttributeLockKit.SetLock | ( | HPS.AttributeLock.Type | in_type | ) |
Applies an attribute lock that prevents attributes of the chosen type from being modified in child segments.
in_type | The type of attribute to lock or unlock. |
Attribute lock default value
HPS.AttributeLockKit HPS.AttributeLockKit.SetLock | ( | HPS.AttributeLock.Type[] | in_types, |
bool[] | in_states | ||
) |
Applies attribute locks that prevents attributes of the chosen types from being modified in child segments.
in_types | An array of attribute types that should be locked or unlocked. |
HPS.AttributeLockKit HPS.AttributeLockKit.SetSubsegmentLockOverride | ( | HPS.AttributeLock.Type | in_type, |
bool | in_state | ||
) |
Normally, if a segment applies an attribute lock it will defeat an existing lock set in a parent segment.
This method designates a particular lock as a "super lock" that cannot be overridden by subsegments.
in_type | The type of attribute lock that should be ignored in subsegments. |
in_state | Whether the attribute lock should override locks in subsegments. |
HPS.AttributeLockKit HPS.AttributeLockKit.SetSubsegmentLockOverride | ( | HPS.AttributeLock.Type | in_type | ) |
Normally, if a segment applies an attribute lock it will defeat an existing lock set in a parent segment.
This method designates a particular lock as a "super lock" that cannot be overridden by subsegments.
in_type | The type of attribute lock that should be ignored in subsegments. |
HPS.AttributeLockKit HPS.AttributeLockKit.SetSubsegmentLockOverride | ( | HPS.AttributeLock.Type[] | in_types, |
bool[] | in_states | ||
) |
Normally, if a segment applies an attribute lock it will defeat an existing lock set in a parent segment.
This method designates a collection of locks as a "super locks" that cannot be overridden by subsegments.
void HPS.AttributeLockKit.Show | ( | out HPS.AttributeLockKit | out_kit | ) |
Copies this object into the given AttributeLockKit.
out_kit | The <ref refid="class_h_p_s_1_1_attribute_lock_kit" kindref="compound">AttributeLockKit</ref> to populate with the contents of this object. |
bool HPS.AttributeLockKit.ShowLock | ( | HPS.AttributeLock.Type | in_type, |
out bool | out_state | ||
) |
Shows the state of a particular attribute lock.
in_type | The type of attribute lock to be queried. |
out_state | Whether the attribute is locked. |
bool HPS.AttributeLockKit.ShowLock | ( | out HPS.AttributeLock.Type[] | out_types, |
out bool[] | out_states | ||
) |
Shows the state of all attribute locks.
out_types | An array of types that have an attribute lock setting. |
out_states | An array of bools with each indicating whether the corresponding entry in in_types is locked. |
bool HPS.AttributeLockKit.ShowSubsegmentLockOverride | ( | HPS.AttributeLock.Type | in_type, |
out bool | out_state | ||
) |
Shows the state of a particular subsegment lock override.
in_type | The type of attribute lock to be queried. |
out_state | Whether the attribute lock will override locks in subsegments. |
bool HPS.AttributeLockKit.ShowSubsegmentLockOverride | ( | out HPS.AttributeLock.Type[] | out_types, |
out bool[] | out_states | ||
) |
Shows the state of all subsegment lock overrides.
out_types | An array of types that have a subsegment lock override setting. |
out_states | An array of bools with each indicating whether the corresponding entry in in_types is will be ignored in subsegments. |
HPS.AttributeLockKit HPS.AttributeLockKit.UnsetEverything | ( | ) |
Removes all settings from this object.
HPS.AttributeLockKit HPS.AttributeLockKit.UnsetLock | ( | HPS.AttributeLock.Type | in_type | ) |
Removes an attribute lock setting.
HPS.AttributeLockKit HPS.AttributeLockKit.UnsetLock | ( | ) |
Removes an attribute lock setting.
HPS.AttributeLockKit HPS.AttributeLockKit.UnsetLock | ( | HPS.AttributeLock.Type[] | in_types | ) |
Removes a collection of attribute lock settings.
HPS.AttributeLockKit HPS.AttributeLockKit.UnsetSubsegmentLockOverride | ( | HPS.AttributeLock.Type | in_type | ) |
Removes a subsegment lock override setting.
HPS.AttributeLockKit HPS.AttributeLockKit.UnsetSubsegmentLockOverride | ( | ) |
Removes a subsegment lock override setting.
HPS.AttributeLockKit HPS.AttributeLockKit.UnsetSubsegmentLockOverride | ( | HPS.AttributeLock.Type[] | in_types | ) |
Removes a collection of subsegment lock override settings.