REFERENCE MANUAL
The AttributeLockControl class provides support for attribute locking, which allows temporarily override of an attribute setting for a segment and its descendants. More...
Public Member Functions | |
AttributeLockControl (HPS.SegmentKey in_seg) | |
Initializes a control tied to the segment in_seg. More... | |
AttributeLockControl (HPS.AttributeLockControl in_that) | |
The move constructor creates a AttributeLockKit by transferring the underlying impl of the rvalue reference to this AttributeLockKit thereby avoiding a copy and allocation. More... | |
override void | Dispose () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
HPS.AttributeLockControl | 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.AttributeLockControl | 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.AttributeLockControl | 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.AttributeLockControl | 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.AttributeLockControl | 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.AttributeLockControl | 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... | |
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.AttributeLockControl | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.AttributeLockControl | UnsetLock (HPS.AttributeLock.Type in_type) |
Removes an attribute lock setting. More... | |
HPS.AttributeLockControl | UnsetLock () |
Removes an attribute lock setting. More... | |
HPS.AttributeLockControl | UnsetLock (HPS.AttributeLock.Type[] in_types) |
Removes a collection of attribute lock settings. More... | |
HPS.AttributeLockControl | UnsetSubsegmentLockOverride (HPS.AttributeLock.Type in_type) |
Removes a subsegment lock override setting. More... | |
HPS.AttributeLockControl | UnsetSubsegmentLockOverride () |
Removes a subsegment lock override setting. More... | |
HPS.AttributeLockControl | UnsetSubsegmentLockOverride (HPS.AttributeLock.Type[] in_types) |
Removes a collection of subsegment lock override settings. More... | |
![]() | |
Control (HPS.Control in_that) | |
override void | Dispose () |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. 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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The AttributeLockControl 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. For more information, see Core Graphics Programming Guide, section 1.2.4 - subsection "Attribute controls". This table lists default values for the various segment attributes accessible from AttributeLockControl.
HPS.AttributeLockControl.AttributeLockControl | ( | HPS.SegmentKey | in_seg | ) |
Initializes a control tied to the segment in_seg.
HPS.AttributeLockControl.AttributeLockControl | ( | HPS.AttributeLockControl | in_that | ) |
The move constructor creates a AttributeLockKit by transferring the underlying impl of the rvalue reference to this AttributeLockKit thereby avoiding a copy and allocation.
in_that | An rvalue reference to a <ref refid="class_h_p_s_1_1_attribute_lock_kit" kindref="compound">AttributeLockKit</ref> to take the impl from. |
|
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.
HPS.AttributeLockControl HPS.AttributeLockControl.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.AttributeLockControl HPS.AttributeLockControl.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.AttributeLockControl HPS.AttributeLockControl.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.AttributeLockControl HPS.AttributeLockControl.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.AttributeLockControl HPS.AttributeLockControl.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.AttributeLockControl HPS.AttributeLockControl.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.
bool HPS.AttributeLockControl.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.AttributeLockControl.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.AttributeLockControl.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.AttributeLockControl.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.AttributeLockControl HPS.AttributeLockControl.UnsetEverything | ( | ) |
Removes all settings from this object.
HPS.AttributeLockControl HPS.AttributeLockControl.UnsetLock | ( | HPS.AttributeLock.Type | in_type | ) |
Removes an attribute lock setting.
HPS.AttributeLockControl HPS.AttributeLockControl.UnsetLock | ( | ) |
Removes an attribute lock setting.
HPS.AttributeLockControl HPS.AttributeLockControl.UnsetLock | ( | HPS.AttributeLock.Type[] | in_types | ) |
Removes a collection of attribute lock settings.
HPS.AttributeLockControl HPS.AttributeLockControl.UnsetSubsegmentLockOverride | ( | HPS.AttributeLock.Type | in_type | ) |
Removes a subsegment lock override setting.
HPS.AttributeLockControl HPS.AttributeLockControl.UnsetSubsegmentLockOverride | ( | ) |
Removes a subsegment lock override setting.
HPS.AttributeLockControl HPS.AttributeLockControl.UnsetSubsegmentLockOverride | ( | HPS.AttributeLock.Type[] | in_types | ) |
Removes a collection of subsegment lock override settings.