HighlightSearchOptionsKit

class HPS::HighlightSearchOptionsKit : public HPS::Kit 

The HighlightSearchOptionsKit class is a user space object. It is used to filter highlight queries via HighlightControl::ShowHighlightState, HighlightControl::ShowHighlightStates, and WindowKey::FindHighlights.

Public Functions

virtual bool Empty() const

Indicates whether this HighlightSearchOptionsKit has any values set on it.

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

bool Equals(HighlightSearchOptionsKit const &in_kit) const

Check if the source HighlightSearchOptionsKit is equivalent to this HighlightSearchOptionsKit.

Parameters: in_kit – The source HighlightSearchOptionsKit to compare to this HighlightSearchOptionsKit.
Returns: true if the objects are equivalent, false otherwise.

HighlightSearchOptionsKit(): The default constructor creates an empty HighlightSearchOptionsKit object.

HighlightSearchOptionsKit(HighlightSearchOptionsKit &&in_that)

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

Parameters: in_that – An rvalue reference to a HighlightSearchOptionsKit to take the impl from.

HighlightSearchOptionsKit(HighlightSearchOptionsKit const &in_kit)

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

Parameters: in_kit – The source HighlightSearchOptionsKit 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!=(HighlightSearchOptionsKit const &in_kit) const

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

Parameters: in_kit – The source HighlightSearchOptionsKit to compare to this HighlightSearchOptionsKit.
Returns: true if the objects are not equivalent, false otherwise.

HighlightSearchOptionsKit &operator=(HighlightSearchOptionsKit &&in_that)

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

Parameters: in_that – An rvalue reference to a HighlightSearchOptionsKit to take the impl from.
Returns: A reference to this HighlightSearchOptionsKit.

HighlightSearchOptionsKit &operator=(HighlightSearchOptionsKit const &in_kit)

Copies the source HighlightSearchOptionsKit into this HighlightSearchOptionsKit.

Parameters: in_kit – The source HighlightSearchOptionsKit to copy.
Returns: A reference to this HighlightSearchOptionsKit.

bool operator==(HighlightSearchOptionsKit const &in_kit) const

Check if the source HighlightSearchOptionsKit is equivalent to this HighlightSearchOptionsKit.

Parameters: in_kit – The source HighlightSearchOptionsKit to compare to this HighlightSearchOptionsKit.
Returns: true if the objects are equivalent, false otherwise.

void Set(HighlightSearchOptionsKit const &in_kit)

Copies the source HighlightSearchOptionsKit into this HighlightSearchOptionsKit.

Parameters: in_kit – The source HighlightSearchOptionsKit to copy.

HighlightSearchOptionsKit &SetOverlay(Drawing::Overlay in_overlay)

Sets the overlay type to look for when querying highlights. Only highlights using this overlay type will be returned by highlight queries.

Parameters: in_overlay – Overlay type.
Returns: A reference to this object.

HighlightSearchOptionsKit &SetOverlays(DrawingOverlayArray const &in_overlays)

Sets the overlay types to look for when querying highlights. Only highlights using any overlay types in the array will be returned by highlight queries.

Parameters: in_overlays – Overlay types.
Returns: A reference to this object.

HighlightSearchOptionsKit &SetStyleName(char const *in_style_name)

Sets the name of the style to look for when querying highlights. Only highlights using this style will be returned by highlight queries.

Parameters: in_style_name – UTF8-encoded style name.
Returns: A reference to this HighlightSearchOptionsKit.

HighlightSearchOptionsKit &SetStyleNames(UTF8Array const &in_style_names)

Sets the names of the styles to look for when querying highlights. Only highlights using any style in the array will be returned by highlight queries.

Parameters: in_style_names – UTF8-encoded style names.
Returns: A reference to this HighlightSearchOptionsKit.

void Show(HighlightSearchOptionsKit &out_kit) const

Copies this HighlightSearchOptionsKit into the given HighlightSearchOptionsKit.

Parameters: out_kit – The HighlightSearchOptionsKit to populate with the contents of this HighlightSearchOptionsKit.

bool ShowOverlays(DrawingOverlayArray &out_overlays) const

Shows the overlay types to look for when querying highlights.

Parameters: out_overlays – Overlay types.
Returns: true if the setting is valid, false otherwise.

bool ShowStyleNames(UTF8Array &out_style_names) const

Shows the names of the styles to look for when querying highlights.

Parameters: out_style_names – UTF8-encoded style names.
Returns: true if any style was specified, false otherwise.

HighlightSearchOptionsKit &UnsetEverything()

Removes all settings from this HighlightSearchOptionsKit.

Returns: A reference to this HighlightSearchOptionsKit.

HighlightSearchOptionsKit &UnsetOverlays()

Removes all overlay filters.

Returns: A reference to this object.

HighlightSearchOptionsKit &UnsetStyleNames()

Removes all style filters.

Returns: A reference to this HighlightSearchOptionsKit.

virtual ~HighlightSearchOptionsKit()

Public Static Functions

static HighlightSearchOptionsKit GetDefault()

Creates a HighlightSearchOptionsKit 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 HighlightSearchOptionsKit with the default settings.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::HighlightSearchOptionsKit