The HPS::UpdateOptionsKit class is a user space object. More...

#include <hps.h>

Inheritance diagram for HPS::UpdateOptionsKit:

Collaboration diagram for HPS::UpdateOptionsKit:

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

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

	UpdateOptionsKit (UpdateOptionsKit &&in_that)
	The move constructor creates a UpdateOptionsKit by transferring the underlying impl of the rvalue reference to this UpdateOptionsKit thereby avoiding a copy and allocation. More...

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

virtual	~UpdateOptionsKit ()

HPS::Type	ObjectType () const

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

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

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

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

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

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

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

UpdateOptionsKit &	SetUpdateType (HPS::Window::UpdateType in_type)
	Sets the type of update of this UpdateOptionsKit. More...

UpdateOptionsKit &	SetTimeLimit (HPS::Time in_time_limit)
	Sets the time limit of this UpdateOptionsKit. More...

UpdateOptionsKit &	UnsetUpdateType ()
	Removes the type of control for this UpdateOptionsKit. More...

UpdateOptionsKit &	UnsetTimeLimit ()
	Removes the time limit of this UpdateOptionsKit. More...

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

bool	ShowUpdateType (HPS::Window::UpdateType &out_type) const
	Shows the type of control from this UpdateOptionsKit. More...

bool	ShowTimeLimit (HPS::Time &out_time_limit) const
	Shows the time limit from this UpdateOptionsKit. 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 UpdateOptionsKit	GetDefault ()
	Creates a UpdateOptionsKit 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::UpdateOptionsKit

Detailed Description

The HPS::UpdateOptionsKit class is a user space object.

It contains options related to selection. Calling HPS::UpdateOptionsKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ UpdateOptionsKit() [1/3]

HPS::UpdateOptionsKit::UpdateOptionsKit ( )

The default constructor creates an empty UpdateOptionsKit object.

◆ UpdateOptionsKit() [2/3]

HPS::UpdateOptionsKit::UpdateOptionsKit ( UpdateOptionsKit const & in_kit )

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

Parameters

in_kit The source UpdateOptionsKit to copy.

◆ UpdateOptionsKit() [3/3]

HPS::UpdateOptionsKit::UpdateOptionsKit ( UpdateOptionsKit && in_that )

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

Parameters

in_that An rvalue reference to a UpdateOptionsKit to take the impl from.

◆ ~UpdateOptionsKit()

virtual HPS::UpdateOptionsKit::~UpdateOptionsKit ( )

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::UpdateOptionsKit::Empty ( ) const

virtual

Indicates whether this UpdateOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source UpdateOptionsKit is equivalent to this UpdateOptionsKit.

Parameters

in_kit The source UpdateOptionsKit to compare to this UpdateOptionsKit.

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 UpdateOptionsKit HPS::UpdateOptionsKit::GetDefault ( )

static

Creates a UpdateOptionsKit 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 UpdateOptionsKit 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::UpdateOptionsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

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

Parameters

in_kit The source UpdateOptionsKit to compare to this UpdateOptionsKit.

Returns: true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

UpdateOptionsKit& HPS::UpdateOptionsKit::operator= ( UpdateOptionsKit && in_that )

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

Parameters

in_that An rvalue reference to a UpdateOptionsKit to take the impl from.

Returns: A reference to this UpdateOptionsKit.

◆ operator=() [2/2]

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

Copies the source UpdateOptionsKit into this UpdateOptionsKit.

Parameters

in_kit The source UpdateOptionsKit to copy.

Returns: A reference to this UpdateOptionsKit.

◆ operator==()

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

Check if the source UpdateOptionsKit is equivalent to this UpdateOptionsKit.

Parameters

in_kit The source UpdateOptionsKit to compare to this UpdateOptionsKit.

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

Copies the source UpdateOptionsKit into this UpdateOptionsKit.

Parameters

in_kit The source UpdateOptionsKit to copy.

◆ SetTimeLimit()

UpdateOptionsKit& HPS::UpdateOptionsKit::SetTimeLimit ( HPS::Time in_time_limit )

Sets the time limit of this UpdateOptionsKit.

Parameters

in_time_limit The time limit for this UpdateOptionsKit update.

Returns: A reference to this UpdateOptionsKit.

◆ SetUpdateType()

UpdateOptionsKit& HPS::UpdateOptionsKit::SetUpdateType ( HPS::Window::UpdateType in_type )

Sets the type of update of this UpdateOptionsKit.

Parameters

in_type The type of update that this UpdateOptionsKit will perform.

Returns: A reference to this UpdateOptionsKit.

◆ Show()

void HPS::UpdateOptionsKit::Show ( UpdateOptionsKit & out_kit ) const

Copies this UpdateOptionsKit into the given UpdateOptionsKit.

Parameters

out_kit The UpdateOptionsKit to populate with the contents of this UpdateOptionsKit.

◆ ShowTimeLimit()

bool HPS::UpdateOptionsKit::ShowTimeLimit ( HPS::Time & out_time_limit ) const

Shows the time limit from this UpdateOptionsKit.

Parameters

out_proximity The selection proximity.

Returns: true if the time limit is valid, false otherwise.

◆ ShowUpdateType()

bool HPS::UpdateOptionsKit::ShowUpdateType ( HPS::Window::UpdateType & out_type ) const

Shows the type of control from this UpdateOptionsKit.

Parameters

out_type The type of update.

Returns: true if the type is valid, 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()

UpdateOptionsKit& HPS::UpdateOptionsKit::UnsetEverything ( )

Removes all settings from this UpdateOptionsKit.

Returns: A reference to this UpdateOptionsKit.

◆ UnsetTimeLimit()

UpdateOptionsKit& HPS::UpdateOptionsKit::UnsetTimeLimit ( )

Removes the time limit of this UpdateOptionsKit.

Returns: A reference to this UpdateOptionsKit.

◆ UnsetUpdateType()

UpdateOptionsKit& HPS::UpdateOptionsKit::UnsetUpdateType ( )

Removes the type of control for this UpdateOptionsKit.

Returns: A reference to this UpdateOptionsKit.

Member Data Documentation

◆ staticType

const HPS::Type HPS::UpdateOptionsKit::staticType = HPS::Type::UpdateOptionsKit

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

◆ UpdateOptionsKit() [1/3]

◆ UpdateOptionsKit() [2/3]

◆ UpdateOptionsKit() [3/3]

◆ ~UpdateOptionsKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetTimeLimit()

◆ SetUpdateType()

◆ Show()

◆ ShowTimeLimit()

◆ ShowUpdateType()

◆ Type()

◆ UnsetEverything()

◆ UnsetTimeLimit()

◆ UnsetUpdateType()

Member Data Documentation

◆ staticType