The HPS::AttributeLockKit class provides support for attribute locking, which allows temporarily override of an attribute setting for a segment and its descendants. More...

#include <hps.h>

Inheritance diagram for HPS::AttributeLockKit:

[legend]

Collaboration diagram for HPS::AttributeLockKit:

[legend]

Public Member Functions
	AttributeLockKit ()
	Initializes an empty kit. More...

	AttributeLockKit (AttributeLockKit const &in_kit)
	Copies the kit in_kit into this kit. More...

	AttributeLockKit (AttributeLockKit &&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...

AttributeLockKit &	operator= (AttributeLockKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this AttributeLockKit thereby avoiding a copy. More...

virtual	~AttributeLockKit ()
	Destroy this kit. More...

HPS::Type	ObjectType () const

void	Set (AttributeLockKit const &in_kit)
	Copies the source AttributeLockKit into this object. More...

void	Show (AttributeLockKit &out_kit) const
	Copies this object into the given AttributeLockKit. More...

AttributeLockKit &	operator= (AttributeLockKit const &in_kit)
	Copies the source AttributeLockKit into this object. More...

bool	Empty () const
	Indicates whether this object has any values set on it. More...

bool	Equals (AttributeLockKit const &in_kit) const
	Check if the source AttributeLockKit is equivalent to this object. More...

bool	operator== (AttributeLockKit const &in_kit) const
	Check if the source AttributeLockKit is equivalent to this object. More...

bool	operator!= (AttributeLockKit const &in_kit) const
	Check if the source AttributeLockKit is not equivalent to this object. More...

AttributeLockKit &	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. More...

AttributeLockKit &	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. More...

AttributeLockKit &	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. More...

AttributeLockKit &	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. More...

AttributeLockKit &	UnsetLock (AttributeLock::Type in_type=AttributeLock::Type::Everything)
	Removes an attribute lock setting. More...

AttributeLockKit &	UnsetLock (AttributeLockTypeArray const &in_types)
	Removes a collection of attribute lock settings. More...

AttributeLockKit &	UnsetSubsegmentLockOverride (AttributeLock::Type in_type=AttributeLock::Type::Everything)
	Removes a subsegment lock override setting. More...

AttributeLockKit &	UnsetSubsegmentLockOverride (AttributeLockTypeArray const &in_types)
	Removes a collection of subsegment lock override settings. More...

AttributeLockKit &	UnsetEverything ()
	Removes all settings from this object. More...

bool	ShowLock (AttributeLock::Type in_type, bool &out_state) const
	Shows the state of a particular attribute lock. More...

bool	ShowLock (AttributeLockTypeArray &out_types, BoolArray &out_states) const
	Shows the state of all attribute locks. More...

bool	ShowSubsegmentLockOverride (AttributeLock::Type in_type, bool &out_state) const
	Shows the state of a particular subsegment lock override. More...

bool	ShowSubsegmentLockOverride (AttributeLockTypeArray &out_types, BoolArray &out_states) const
	Shows the state of all subsegment lock overrides. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static AttributeLockKit	GetDefault ()
	Creates an AttributeLockKit which contains the default settings. More...

template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::AttributeLockKit

Detailed Description

The HPS::AttributeLockKit 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. Calling HPS::AttributeLockKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ AttributeLockKit() [1/3]

HPS::AttributeLockKit::AttributeLockKit ( )

Initializes an empty kit.

◆ AttributeLockKit() [2/3]

HPS::AttributeLockKit::AttributeLockKit ( AttributeLockKit const & in_kit )

Copies the kit in_kit into this kit.

◆ AttributeLockKit() [3/3]

HPS::AttributeLockKit::AttributeLockKit ( AttributeLockKit && 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_that An rvalue reference to a AttributeLockKit to take the impl from.

◆ ~AttributeLockKit()

virtual HPS::AttributeLockKit::~AttributeLockKit ( )

virtual

Destroy this kit.

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ Empty()

bool HPS::AttributeLockKit::Empty ( ) const

virtual

Indicates whether this object has any values set on it.

Returns: true if no values are set on this object, false otherwise.

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::AttributeLockKit::Equals ( AttributeLockKit const & in_kit ) const

Check if the source AttributeLockKit is equivalent to this object.

Parameters

in_kit The source AttributeLockKit to compare to this object.

Returns: true if the objects are equivalent, false otherwise.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

◆ GetDefault()

static AttributeLockKit HPS::AttributeLockKit::GetDefault ( )

static

Creates an AttributeLockKit which contains the default settings.

The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Returns: An AttributeLockKit with the default settings.

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

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.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::AttributeLockKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

bool HPS::AttributeLockKit::operator!= ( AttributeLockKit const & in_kit ) const

Check if the source AttributeLockKit is not equivalent to this object.

Parameters

in_kit The source AttributeLockKit to compare to this object.

Returns: true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

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

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

Parameters

in_that An rvalue reference to a AttributeLockKit to take the impl from.

Returns: A reference to this AttributeLockKit.

◆ operator=() [2/2]

AttributeLockKit& HPS::AttributeLockKit::operator= ( AttributeLockKit const & in_kit )

Copies the source AttributeLockKit into this object.

Parameters

in_kit The source AttributeLockKit to copy.

Returns: A reference to this object.

◆ operator==()

bool HPS::AttributeLockKit::operator== ( AttributeLockKit const & in_kit ) const

Check if the source AttributeLockKit is equivalent to this object.

Parameters

in_kit The source AttributeLockKit to compare to this object.

Returns: true if the objects are equivalent, false otherwise.

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ Set()

void HPS::AttributeLockKit::Set ( AttributeLockKit const & in_kit )

Copies the source AttributeLockKit into this object.

Parameters

in_kit The source object to copy.

◆ SetLock() [1/2]

AttributeLockKit& HPS::AttributeLockKit::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_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/2]

AttributeLockKit& HPS::AttributeLockKit::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_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/2]

AttributeLockKit& HPS::AttributeLockKit::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_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/2]

AttributeLockKit& HPS::AttributeLockKit::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_types	An array of types of attribute locks that should be ignored in subsegments.
in_states	An 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.

◆ Show()

void HPS::AttributeLockKit::Show ( AttributeLockKit & out_kit ) const

Copies this object into the given AttributeLockKit.

Parameters

out_kit The AttributeLockKit to populate with the contents of this object.

◆ ShowLock() [1/2]

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

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]

bool HPS::AttributeLockKit::ShowLock	(	AttributeLockTypeArray &	out_types,
		BoolArray &	out_states
	)		const

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

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

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

virtual HPS::Type HPS::Kit::Type ( ) const

inlinevirtualinherited

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.

◆ UnsetEverything()

AttributeLockKit& HPS::AttributeLockKit::UnsetEverything ( )

Removes all settings from this object.

Returns: A reference to this object.

◆ UnsetLock() [1/2]

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

Removes an attribute lock setting.

Returns: A reference to this object.

◆ UnsetLock() [2/2]

AttributeLockKit& HPS::AttributeLockKit::UnsetLock ( AttributeLockTypeArray const & in_types )

Removes a collection of attribute lock settings.

Returns: A reference to this object.

◆ UnsetSubsegmentLockOverride() [1/2]

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

Removes a subsegment lock override setting.

Returns: A reference to this object.

◆ UnsetSubsegmentLockOverride() [2/2]

AttributeLockKit& HPS::AttributeLockKit::UnsetSubsegmentLockOverride ( AttributeLockTypeArray const & in_types )

Removes a collection of subsegment lock override settings.

Returns: A reference to this object.

Member Data Documentation

◆ staticType

const HPS::Type HPS::AttributeLockKit::staticType = HPS::Type::AttributeLockKit

static

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

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AttributeLockKit() [1/3]

◆ AttributeLockKit() [2/3]

◆ AttributeLockKit() [3/3]

◆ ~AttributeLockKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetLock() [1/2]

◆ SetLock() [2/2]

◆ SetSubsegmentLockOverride() [1/2]

◆ SetSubsegmentLockOverride() [2/2]

◆ Show()

◆ ShowLock() [1/2]

◆ ShowLock() [2/2]

◆ ShowSubsegmentLockOverride() [1/2]

◆ ShowSubsegmentLockOverride() [2/2]

◆ Type()

◆ UnsetEverything()

◆ UnsetLock() [1/2]

◆ UnsetLock() [2/2]

◆ UnsetSubsegmentLockOverride() [1/2]

◆ UnsetSubsegmentLockOverride() [2/2]

Member Data Documentation

◆ staticType