The HPS::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 HPS::AttributeLockKit::GetDefault() will return a kit with values found in this table. 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. This does not necessarily give the true type of the underlying object. 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. This method designates a particular lock as a "super lock" that cannot be overridden by subsegments. 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. This method designates a particular lock as a "super lock" that cannot be overridden by subsegments. 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. This method designates a collection of locks as a "super locks" that cannot be overridden by subsegments. 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. 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... | |
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... | |
Static Public Member Functions | |
static HPS.AttributeLockKit | GetDefault () |
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. 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 HPS::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 HPS::AttributeLockKit::GetDefault() will return a kit with values found in this table.
|
inline |
Initializes an empty kit.
|
inline |
Copies the kit in_kit into this kit.
|
inlinevirtual |
Indicates whether this object has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source AttributeLockKit is equivalent to this object.
in_kit | The source AttributeLockKit to compare to this object. |
|
inlinestatic |
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.
|
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 the source AttributeLockKit into this object.
in_kit | The source object to copy. |
|
inline |
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
|
inline |
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
|
inline |
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. |
in_states | An array of bools with each one indicating whether the corresponding type in in_types should be locked. |
|
inline |
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. |
|
inline |
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. |
|
inline |
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.
in_types | An array of types of attribute locks that should be ignored in subsegments. |
in_states | An array of bools with each one indicating whether the corresponding attribute lock in in_types should override locks in subsegments. |
|
inline |
Copies this object into the given AttributeLockKit.
out_kit | The AttributeLockKit to populate with the contents of this object. |
|
inline |
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. |
|
inline |
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. |
|
inline |
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. |
|
inline |
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. |
|
inline |
Removes all settings from this object.
|
inline |
Removes an attribute lock setting.
|
inline |
Removes an attribute lock setting.
|
inline |
Removes a collection of attribute lock settings.
|
inline |
Removes a subsegment lock override setting.
|
inline |
Removes a subsegment lock override setting.
|
inline |
Removes a collection of subsegment lock override settings.