#include <hps.h>

Inheritance diagram for HPS::HighlightSearchOptionsKit:
HPS::Kit HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (HighlightSearchOptionsKit const &in_kit) const
 
 HighlightSearchOptionsKit ()
 
 HighlightSearchOptionsKit (HighlightSearchOptionsKit const &in_kit)
 
 HighlightSearchOptionsKit (HighlightSearchOptionsKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (HighlightSearchOptionsKit const &in_kit) const
 
HighlightSearchOptionsKitoperator= (HighlightSearchOptionsKit &&in_that)
 
HighlightSearchOptionsKitoperator= (HighlightSearchOptionsKit const &in_kit)
 
bool operator== (HighlightSearchOptionsKit const &in_kit) const
 
void Set (HighlightSearchOptionsKit const &in_kit)
 
HighlightSearchOptionsKitSetOverlay (Drawing::Overlay in_overlay)
 
HighlightSearchOptionsKitSetOverlays (DrawingOverlayArray const &in_overlays)
 
HighlightSearchOptionsKitSetStyleName (char const *in_style_name)
 
HighlightSearchOptionsKitSetStyleNames (UTF8Array const &in_style_names)
 
void Show (HighlightSearchOptionsKit &out_kit) const
 
bool ShowOverlays (DrawingOverlayArray &out_overlays) const
 
bool ShowStyleNames (UTF8Array &out_style_names) const
 
HighlightSearchOptionsKitUnsetEverything ()
 
HighlightSearchOptionsKitUnsetOverlays ()
 
HighlightSearchOptionsKitUnsetStyleNames ()
 
- 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 HighlightSearchOptionsKit 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::HighlightSearchOptionsKit
 
- 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 HighlightSearchOptionsKit class is a user space object. It is used to filter highlight queries via HighlightControl::ShowHighlightState, HighlightControl::ShowHighlightStates, and WindowKey::FindHighlights.

Constructor & Destructor Documentation

◆ HighlightSearchOptionsKit() [1/3]

HPS::HighlightSearchOptionsKit::HighlightSearchOptionsKit ( )

The default constructor creates an empty HighlightSearchOptionsKit object.

◆ HighlightSearchOptionsKit() [2/3]

HPS::HighlightSearchOptionsKit::HighlightSearchOptionsKit ( HighlightSearchOptionsKit const &  in_kit)

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

Parameters
in_kitThe source HighlightSearchOptionsKit to copy.

◆ HighlightSearchOptionsKit() [3/3]

HPS::HighlightSearchOptionsKit::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_thatAn rvalue reference to a HighlightSearchOptionsKit to take the impl from.

Member Function Documentation

◆ Empty()

bool HPS::HighlightSearchOptionsKit::Empty ( ) const
virtual

Indicates whether this HighlightSearchOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source HighlightSearchOptionsKit is equivalent to this HighlightSearchOptionsKit.

Parameters
in_kitThe source HighlightSearchOptionsKit to compare to this HighlightSearchOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HighlightSearchOptionsKit HPS::HighlightSearchOptionsKit::GetDefault ( )
static

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.

◆ ObjectType()

HPS::Type HPS::HighlightSearchOptionsKit::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::HighlightSearchOptionsKit::operator!= ( HighlightSearchOptionsKit const &  in_kit) const

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

Parameters
in_kitThe source HighlightSearchOptionsKit to compare to this HighlightSearchOptionsKit.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

HighlightSearchOptionsKit& HPS::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_thatAn rvalue reference to a HighlightSearchOptionsKit to take the impl from.
Returns
A reference to this HighlightSearchOptionsKit.

◆ operator=() [2/2]

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

Copies the source HighlightSearchOptionsKit into this HighlightSearchOptionsKit.

Parameters
in_kitThe source HighlightSearchOptionsKit to copy.
Returns
A reference to this HighlightSearchOptionsKit.

◆ operator==()

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

Check if the source HighlightSearchOptionsKit is equivalent to this HighlightSearchOptionsKit.

Parameters
in_kitThe source HighlightSearchOptionsKit to compare to this HighlightSearchOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

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

Copies the source HighlightSearchOptionsKit into this HighlightSearchOptionsKit.

Parameters
in_kitThe source HighlightSearchOptionsKit to copy.

◆ SetOverlay()

HighlightSearchOptionsKit& HPS::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_overlayOverlay type.
Returns
A reference to this object.

◆ SetOverlays()

HighlightSearchOptionsKit& HPS::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_overlaysOverlay types.
Returns
A reference to this object.

◆ SetStyleName()

HighlightSearchOptionsKit& HPS::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_nameUTF8-encoded style name.
Returns
A reference to this HighlightSearchOptionsKit.

◆ SetStyleNames()

HighlightSearchOptionsKit& HPS::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_namesUTF8-encoded style names.
Returns
A reference to this HighlightSearchOptionsKit.

◆ Show()

void HPS::HighlightSearchOptionsKit::Show ( HighlightSearchOptionsKit out_kit) const

Copies this HighlightSearchOptionsKit into the given HighlightSearchOptionsKit.

Parameters
out_kitThe HighlightSearchOptionsKit to populate with the contents of this HighlightSearchOptionsKit.

◆ ShowOverlays()

bool HPS::HighlightSearchOptionsKit::ShowOverlays ( DrawingOverlayArray out_overlays) const

Shows the overlay types to look for when querying highlights.

Parameters
out_overlaysOverlay types.
Returns
true if the setting is valid, false otherwise.

◆ ShowStyleNames()

bool HPS::HighlightSearchOptionsKit::ShowStyleNames ( UTF8Array out_style_names) const

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

Parameters
out_style_namesUTF8-encoded style names.
Returns
true if any style was specified, false otherwise.

◆ UnsetEverything()

HighlightSearchOptionsKit& HPS::HighlightSearchOptionsKit::UnsetEverything ( )

Removes all settings from this HighlightSearchOptionsKit.

Returns
A reference to this HighlightSearchOptionsKit.

◆ UnsetOverlays()

HighlightSearchOptionsKit& HPS::HighlightSearchOptionsKit::UnsetOverlays ( )

Removes all overlay filters.

Returns
A reference to this object.

◆ UnsetStyleNames()

HighlightSearchOptionsKit& HPS::HighlightSearchOptionsKit::UnsetStyleNames ( )

Removes all style filters.

Returns
A reference to this HighlightSearchOptionsKit.

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