HighlightOptionsKit

class HighlightOptionsKit : public HPS::Kit

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.

Public Functions

virtual bool Empty() const

Indicates whether this HighlightOptionsKit has any values set on it.

Returns:

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

bool 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.

HighlightOptionsKit()

The default constructor creates an empty HighlightOptionsKit object.

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

inline virtual HPS::Type ObjectType() const

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.

bool 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.

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.

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.

bool 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.

void Set(HighlightOptionsKit const &in_kit)

Copies the source HighlightOptionsKit into this HighlightOptionsKit.

Parameters:

in_kit – The source HighlightOptionsKit to copy.

HighlightOptionsKit &SetNotification(bool in_state)

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

See also

Notification default value

Parameters:

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

Returns:

A reference to this HighlightOptionsKit.

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.

See also

Overlay default value

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.

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.

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.

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.

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.

void 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.

bool 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.

bool 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.

bool 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.

bool 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.

bool 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.

bool 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.

HighlightOptionsKit &UnsetEverything()

Removes all settings from this HighlightOptionsKit.

Returns:

A reference to this HighlightOptionsKit.

HighlightOptionsKit &UnsetNotification()

Removes the notification setting.

Returns:

A reference to this HighlightOptionsKit.

HighlightOptionsKit &UnsetOverlay()

Removes an overlay setting.

Returns:

A reference to this object.

HighlightOptionsKit &UnsetPassive()

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

Returns:

A reference to this HighlightOptionsKit.

HighlightOptionsKit &UnsetSecondaryStyleName()

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

Returns:

A reference to this HighlightOptionsKit.

HighlightOptionsKit &UnsetStyleName()

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

Returns:

A reference to this HighlightOptionsKit.

HighlightOptionsKit &UnsetSubentityHighlighting()

Removes whether subentity highlighting is enabled.

Returns:

A reference to this HighlightOptionsKit.

virtual ~HighlightOptionsKit()

Public Static Functions

static HighlightOptionsKit GetDefault()

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.

Public Static Attributes

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