
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 () |
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. This method designates a particular lock as a "super lock" that cannot be overridden by subsegments. 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. This method designates a particular lock as a "super lock" that cannot be overridden by subsegments. 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. This method designates a collection of locks as a "super locks" that cannot be overridden by subsegments. 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... | |
override 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... | |
HPS.AttributeLockControl | UnsetEverything () |
Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by AttributeLockKit.GetDefault(). More... | |
HPS.AttributeLockControl | UnsetLock (HPS.AttributeLock.Type in_type) |
Removes an attribute lock setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by AttributeLockKit.GetDefault(). More... | |
HPS.AttributeLockControl | UnsetLock () |
Removes an attribute lock setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by AttributeLockKit.GetDefault(). More... | |
HPS.AttributeLockControl | UnsetLock (HPS.AttributeLock.Type[] in_types) |
Removes a collection of attribute lock settings. If the control is attached to a WindowKey this function restores the default value of this setting as specified by AttributeLockKit.GetDefault(). More... | |
HPS.AttributeLockControl | UnsetSubsegmentLockOverride (HPS.AttributeLock.Type in_type) |
Removes a subsegment lock override setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by AttributeLockKit.GetDefault(). More... | |
HPS.AttributeLockControl | UnsetSubsegmentLockOverride () |
Removes a subsegment lock override setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by AttributeLockKit.GetDefault(). More... | |
HPS.AttributeLockControl | UnsetSubsegmentLockOverride (HPS.AttributeLock.Type[] in_types) |
Removes a collection of subsegment lock override settings. If the control is attached to a WindowKey this function restores the default value of this setting as specified by AttributeLockKit.GetDefault(). More... | |
![]() | |
Control (HPS.Control in_that) | |
override void | Dispose () |
override HPS.Type | ObjectType () |
override 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 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. 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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The HPS.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 HPS.AttributeLockControl.
Constructor & Destructor Documentation
|
inline |
Initializes a control tied to the segment in_seg.
|
inline |
The move constructor creates a AttributeLockKit by transferring the underlying impl of the rvalue reference to this AttributeLockKit thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a AttributeLockKit to take the impl from.
Member Function Documentation
|
inline |
Applies an attribute lock that prevents attributes of the chosen type from being modified in child segments.
- Parameters
-
in_type The type of attribute to lock or unlock. in_state Whether the attribute should be locked.
- Returns
- A reference to this object.
Attribute lock default value
|
inline |
Applies an attribute lock that prevents attributes of the chosen type from being modified in child segments.
- Parameters
-
in_type The type of attribute to lock or unlock.
- Returns
- A reference to this object.
Attribute lock default value
|
inline |
Applies attribute locks that prevents attributes of the chosen types from being modified in child segments.
- Parameters
-
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.
- Returns
- A reference to this object.
|
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.
- Parameters
-
in_type The type of attribute lock that should be ignored in subsegments. in_state Whether the attribute lock should override locks in subsegments.
- Returns
- A reference to this object.
|
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.
- Parameters
-
in_type The type of attribute lock that should be ignored in subsegments.
- Returns
- A reference to this object.
|
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.
- Returns
- A reference to this object.
|
inline |
Shows the state of a particular attribute lock.
- Parameters
-
in_type The type of attribute lock to be queried. out_state Whether the attribute is locked.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the state of all attribute locks.
- Parameters
-
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.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the state of a particular subsegment lock override.
- Parameters
-
in_type The type of attribute lock to be queried. out_state Whether the attribute lock will override locks in subsegments.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the state of all subsegment lock overrides.
- Parameters
-
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.
- Returns
- true if the setting is valid, false otherwise.
|
inlinevirtual |
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.
- Returns
- The true type of the object in question.
Reimplemented from HPS.Object.
|
inline |
Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by AttributeLockKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes an attribute lock setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by AttributeLockKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes an attribute lock setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by AttributeLockKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes a collection of attribute lock settings. If the control is attached to a WindowKey this function restores the default value of this setting as specified by AttributeLockKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes a subsegment lock override setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by AttributeLockKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes a subsegment lock override setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by AttributeLockKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes a collection of subsegment lock override settings. If the control is attached to a WindowKey this function restores the default value of this setting as specified by AttributeLockKit.GetDefault().
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.AttributeLockControl.cs