HPS.AttributeLockControl Class Reference
Inheritance diagram for HPS.AttributeLockControl:
HPS.Control HPS.Object

Public Member Functions

 AttributeLockControl (HPS.SegmentKey in_seg)
 
 AttributeLockControl (HPS.AttributeLockControl in_that)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
HPS.AttributeLockControl SetLock (HPS.AttributeLock.Type in_type, bool in_state)
 
HPS.AttributeLockControl SetLock (HPS.AttributeLock.Type in_type)
 
HPS.AttributeLockControl SetLock (HPS.AttributeLock.Type[] in_types, bool[] in_states)
 
HPS.AttributeLockControl SetSubsegmentLockOverride (HPS.AttributeLock.Type in_type, bool in_state)
 
HPS.AttributeLockControl SetSubsegmentLockOverride (HPS.AttributeLock.Type in_type)
 
HPS.AttributeLockControl SetSubsegmentLockOverride (HPS.AttributeLock.Type[] in_types, bool[] in_states)
 
bool ShowLock (HPS.AttributeLock.Type in_type, out bool out_state)
 
bool ShowLock (out HPS.AttributeLock.Type[] out_types, out bool[] out_states)
 
bool ShowSubsegmentLockOverride (HPS.AttributeLock.Type in_type, out bool out_state)
 
bool ShowSubsegmentLockOverride (out HPS.AttributeLock.Type[] out_types, out bool[] out_states)
 
override HPS.Type Type ()
 
HPS.AttributeLockControl UnsetEverything ()
 
HPS.AttributeLockControl UnsetLock (HPS.AttributeLock.Type in_type)
 
HPS.AttributeLockControl UnsetLock ()
 
HPS.AttributeLockControl UnsetLock (HPS.AttributeLock.Type[] in_types)
 
HPS.AttributeLockControl UnsetSubsegmentLockOverride (HPS.AttributeLock.Type in_type)
 
HPS.AttributeLockControl UnsetSubsegmentLockOverride ()
 
HPS.AttributeLockControl UnsetSubsegmentLockOverride (HPS.AttributeLock.Type[] in_types)
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Control
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
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

◆ AttributeLockControl() [1/2]

HPS.AttributeLockControl.AttributeLockControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

◆ AttributeLockControl() [2/2]

HPS.AttributeLockControl.AttributeLockControl ( HPS.AttributeLockControl  in_that)
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_thatAn rvalue reference to a AttributeLockKit to take the impl from.

Member Function Documentation

◆ 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]

HPS.AttributeLockControl HPS.AttributeLockControl.SetLock ( HPS.AttributeLock.Type  in_type,
bool  in_state 
)
inline

Applies an attribute lock that prevents attributes of the chosen type from being modified in child segments.

Parameters
in_typeThe type of attribute to lock or unlock.
in_stateWhether the attribute should be locked.
Returns
A reference to this object.
See also
Attribute lock default value

◆ SetLock() [2/3]

HPS.AttributeLockControl HPS.AttributeLockControl.SetLock ( HPS.AttributeLock.Type  in_type)
inline

Applies an attribute lock that prevents attributes of the chosen type from being modified in child segments.

Parameters
in_typeThe type of attribute to lock or unlock.
Returns
A reference to this object.
See also
Attribute lock default value

◆ SetLock() [3/3]

HPS.AttributeLockControl HPS.AttributeLockControl.SetLock ( HPS.AttributeLock.Type []  in_types,
bool []  in_states 
)
inline

Applies attribute locks that prevents attributes of the chosen types from being modified in child segments.

Parameters
in_typesAn array of attribute types that should be locked or unlocked.
in_statesAn 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]

HPS.AttributeLockControl HPS.AttributeLockControl.SetSubsegmentLockOverride ( HPS.AttributeLock.Type  in_type,
bool  in_state 
)
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_typeThe type of attribute lock that should be ignored in subsegments.
in_stateWhether the attribute lock should override locks in subsegments.
Returns
A reference to this object.

◆ SetSubsegmentLockOverride() [2/3]

HPS.AttributeLockControl HPS.AttributeLockControl.SetSubsegmentLockOverride ( HPS.AttributeLock.Type  in_type)
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_typeThe type of attribute lock that should be ignored in subsegments.
Returns
A reference to this object.

◆ SetSubsegmentLockOverride() [3/3]

HPS.AttributeLockControl HPS.AttributeLockControl.SetSubsegmentLockOverride ( HPS.AttributeLock.Type []  in_types,
bool []  in_states 
)
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.

◆ ShowLock() [1/2]

bool HPS.AttributeLockControl.ShowLock ( HPS.AttributeLock.Type  in_type,
out bool  out_state 
)
inline

Shows the state of a particular attribute lock.

Parameters
in_typeThe type of attribute lock to be queried.
out_stateWhether the attribute is locked.
Returns
true if the setting is valid, false otherwise.

◆ ShowLock() [2/2]

bool HPS.AttributeLockControl.ShowLock ( out HPS.AttributeLock.Type []  out_types,
out bool []  out_states 
)
inline

Shows the state of all attribute locks.

Parameters
out_typesAn array of types that have an attribute lock setting.
out_statesAn 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_typeThe type of attribute lock to be queried.
out_stateWhether 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_typesAn array of types that have a subsegment lock override setting.
out_statesAn 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()

HPS.AttributeLockControl HPS.AttributeLockControl.UnsetEverything ( )
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.

◆ UnsetLock() [1/3]

HPS.AttributeLockControl HPS.AttributeLockControl.UnsetLock ( HPS.AttributeLock.Type  in_type)
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.

◆ UnsetLock() [2/3]

HPS.AttributeLockControl HPS.AttributeLockControl.UnsetLock ( )
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.

◆ UnsetLock() [3/3]

HPS.AttributeLockControl HPS.AttributeLockControl.UnsetLock ( HPS.AttributeLock.Type []  in_types)
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.

◆ UnsetSubsegmentLockOverride() [1/3]

HPS.AttributeLockControl HPS.AttributeLockControl.UnsetSubsegmentLockOverride ( HPS.AttributeLock.Type  in_type)
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.

◆ UnsetSubsegmentLockOverride() [2/3]

HPS.AttributeLockControl HPS.AttributeLockControl.UnsetSubsegmentLockOverride ( )
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.

◆ UnsetSubsegmentLockOverride() [3/3]

HPS.AttributeLockControl HPS.AttributeLockControl.UnsetSubsegmentLockOverride ( HPS.AttributeLock.Type []  in_types)
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