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

#include <hps.h>

Inheritance diagram for HPS::HighlightSearchOptionsKit:

Collaboration diagram for HPS::HighlightSearchOptionsKit:

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

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

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

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

virtual	~HighlightSearchOptionsKit ()

HPS::Type	ObjectType () const

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

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

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

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

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

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

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

HighlightSearchOptionsKit &	SetStyleName (char const *in_style_name)
	Sets the name of the style to look for when querying highlights. More...

HighlightSearchOptionsKit &	SetStyleNames (UTF8Array const &in_style_names)
	Sets the names of the styles to look for when querying highlights. More...

HighlightSearchOptionsKit &	SetOverlay (Drawing::Overlay in_overlay)
	Sets the overlay type to look for when querying highlights. More...

HighlightSearchOptionsKit &	SetOverlays (DrawingOverlayArray const &in_overlays)
	Sets the overlay types to look for when querying highlights. More...

HighlightSearchOptionsKit &	UnsetStyleNames ()
	Removes all style filters. More...

HighlightSearchOptionsKit &	UnsetOverlays ()
	Removes all overlay filters. More...

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

bool	ShowStyleNames (UTF8Array &out_style_names) const
	Shows the names of the styles to look for when querying highlights. More...

bool	ShowOverlays (DrawingOverlayArray &out_overlays) const
	Shows the overlay types to look for when querying highlights. 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 HighlightSearchOptionsKit	GetDefault ()
	Creates a HighlightSearchOptionsKit 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::HighlightSearchOptionsKit

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_kit The 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_that An rvalue reference to a HighlightSearchOptionsKit to take the impl from.

◆ ~HighlightSearchOptionsKit()

virtual HPS::HighlightSearchOptionsKit::~HighlightSearchOptionsKit ( )

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::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_kit The source HighlightSearchOptionsKit to compare to this HighlightSearchOptionsKit.

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

◆ 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::HighlightSearchOptionsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

bool HPS::HighlightSearchOptionsKit::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.

◆ 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_that An 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_kit The 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_kit The source HighlightSearchOptionsKit to compare to this HighlightSearchOptionsKit.

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

Copies the source HighlightSearchOptionsKit into this HighlightSearchOptionsKit.

Parameters

in_kit The 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_overlay Overlay 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_overlays Overlay 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_name UTF8-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_names UTF8-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_kit The 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_overlays Overlay 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_names UTF8-encoded style names.

Returns: true if any style 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()

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.

Member Data Documentation

◆ staticType

const HPS::Type HPS::HighlightSearchOptionsKit::staticType = HPS::Type::HighlightSearchOptionsKit

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

◆ HighlightSearchOptionsKit() [1/3]

◆ HighlightSearchOptionsKit() [2/3]

◆ HighlightSearchOptionsKit() [3/3]

◆ ~HighlightSearchOptionsKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetOverlay()

◆ SetOverlays()

◆ SetStyleName()

◆ SetStyleNames()

◆ Show()

◆ ShowOverlays()

◆ ShowStyleNames()

◆ Type()

◆ UnsetEverything()

◆ UnsetOverlays()

◆ UnsetStyleNames()

Member Data Documentation

◆ staticType