The HPS::LineAttributeKit class is a user space object, useful for carrying a group of attribute settings related to lines. More...

#include <hps.h>

Inheritance diagram for HPS::LineAttributeKit:

[legend]

Collaboration diagram for HPS::LineAttributeKit:

[legend]

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

	LineAttributeKit (LineAttributeKit const &in_kit)
	The copy constructor creates a new LineAttributeKit object that contains the same settings as the source object. More...

	LineAttributeKit (LineAttributeKit &&in_that)
	The move constructor creates a LineAttributeKit by transferring the underlying impl of the rvalue reference to this LineAttributeKit thereby avoiding a copy and allocation. More...

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

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

HPS::Type	ObjectType () const

void	Set (LineAttributeKit const &in_kit)
	Copies all settings from the source LineAttributeKit into this object. More...

void	Show (LineAttributeKit &out_kit) const
	Copies all settings from this LineAttributeKit into the given LineAttributeKit. More...

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

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

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

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

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

LineAttributeKit &	SetPattern (char const *in_name)
	Specifies the pattern of lines. More...

LineAttributeKit &	SetPattern (char const *in_name, LinePatternOptionsKit const &in_options)
	Specifies the pattern of lines. More...

LineAttributeKit &	SetWeight (float in_weight, Line::SizeUnits in_units=Line::SizeUnits::ScaleFactor)
	Sets the weight of lines. More...

LineAttributeKit &	UnsetPattern ()
	Removes the line pattern setting for lines. More...

LineAttributeKit &	UnsetWeight ()
	Removes the weight setting for lines. More...

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

bool	ShowPattern (UTF8 &out_pattern, LinePatternOptionsKit &out_options) const
	Shows the pattern used to draw lines. More...

bool	ShowWeight (float &out_weight, Line::SizeUnits &out_units) const
	Shows the weight of lines. 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 LineAttributeKit	GetDefault ()
	Creates a LineAttributeKit 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::LineAttributeKit

Detailed Description

The HPS::LineAttributeKit class is a user space object, useful for carrying a group of attribute settings related to lines.

Calling HPS::LineAttributeKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ LineAttributeKit() [1/3]

HPS::LineAttributeKit::LineAttributeKit ( )

Initializes an empty kit.

◆ LineAttributeKit() [2/3]

HPS::LineAttributeKit::LineAttributeKit ( LineAttributeKit const & in_kit )

The copy constructor creates a new LineAttributeKit object that contains the same settings as the source object.

Parameters

in_kit The source object to copy.

◆ LineAttributeKit() [3/3]

HPS::LineAttributeKit::LineAttributeKit ( LineAttributeKit && in_that )

The move constructor creates a LineAttributeKit by transferring the underlying impl of the rvalue reference to this LineAttributeKit thereby avoiding a copy and allocation.

Parameters

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

◆ ~LineAttributeKit()

virtual HPS::LineAttributeKit::~LineAttributeKit ( )

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::LineAttributeKit::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::LineAttributeKit::Equals ( LineAttributeKit const & in_kit ) const

Check if the source LineAttributeKit is equivalent to this object.

Parameters

in_kit The source LineAttributeKit 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 LineAttributeKit HPS::LineAttributeKit::GetDefault ( )

static

Creates a LineAttributeKit 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: A LineAttributeKit 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::LineAttributeKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

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

Parameters

in_kit The source LineAttributeKit to compare to this object.

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

◆ operator=() [1/2]

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

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

Parameters

in_that An rvalue reference to an LineAttributeKit to take the impl from.

Returns: A reference to this LineAttributeKit.

◆ operator=() [2/2]

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

Copies the source LineAttributeKit into this object.

Parameters

in_kit The source LineAttributeKit to copy.

Returns: A reference to this object.

◆ operator==()

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

Check if the source LineAttributeKit is equivalent to this object.

Parameters

in_kit The source LineAttributeKit 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::LineAttributeKit::Set ( LineAttributeKit const & in_kit )

Copies all settings from the source LineAttributeKit into this object.

Parameters

in_kit The source LineAttributeKit to copy.

◆ SetPattern() [1/2]

LineAttributeKit& HPS::LineAttributeKit::SetPattern ( char const * in_name )

Specifies the pattern of lines.

Parameters

in_name The name of a line pattern, defined in a portfolio that is accessible.

Returns: A reference to this object.

See also: Programming Guide: Line Patterns

◆ SetPattern() [2/2]

LineAttributeKit& HPS::LineAttributeKit::SetPattern	(	char const *	in_name,
		LinePatternOptionsKit const &	in_options
	)

Specifies the pattern of lines.

Parameters

in_name	The name of a line pattern, defined in a portfolio that is accessible.
in_options	A set of options that modify how the named line pattern is applied.

Returns: A reference to this object.

See also: Programming Guide: Line Patterns

◆ SetWeight()

LineAttributeKit& HPS::LineAttributeKit::SetWeight	(	float	in_weight,
		Line::SizeUnits	in_units = `Line::SizeUnits::ScaleFactor`
	)

Sets the weight of lines.

Parameters

in_weight	The weight value for lines.
in_units	The units applied to in_weight.

Returns: A reference to this object.

◆ Show()

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

Copies all settings from this LineAttributeKit into the given LineAttributeKit.

Parameters

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

◆ ShowPattern()

bool HPS::LineAttributeKit::ShowPattern	(	UTF8 &	out_pattern,
		LinePatternOptionsKit &	out_options
	)		const

Shows the pattern used to draw lines.

Parameters

out_pattern	The name of a line pattern, defined in a portfolio that is accessible.
out_options	A set of options that modify how the named line pattern is applied.

Returns: true if the setting is valid, false otherwise.

◆ ShowWeight()

bool HPS::LineAttributeKit::ShowWeight	(	float &	out_weight,
		Line::SizeUnits &	out_units
	)		const

Shows the weight of lines.

Parameters

out_weight	The weight value for lines.
out_units	The units applied to in_weight.

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

LineAttributeKit& HPS::LineAttributeKit::UnsetEverything ( )

Removes all settings from this object.

Returns: A reference to this object.

◆ UnsetPattern()

LineAttributeKit& HPS::LineAttributeKit::UnsetPattern ( )

Removes the line pattern setting for lines.

Returns: A reference to this object.

◆ UnsetWeight()

LineAttributeKit& HPS::LineAttributeKit::UnsetWeight ( )

Removes the weight setting for lines.

Returns: A reference to this object.

Member Data Documentation

◆ staticType

const HPS::Type HPS::LineAttributeKit::staticType = HPS::Type::LineAttributeKit

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

◆ LineAttributeKit() [1/3]

◆ LineAttributeKit() [2/3]

◆ LineAttributeKit() [3/3]

◆ ~LineAttributeKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetPattern() [1/2]

◆ SetPattern() [2/2]

◆ SetWeight()

◆ Show()

◆ ShowPattern()

◆ ShowWeight()

◆ Type()

◆ UnsetEverything()

◆ UnsetPattern()

◆ UnsetWeight()

Member Data Documentation

◆ staticType