HPS::AttributeLockControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::AttributeLockControl:
HPS::Control HPS::Object

Public Member Functions

 AttributeLockControl (SegmentKey &in_seg)
 
 AttributeLockControl (AttributeLockControl &&in_that)
 
 AttributeLockControl (AttributeLockControl const &in_that)
 
HPS::Type ObjectType () const
 
AttributeLockControloperator= (AttributeLockControl &&in_that)
 
AttributeLockControloperator= (AttributeLockControl const &in_that)
 
AttributeLockControlSetLock (AttributeLock::Type in_type, bool in_state=true)
 
AttributeLockControlSetLock (AttributeLockTypeArray const &in_types, BoolArray const &in_states)
 
AttributeLockControlSetSubsegmentLockOverride (AttributeLock::Type in_type, bool in_state=true)
 
AttributeLockControlSetSubsegmentLockOverride (AttributeLockTypeArray const &in_types, BoolArray const &in_states)
 
bool ShowLock (AttributeLock::Type in_type, bool &out_state) const
 
bool ShowLock (AttributeLockTypeArray &out_types, BoolArray &out_states) const
 
bool ShowSubsegmentLockOverride (AttributeLock::Type in_type, bool &out_state) const
 
bool ShowSubsegmentLockOverride (AttributeLockTypeArray &out_types, BoolArray &out_states) const
 
virtual HPS::Type Type () const
 
AttributeLockControlUnsetEverything ()
 
AttributeLockControlUnsetLock (AttributeLock::Type in_type=AttributeLock::Type::Everything)
 
AttributeLockControlUnsetLock (AttributeLockTypeArray const &in_types)
 
AttributeLockControlUnsetSubsegmentLockOverride (AttributeLock::Type in_type=AttributeLock::Type::Everything)
 
AttributeLockControlUnsetSubsegmentLockOverride (AttributeLockTypeArray const &in_types)
 
 ~AttributeLockControl ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::AttributeLockControl
 
- Static Public Attributes inherited from HPS::Control
static const HPS::Type staticType = HPS::Type::Control
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Control
 Control (Control &&in_that)
 
Controloperator= (Control &&in_that)
 

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/3]

HPS::AttributeLockControl::AttributeLockControl ( SegmentKey in_seg)
explicit

Initializes a control tied to the segment in_seg.

◆ AttributeLockControl() [2/3]

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

Parameters
in_thatAn rvalue reference to a AttributeLockKit to take the impl from.

◆ AttributeLockControl() [3/3]

HPS::AttributeLockControl::AttributeLockControl ( AttributeLockControl const &  in_that)

Initializes a control tied to the same object as in_that.

◆ ~AttributeLockControl()

HPS::AttributeLockControl::~AttributeLockControl ( )

Releases a reference to the database object this control is tied to.

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::AttributeLockControl::ObjectType ( ) const
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::Control.

◆ operator=() [1/2]

AttributeLockControl& HPS::AttributeLockControl::operator= ( AttributeLockControl &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this AttributeLockControl thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a AttributeLockControl to take the impl from.
Returns
A reference to this AttributeLockControl.

◆ operator=() [2/2]

AttributeLockControl& HPS::AttributeLockControl::operator= ( AttributeLockControl const &  in_that)

Share the underlying smart-pointer of the AttributeLockControl source.

Parameters
in_thatThe AttributeLockControl source of the assignment.
Returns
A reference to this AttributeLockControl.

◆ SetLock() [1/2]

AttributeLockControl& HPS::AttributeLockControl::SetLock ( AttributeLock::Type  in_type,
bool  in_state = true 
)

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/2]

AttributeLockControl& HPS::AttributeLockControl::SetLock ( AttributeLockTypeArray const &  in_types,
BoolArray const &  in_states 
)

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/2]

AttributeLockControl& HPS::AttributeLockControl::SetSubsegmentLockOverride ( AttributeLock::Type  in_type,
bool  in_state = true 
)

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/2]

AttributeLockControl& HPS::AttributeLockControl::SetSubsegmentLockOverride ( AttributeLockTypeArray const &  in_types,
BoolArray const &  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.

Parameters
in_typeAnn array of types of attribute locks that should be ignored in subsegments.
in_stateAn array of bools with each one indicating whether the corresponding attribute lock in in_types should override locks in subsegments.
Returns
A reference to this object.

◆ ShowLock() [1/2]

bool HPS::AttributeLockControl::ShowLock ( AttributeLock::Type  in_type,
bool &  out_state 
) const

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 ( AttributeLockTypeArray out_types,
BoolArray out_states 
) const

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 ( AttributeLock::Type  in_type,
bool &  out_state 
) const

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 ( AttributeLockTypeArray out_types,
BoolArray out_states 
) const

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()

virtual HPS::Type HPS::AttributeLockControl::Type ( ) const
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::Control.

◆ UnsetEverything()

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

Returns
A reference to this object.

◆ UnsetLock() [1/2]

AttributeLockControl& HPS::AttributeLockControl::UnsetLock ( AttributeLock::Type  in_type = AttributeLock::Type::Everything)

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/2]

AttributeLockControl& HPS::AttributeLockControl::UnsetLock ( AttributeLockTypeArray const &  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().

Returns
A reference to this object.

◆ UnsetSubsegmentLockOverride() [1/2]

AttributeLockControl& HPS::AttributeLockControl::UnsetSubsegmentLockOverride ( AttributeLock::Type  in_type = AttributeLock::Type::Everything)

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/2]

AttributeLockControl& HPS::AttributeLockControl::UnsetSubsegmentLockOverride ( AttributeLockTypeArray const &  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().

Returns
A reference to this object.

The documentation for this class was generated from the following file: