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

#include <hps.h>

Inheritance diagram for HPS::HighlightOptionsKit:

Collaboration diagram for HPS::HighlightOptionsKit:

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

	HighlightOptionsKit (char const *in_style_name)
	This constructor creates a HighlightOptionsKit object with the specified style name set on it. More...

	HighlightOptionsKit (char const in_style_name, char const in_secondary_style_name)
	This constructor creates a HighlightOptionsKit object with the specified style and secondary style names set on it. More...

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

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

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

virtual	~HighlightOptionsKit ()

HPS::Type	ObjectType () const

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

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

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

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

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

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

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

HighlightOptionsKit &	SetPassive (bool in_pasive)
	Sets whether the highlight(s) to apply (or unapply) are passive. More...

HighlightOptionsKit &	SetStyleName (char const *in_style_name)
	Sets the name of the style to apply (or unapply) when highlighting (or unhighlighting). More...

HighlightOptionsKit &	SetSecondaryStyleName (char const *in_style_name)
	Sets the name of the secondary style to apply (or unapply) when highlighting (or unhighlighting). More...

HighlightOptionsKit &	SetOverlay (Drawing::Overlay in_overlay)
	Allows highlighting to take place in a segment without triggering a full-screen redraw. More...

HighlightOptionsKit &	SetNotification (bool in_state)
	Whether to inject a notification event after highlighting (or unhighlighting). More...

HighlightOptionsKit &	SetSubentityHighlighting (bool in_enable)
	Sets whether subentity highlighting is enabled. More...

HighlightOptionsKit &	UnsetPassive ()
	Removes any preference on whether this highlight is passive or active. More...

HighlightOptionsKit &	UnsetStyleName ()
	Removes the style to apply (or unapply) when highlighting (or unhighlighting). More...

HighlightOptionsKit &	UnsetSecondaryStyleName ()
	Removes the secondary style to apply (or unapply) when highlighting (or unhighlighting). More...

HighlightOptionsKit &	UnsetOverlay ()
	Removes an overlay setting. More...

HighlightOptionsKit &	UnsetNotification ()
	Removes the notification setting. More...

HighlightOptionsKit &	UnsetSubentityHighlighting ()
	Removes whether subentity highlighting is enabled. More...

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

bool	ShowPassive (bool &out_pasive) const
	Shows whether the highlight(s) to apply (or unapply) is passive. More...

bool	ShowStyleName (UTF8 &out_style_name) const
	Shows the name of the style to apply (or unapply) when highlighting (or unhighlighting). More...

bool	ShowSecondaryStyleName (UTF8 &out_style_name) const
	Shows the name of the secondary style to apply (or unapply) when highlighting (or unhighlighting). More...

bool	ShowOverlay (Drawing::Overlay &out_overlay) const
	Shows the overlay setting. More...

bool	ShowNotification (bool &out_state) const
	Shows the notification setting. More...

bool	ShowSubentityHighlighting (bool &out_enable) const
	Shows whether subentity highlighting is enabled. 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 HighlightOptionsKit	GetDefault ()
	Creates a HighlightOptionsKit 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::HighlightOptionsKit

Detailed Description

The HighlightOptionsKit class is a user space object.

It is used to hold settings needed when performing a highlight or unhighlight. HPS::HighlightOptionsKit::GetDefault() will return a highlight options kit with values found in this table.

Constructor & Destructor Documentation

◆ HighlightOptionsKit() [1/5]

HPS::HighlightOptionsKit::HighlightOptionsKit ( )

The default constructor creates an empty HighlightOptionsKit object.

◆ HighlightOptionsKit() [2/5]

HPS::HighlightOptionsKit::HighlightOptionsKit ( char const * in_style_name )

This constructor creates a HighlightOptionsKit object with the specified style name set on it.

Parameters

in_style_name The style name to set on this HighlightOptionsKit.

◆ HighlightOptionsKit() [3/5]

HPS::HighlightOptionsKit::HighlightOptionsKit	(	char const *	in_style_name,
		char const *	in_secondary_style_name
	)

This constructor creates a HighlightOptionsKit object with the specified style and secondary style names set on it.

Parameters

in_style_name	The style name to set on this HighlightOptionsKit.
in_secondary_style_name	The style name to set on this HighlightOptionsKit.

◆ HighlightOptionsKit() [4/5]

HPS::HighlightOptionsKit::HighlightOptionsKit ( HighlightOptionsKit const & in_kit )

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

Parameters

in_kit The source HighlightOptionsKit to copy.

◆ HighlightOptionsKit() [5/5]

HPS::HighlightOptionsKit::HighlightOptionsKit ( HighlightOptionsKit && in_that )

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

Parameters

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

◆ ~HighlightOptionsKit()

virtual HPS::HighlightOptionsKit::~HighlightOptionsKit ( )

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

virtual

Indicates whether this HighlightOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source HighlightOptionsKit is equivalent to this HighlightOptionsKit.

Parameters

in_kit The source HighlightOptionsKit to compare to this HighlightOptionsKit.

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 HighlightOptionsKit HPS::HighlightOptionsKit::GetDefault ( )

static

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

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

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

Parameters

in_kit The source HighlightOptionsKit to compare to this HighlightOptionsKit.

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

◆ operator=() [1/2]

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

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

Parameters

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

Returns: A reference to this HighlightOptionsKit.

◆ operator=() [2/2]

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

Copies the source HighlightOptionsKit into this HighlightOptionsKit.

Parameters

in_kit The source HighlightOptionsKit to copy.

Returns: A reference to this HighlightOptionsKit.

◆ operator==()

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

Check if the source HighlightOptionsKit is equivalent to this HighlightOptionsKit.

Parameters

in_kit The source HighlightOptionsKit to compare to this HighlightOptionsKit.

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

Copies the source HighlightOptionsKit into this HighlightOptionsKit.

Parameters

in_kit The source HighlightOptionsKit to copy.

◆ SetNotification()

HighlightOptionsKit& HPS::HighlightOptionsKit::SetNotification ( bool in_state )

Whether to inject a notification event after highlighting (or unhighlighting).

Parameters

in_state Whether to inject a notification event after highlighting (or unhighlighting).

Returns: A reference to this HighlightOptionsKit.

See also: Notification default value

◆ SetOverlay()

HighlightOptionsKit& HPS::HighlightOptionsKit::SetOverlay ( Drawing::Overlay in_overlay )

Allows highlighting to take place in a segment without triggering a full-screen redraw.

If any type of overlay is used, transparency in the highlighted object(s) will be ignored.

Note: If in_overlay is specified as Drawing::Overlay::None, Drawing::Overlay::InPlace will be used instead

Parameters

in_overlay The type of overlay, if any, to be used. If this HighlightOptionsKit is being passed to an Unhighlight call, only highlights whose overlay type match in_overlay will be removed.

Returns: A reference to this object.

See also: Overlay default value

◆ SetPassive()

HighlightOptionsKit& HPS::HighlightOptionsKit::SetPassive ( bool in_pasive )

Sets whether the highlight(s) to apply (or unapply) are passive.

Parameters

in_pasive If set to true attribute locks set on the path being highlighted will be honored by the highlight. If set to false attribute locks set on the path being highlighted will be overriden by the highlight. If unspecified the default is false. If this HighlightOptionsKit is being passed to an Unhighlight call, only highlights whose passiveness match in_pasive will be removed.

Returns: A reference to this HighlightOptionsKit.

◆ SetSecondaryStyleName()

HighlightOptionsKit& HPS::HighlightOptionsKit::SetSecondaryStyleName ( char const * in_style_name )

Sets the name of the secondary style to apply (or unapply) when highlighting (or unhighlighting).

Parameters

in_style_name UTF8-encoded style name.

Returns: A reference to this HighlightOptionsKit.

◆ SetStyleName()

HighlightOptionsKit& HPS::HighlightOptionsKit::SetStyleName ( char const * in_style_name )

Sets the name of the style to apply (or unapply) when highlighting (or unhighlighting).

Parameters

in_style_name UTF8-encoded style name. If this HighlightOptionsKit is being passed to an Unhighlight call, only highlights whose style name match in_style_name will be removed.

Returns: A reference to this HighlightOptionsKit.

◆ SetSubentityHighlighting()

HighlightOptionsKit& HPS::HighlightOptionsKit::SetSubentityHighlighting ( bool in_enable )

Sets whether subentity highlighting is enabled.

Parameters

in_enable Whether subentity highlighting is enabled.

Returns: A reference to this HighlightOptionsKit.

◆ Show()

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

Copies this HighlightOptionsKit into the given HighlightOptionsKit.

Parameters

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

◆ ShowNotification()

bool HPS::HighlightOptionsKit::ShowNotification ( bool & out_state ) const

Shows the notification setting.

Parameters

out_state Whether to inject a notification event after highlighting (or unhighlighting).

Returns: true if a notification setting was specified, false otherwise.

◆ ShowOverlay()

bool HPS::HighlightOptionsKit::ShowOverlay ( Drawing::Overlay & out_overlay ) const

Shows the overlay setting.

Parameters

out_overlay The type of overlay, if any, used.

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

◆ ShowPassive()

bool HPS::HighlightOptionsKit::ShowPassive ( bool & out_pasive ) const

Shows whether the highlight(s) to apply (or unapply) is passive.

Parameters

out_pasive Indicates whether the highlight(s) to apply (or unapply) is passive.

Returns: A reference to this HighlightOptionsKit.

◆ ShowSecondaryStyleName()

bool HPS::HighlightOptionsKit::ShowSecondaryStyleName ( UTF8 & out_style_name ) const

Shows the name of the secondary style to apply (or unapply) when highlighting (or unhighlighting).

Parameters

out_style_name UTF8-encoded style name.

Returns: true if a style was specified, false otherwise.

◆ ShowStyleName()

bool HPS::HighlightOptionsKit::ShowStyleName ( UTF8 & out_style_name ) const

Shows the name of the style to apply (or unapply) when highlighting (or unhighlighting).

Parameters

out_style_name UTF8-encoded style name.

Returns: true if a style was specified, false otherwise.

◆ ShowSubentityHighlighting()

bool HPS::HighlightOptionsKit::ShowSubentityHighlighting ( bool & out_enable ) const

Shows whether subentity highlighting is enabled.

Parameters

out_enable Whether subentity highlighting is enabled.

Returns: true if a flag was specified, 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()

HighlightOptionsKit& HPS::HighlightOptionsKit::UnsetEverything ( )

Removes all settings from this HighlightOptionsKit.

Returns: A reference to this HighlightOptionsKit.

◆ UnsetNotification()

HighlightOptionsKit& HPS::HighlightOptionsKit::UnsetNotification ( )

Removes the notification setting.

Returns: A reference to this HighlightOptionsKit.

◆ UnsetOverlay()

HighlightOptionsKit& HPS::HighlightOptionsKit::UnsetOverlay ( )

Removes an overlay setting.

Returns: A reference to this object.

◆ UnsetPassive()

HighlightOptionsKit& HPS::HighlightOptionsKit::UnsetPassive ( )

Removes any preference on whether this highlight is passive or active.

Returns: A reference to this HighlightOptionsKit.

◆ UnsetSecondaryStyleName()

HighlightOptionsKit& HPS::HighlightOptionsKit::UnsetSecondaryStyleName ( )

Removes the secondary style to apply (or unapply) when highlighting (or unhighlighting).

Returns: A reference to this HighlightOptionsKit.

◆ UnsetStyleName()

HighlightOptionsKit& HPS::HighlightOptionsKit::UnsetStyleName ( )

Removes the style to apply (or unapply) when highlighting (or unhighlighting).

Returns: A reference to this HighlightOptionsKit.

◆ UnsetSubentityHighlighting()

HighlightOptionsKit& HPS::HighlightOptionsKit::UnsetSubentityHighlighting ( )

Removes whether subentity highlighting is enabled.

Returns: A reference to this HighlightOptionsKit.

Member Data Documentation

◆ staticType

const HPS::Type HPS::HighlightOptionsKit::staticType = HPS::Type::HighlightOptionsKit

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

◆ HighlightOptionsKit() [1/5]

◆ HighlightOptionsKit() [2/5]

◆ HighlightOptionsKit() [3/5]

◆ HighlightOptionsKit() [4/5]

◆ HighlightOptionsKit() [5/5]

◆ ~HighlightOptionsKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetNotification()

◆ SetOverlay()

◆ SetPassive()

◆ SetSecondaryStyleName()

◆ SetStyleName()

◆ SetSubentityHighlighting()

◆ Show()

◆ ShowNotification()

◆ ShowOverlay()

◆ ShowPassive()

◆ ShowSecondaryStyleName()

◆ ShowStyleName()

◆ ShowSubentityHighlighting()

◆ Type()

◆ UnsetEverything()

◆ UnsetNotification()

◆ UnsetOverlay()

◆ UnsetPassive()

◆ UnsetSecondaryStyleName()

◆ UnsetStyleName()

◆ UnsetSubentityHighlighting()

Member Data Documentation

◆ staticType