#include <hps.h>

Inheritance diagram for HPS::HighlightOptionsKit:
HPS::Kit HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (HighlightOptionsKit const &in_kit) const
 
 HighlightOptionsKit ()
 
 HighlightOptionsKit (char const *in_style_name)
 
 HighlightOptionsKit (char const *in_style_name, char const *in_secondary_style_name)
 
 HighlightOptionsKit (HighlightOptionsKit const &in_kit)
 
 HighlightOptionsKit (HighlightOptionsKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (HighlightOptionsKit const &in_kit) const
 
HighlightOptionsKitoperator= (HighlightOptionsKit &&in_that)
 
HighlightOptionsKitoperator= (HighlightOptionsKit const &in_kit)
 
bool operator== (HighlightOptionsKit const &in_kit) const
 
void Set (HighlightOptionsKit const &in_kit)
 
HighlightOptionsKitSetNotification (bool in_state)
 
HighlightOptionsKitSetOverlay (Drawing::Overlay in_overlay)
 
HighlightOptionsKitSetPassive (bool in_pasive)
 
HighlightOptionsKitSetSecondaryStyleName (char const *in_style_name)
 
HighlightOptionsKitSetStyleName (char const *in_style_name)
 
HighlightOptionsKitSetSubentityHighlighting (bool in_enable)
 
void Show (HighlightOptionsKit &out_kit) const
 
bool ShowNotification (bool &out_state) const
 
bool ShowOverlay (Drawing::Overlay &out_overlay) const
 
bool ShowPassive (bool &out_pasive) const
 
bool ShowSecondaryStyleName (UTF8 &out_style_name) const
 
bool ShowStyleName (UTF8 &out_style_name) const
 
bool ShowSubentityHighlighting (bool &out_enable) const
 
HighlightOptionsKitUnsetEverything ()
 
HighlightOptionsKitUnsetNotification ()
 
HighlightOptionsKitUnsetOverlay ()
 
HighlightOptionsKitUnsetPassive ()
 
HighlightOptionsKitUnsetSecondaryStyleName ()
 
HighlightOptionsKitUnsetStyleName ()
 
HighlightOptionsKitUnsetSubentityHighlighting ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Member Functions

static HighlightOptionsKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::HighlightOptionsKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

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_nameThe 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_nameThe style name to set on this HighlightOptionsKit.
in_secondary_style_nameThe 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_kitThe 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_thatAn rvalue reference to a HighlightOptionsKit to take the impl from.

Member Function Documentation

◆ 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_kitThe source HighlightOptionsKit to compare to this HighlightOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

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

◆ ObjectType()

HPS::Type HPS::HighlightOptionsKit::ObjectType ( ) const
inlinevirtual

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.

Reimplemented from HPS::Kit.

◆ operator!=()

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

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

Parameters
in_kitThe 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_thatAn 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_kitThe 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_kitThe source HighlightOptionsKit to compare to this HighlightOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

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

Copies the source HighlightOptionsKit into this HighlightOptionsKit.

Parameters
in_kitThe source HighlightOptionsKit to copy.

◆ SetNotification()

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

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

Parameters
in_stateWhether 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_overlayThe 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_pasiveIf 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_nameUTF8-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_nameUTF8-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_enableWhether 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_kitThe HighlightOptionsKit to populate with the contents of this HighlightOptionsKit.

◆ ShowNotification()

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

Shows the notification setting.

Parameters
out_stateWhether 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_overlayThe 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_pasiveIndicates 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_nameUTF8-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_nameUTF8-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_enableWhether subentity highlighting is enabled.
Returns
true if a flag was specified, false otherwise.

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

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