|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ AttributeLockControl() [1/2]
HPS.AttributeLockControl.AttributeLockControl |
( |
HPS.SegmentKey |
in_seg | ) |
|
|
inline |
Initializes a control tied to the segment in_seg.
◆ AttributeLockControl() [2/2]
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
-
◆ ObjectType()
override HPS.Type HPS.AttributeLockControl.ObjectType |
( |
| ) |
|
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
◆ SetLock() [1/3]
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.
- See also
- Attribute lock default value
◆ SetLock() [2/3]
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.
- See also
- Attribute lock default value
◆ SetLock() [3/3]
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.
◆ SetSubsegmentLockOverride() [1/3]
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.
◆ SetSubsegmentLockOverride() [2/3]
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.
◆ SetSubsegmentLockOverride() [3/3]
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.
◆ ShowLock() [1/2]
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.
◆ ShowLock() [2/2]
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.
◆ ShowSubsegmentLockOverride() [1/2]
bool HPS.AttributeLockControl.ShowSubsegmentLockOverride |
( |
HPS.AttributeLock.Type |
in_type, |
|
|
out bool |
out_state |
|
) |
| |
|
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.
◆ ShowSubsegmentLockOverride() [2/2]
bool HPS.AttributeLockControl.ShowSubsegmentLockOverride |
( |
out HPS.AttributeLock.Type [] |
out_types, |
|
|
out bool [] |
out_states |
|
) |
| |
|
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.
◆ Type()
override HPS.Type HPS.AttributeLockControl.Type |
( |
| ) |
|
|
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.
- Warning
- This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
- Returns
- The true type of the object in question.
Reimplemented from HPS.Object.
◆ 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().
- Returns
- A reference to this object.
◆ UnsetLock() [1/3]
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.
◆ UnsetLock() [2/3]
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.
◆ UnsetLock() [3/3]
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.
◆ UnsetSubsegmentLockOverride() [1/3]
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.
◆ UnsetSubsegmentLockOverride() [2/3]
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.
◆ UnsetSubsegmentLockOverride() [3/3]
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