The LinePatternOptionsKit class is a user space object. More...

#include <hps.h>

Inheritance diagram for HPS::LinePatternOptionsKit:

Collaboration diagram for HPS::LinePatternOptionsKit:

Public Member Functions
	LinePatternOptionsKit ()
	The default constructor creates an empty LinePatternOptionsKit object. More...

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

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

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

virtual	~LinePatternOptionsKit ()

HPS::Type	ObjectType () const

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

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

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

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

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

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

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

LinePatternOptionsKit &	SetStartCap (char const *in_glyph)
	Sets the glyph to use as the start cap for the associated line pattern. More...

LinePatternOptionsKit &	SetStartCap (LinePattern::Cap in_type)
	Sets the cap to use as the start cap for the associated line pattern. More...

LinePatternOptionsKit &	SetEndCap (char const *in_glyph)
	Sets the glyph to use as the end cap for the associated line pattern. More...

LinePatternOptionsKit &	SetEndCap (LinePattern::Cap in_type)
	Sets the cap to use as the end cap for the associated line pattern. More...

LinePatternOptionsKit &	SetInnerCap (LinePattern::Cap in_type)
	Sets the cap to use as the inner cap for the associated line pattern. More...

LinePatternOptionsKit &	SetJoin (char const *in_glyph)
	Sets the glyph to use as the join for the associated line pattern. More...

LinePatternOptionsKit &	SetJoin (LinePattern::Join in_type)
	Sets the join to use for the associated line pattern. More...

LinePatternOptionsKit &	UnsetStartCap ()
	Removes the start cap for this LinePatternOptionsKit. More...

LinePatternOptionsKit &	UnsetEndCap ()
	Removes the end cap for this LinePatternOptionsKit. More...

LinePatternOptionsKit &	UnsetInnerCap ()
	Removes the inner cap for this LinePatternOptionsKit. More...

LinePatternOptionsKit &	UnsetJoin ()
	Removes the join for this LinePatternOptionsKit. More...

LinePatternOptionsKit &	UnsetEverything ()
	Removes all settings from this LinePatternOptionsKit. More...

bool	ShowStartCap (LinePattern::Modifier &out_modifier, UTF8 &out_glyph, LinePattern::Cap &out_type) const
	Shows the start cap for this LinePatternOptionsKit. More...

bool	ShowEndCap (LinePattern::Modifier &out_modifier, UTF8 &out_glyph, LinePattern::Cap &out_type) const
	Shows the end cap for this LinePatternOptionsKit. More...

bool	ShowInnerCap (LinePattern::Cap &out_type) const
	Shows the inner cap for this LinePatternOptionsKit. More...

bool	ShowJoin (LinePattern::Modifier &out_modifier, UTF8 &out_glyph, LinePattern::Join &out_type) const
	Shows the join for this LinePatternOptionsKit. 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
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

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

Detailed Description

The LinePatternOptionsKit class is a user space object.

It is used for specifying (or overriding) some line pattern options when setting a line pattern on a segment.

Constructor & Destructor Documentation

◆ LinePatternOptionsKit() [1/3]

HPS::LinePatternOptionsKit::LinePatternOptionsKit ( )

The default constructor creates an empty LinePatternOptionsKit object.

◆ LinePatternOptionsKit() [2/3]

HPS::LinePatternOptionsKit::LinePatternOptionsKit ( LinePatternOptionsKit const & in_kit )

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

Parameters

in_kit The source LinePatternOptionsKit to copy.

◆ LinePatternOptionsKit() [3/3]

HPS::LinePatternOptionsKit::LinePatternOptionsKit ( LinePatternOptionsKit && in_that )

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

Parameters

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

◆ ~LinePatternOptionsKit()

virtual HPS::LinePatternOptionsKit::~LinePatternOptionsKit ( )

virtual

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::LinePatternOptionsKit::Empty ( ) const

virtual

Indicates whether this LinePatternOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source LinePatternOptionsKit is equivalent to this LinePatternOptionsKit.

Parameters

in_kit The source LinePatternOptionsKit to compare to this LinePatternOptionsKit.

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.

◆ 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::LinePatternOptionsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

Check if the source LinePatternOptionsKit is not equivalent to this LinePatternOptionsKit.

Parameters

in_kit The source LinePatternOptionsKit to compare to this LinePatternOptionsKit.

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

◆ operator=() [1/2]

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

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

Parameters

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

Returns: A reference to this LinePatternOptionsKit.

◆ operator=() [2/2]

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

Copies the source LinePatternOptionsKit into this LinePatternOptionsKit.

Parameters

in_kit The source LinePatternOptionsKit to copy.

Returns: A reference to this LinePatternOptionsKit.

◆ operator==()

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

Check if the source LinePatternOptionsKit is equivalent to this LinePatternOptionsKit.

Parameters

in_kit The source LinePatternOptionsKit to compare to this LinePatternOptionsKit.

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::LinePatternOptionsKit::Set ( LinePatternOptionsKit const & in_kit )

Copies the source LinePatternOptionsKit into this LinePatternOptionsKit.

Parameters

in_kit The source LinePatternOptionsKit to copy.

◆ SetEndCap() [1/2]

LinePatternOptionsKit& HPS::LinePatternOptionsKit::SetEndCap ( char const * in_glyph )

Sets the glyph to use as the end cap for the associated line pattern.

Parameters

in_glyph UTF8-encoded name of the glyph to use as the end cap for the associated line pattern.

Returns: A reference to this LinePatternOptionsKit.

◆ SetEndCap() [2/2]

LinePatternOptionsKit& HPS::LinePatternOptionsKit::SetEndCap ( LinePattern::Cap in_type )

Sets the cap to use as the end cap for the associated line pattern.

Parameters

in_type The type of cap to use as the end cap for the associated line pattern.

Returns: A reference to this LinePatternOptionsKit.

◆ SetInnerCap()

LinePatternOptionsKit& HPS::LinePatternOptionsKit::SetInnerCap ( LinePattern::Cap in_type )

Sets the cap to use as the inner cap for the associated line pattern.

Parameters

in_type The type of cap to use as the inner cap for the associated line pattern.

Returns: A reference to this LinePatternOptionsKit.

◆ SetJoin() [1/2]

LinePatternOptionsKit& HPS::LinePatternOptionsKit::SetJoin ( char const * in_glyph )

Sets the glyph to use as the join for the associated line pattern.

Parameters

in_glyph UTF8-encoded name of the glyph to use as the join for the associated line pattern.

Returns: A reference to this LinePatternOptionsKit.

◆ SetJoin() [2/2]

LinePatternOptionsKit& HPS::LinePatternOptionsKit::SetJoin ( LinePattern::Join in_type )

Sets the join to use for the associated line pattern.

Parameters

in_type The type of join to use for the associated line pattern.

Returns: A reference to this LinePatternOptionsKit.

◆ SetStartCap() [1/2]

LinePatternOptionsKit& HPS::LinePatternOptionsKit::SetStartCap ( char const * in_glyph )

Sets the glyph to use as the start cap for the associated line pattern.

Parameters

in_glyph UTF8-encoded name of the glyph to use as the start cap for the associated line pattern.

Returns: A reference to this LinePatternOptionsKit.

◆ SetStartCap() [2/2]

LinePatternOptionsKit& HPS::LinePatternOptionsKit::SetStartCap ( LinePattern::Cap in_type )

Sets the cap to use as the start cap for the associated line pattern.

Parameters

in_type The type of cap to use as the start cap for the associated line pattern.

Returns: A reference to this LinePatternOptionsKit.

◆ Show()

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

Copies this LinePatternOptionsKit into the given LinePatternOptionsKit.

Parameters

out_kit The LinePatternOptionsKit to populate with the contents of this LinePatternOptionsKit.

◆ ShowEndCap()

bool HPS::LinePatternOptionsKit::ShowEndCap	(	LinePattern::Modifier &	out_modifier,
		UTF8 &	out_glyph,
		LinePattern::Cap &	out_type
	)		const

Shows the end cap for this LinePatternOptionsKit.

Parameters

out_modifier	Indicates which of the following arguments is valid.
out_glyph	UTF8-encoded name of the glyph to use as the end cap. This is only valid if out_modifier is LinePattern::Modifier::GlyphName.
out_type	The predefined type of cap to use as the end cap. This is only valid if out_modifier is LinePattern::Modifier::Enumerated.

Returns: true if an end cap was set, false otherwise.

◆ ShowInnerCap()

bool HPS::LinePatternOptionsKit::ShowInnerCap ( LinePattern::Cap & out_type ) const

Shows the inner cap for this LinePatternOptionsKit.

Parameters

out_type The predefined type of cap to use as the inner cap.

Returns: true if an inner cap was set, false otherwise.

◆ ShowJoin()

bool HPS::LinePatternOptionsKit::ShowJoin	(	LinePattern::Modifier &	out_modifier,
		UTF8 &	out_glyph,
		LinePattern::Join &	out_type
	)		const

Shows the join for this LinePatternOptionsKit.

Parameters

out_modifier	Indicates which of the following arguments is valid.
out_glyph	UTF8-encoded name of the glyph to use as the join. This is only valid if out_modifier is LinePattern::Modifier::GlyphName.
out_type	The predefined type of join to use. This is only valid if out_modifier is LinePattern::Modifier::Enumerated.

Returns: true if a join was set, false otherwise.

◆ ShowStartCap()

bool HPS::LinePatternOptionsKit::ShowStartCap	(	LinePattern::Modifier &	out_modifier,
		UTF8 &	out_glyph,
		LinePattern::Cap &	out_type
	)		const

Shows the start cap for this LinePatternOptionsKit.

Parameters

out_modifier	Indicates which of the following arguments is valid.
out_glyph	UTF8-encoded name of the glyph to use as the start cap. This is only valid if out_modifier is LinePattern::Modifier::GlyphName.
out_type	The predefined type of cap to use as the start cap. This is only valid if out_modifier is LinePattern::Modifier::Enumerated.

Returns: true if a start cap was set, 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.

◆ UnsetEndCap()

LinePatternOptionsKit& HPS::LinePatternOptionsKit::UnsetEndCap ( )

Removes the end cap for this LinePatternOptionsKit.

This will result in the end cap defined on the associated line pattern (if any) getting used when set with this LinePatternOptionsKit.

Returns: A reference to this LinePatternOptionsKit.

◆ UnsetEverything()

LinePatternOptionsKit& HPS::LinePatternOptionsKit::UnsetEverything ( )

Removes all settings from this LinePatternOptionsKit.

Returns: A reference to this LinePatternOptionsKit.

◆ UnsetInnerCap()

LinePatternOptionsKit& HPS::LinePatternOptionsKit::UnsetInnerCap ( )

Removes the inner cap for this LinePatternOptionsKit.

Returns: A reference to this LinePatternOptionsKit.

◆ UnsetJoin()

LinePatternOptionsKit& HPS::LinePatternOptionsKit::UnsetJoin ( )

Removes the join for this LinePatternOptionsKit.

This will result in the join defined on the associated line pattern (if any) getting used when set with this LinePatternOptionsKit.

Returns: A reference to this LinePatternOptionsKit.

◆ UnsetStartCap()

LinePatternOptionsKit& HPS::LinePatternOptionsKit::UnsetStartCap ( )

Removes the start cap for this LinePatternOptionsKit.

This will result in the start cap defined on the associated line pattern (if any) getting used when set with this LinePatternOptionsKit.

Returns: A reference to this LinePatternOptionsKit.

Member Data Documentation

◆ staticType

const HPS::Type HPS::LinePatternOptionsKit::staticType = HPS::Type::LinePatternOptionsKit

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

◆ LinePatternOptionsKit() [1/3]

◆ LinePatternOptionsKit() [2/3]

◆ LinePatternOptionsKit() [3/3]

◆ ~LinePatternOptionsKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetEndCap() [1/2]

◆ SetEndCap() [2/2]

◆ SetInnerCap()

◆ SetJoin() [1/2]

◆ SetJoin() [2/2]

◆ SetStartCap() [1/2]

◆ SetStartCap() [2/2]

◆ Show()

◆ ShowEndCap()

◆ ShowInnerCap()

◆ ShowJoin()

◆ ShowStartCap()

◆ Type()

◆ UnsetEndCap()

◆ UnsetEverything()

◆ UnsetInnerCap()

◆ UnsetJoin()

◆ UnsetStartCap()

Member Data Documentation

◆ staticType