#include <hps.h>

Inheritance diagram for HPS::StandAloneWindowOptionsKit:

Collaboration diagram for HPS::StandAloneWindowOptionsKit:

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

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

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

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

virtual	~StandAloneWindowOptionsKit ()

HPS::Type	ObjectType () const

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

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

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

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

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

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

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

StandAloneWindowOptionsKit &	SetDriver (Window::Driver in_driver)
	Sets the driver for this StandAloneWindowOptionsKit. More...

StandAloneWindowOptionsKit &	SetAntiAliasCapable (bool in_state, unsigned int in_samples=4)
	Sets the anti-alias options for this StandAloneWindowOptionsKit. More...

StandAloneWindowOptionsKit &	SetTitle (char const *in_window_name)
	Sets the title for this StandAloneWindowOptionsKit. More...

StandAloneWindowOptionsKit &	SetSubscreen (Rectangle const &in_subscreen)
	Sets the subscreen to render into for this StandAloneWindowOptionsKit. More...

StandAloneWindowOptionsKit &	SetMobility (Window::Mobility in_mobility)
	Sets the mobility for this StandAloneWindowOptionsKit. More...

StandAloneWindowOptionsKit &	SetFullScreen (bool in_state)
	Sets whether the associated stand-alone window should fill the screen. More...

StandAloneWindowOptionsKit &	UnsetDriver ()
	Removes the driver for this StandAloneWindowOptionsKit. More...

StandAloneWindowOptionsKit &	UnsetAntiAliasCapable ()
	Removes the anti-alias options for this StandAloneWindowOptionsKit. More...

StandAloneWindowOptionsKit &	UnsetTitle ()
	Removes the title for this StandAloneWindowOptionsKit. More...

StandAloneWindowOptionsKit &	UnsetSubscreen ()
	Removes the subscreen for this StandAloneWindowOptionsKit. More...

StandAloneWindowOptionsKit &	UnsetMobility ()
	Removes the mobility for this StandAloneWindowOptionsKit. More...

StandAloneWindowOptionsKit &	UnsetFullScreen ()
	Removes whether the associated stand-alone window should fill the screen. More...

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

bool	ShowDriver (Window::Driver &out_driver) const
	Shows the driver for this StandAloneWindowOptionsKit. More...

bool	ShowAntiAliasCapable (bool &out_state, unsigned int &out_samples) const
	Shows the anti-alias options for this StandAloneWindowOptionsKit. More...

bool	ShowTitle (UTF8 &out_window_name) const
	Shows the title for this StandAloneWindowOptionsKit. More...

bool	ShowSubscreen (Rectangle &out_subscreen) const
	Shows the subscreen for this StandAloneWindowOptionsKit. More...

bool	ShowMobility (Window::Mobility &out_mobility) const
	Shows the mobility for this StandAloneWindowOptionsKit. More...

bool	ShowFullScreen (bool &out_state) const
	Shows whether the associated stand-alone window should fill the screen. 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 StandAloneWindowOptionsKit	GetDefault ()
	Creates an StandAloneWindowOptionsKit 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::StandAloneWindowOptionsKit

Detailed Description

The StandAloneWindowOptionsKit class is a user space object. It is used to specify stand-alone-window-specific options Calling HPS::StandAloneWindowOptionsKit::GetDefault() will return an options kit with values found in this table.

Constructor & Destructor Documentation

◆ StandAloneWindowOptionsKit() [1/3]

HPS::StandAloneWindowOptionsKit::StandAloneWindowOptionsKit ( )

The default constructor creates an empty StandAloneWindowOptionsKit object.

◆ StandAloneWindowOptionsKit() [2/3]

HPS::StandAloneWindowOptionsKit::StandAloneWindowOptionsKit ( StandAloneWindowOptionsKit const & in_kit )

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

Parameters

in_kit The source StandAloneWindowOptionsKit to copy.

◆ StandAloneWindowOptionsKit() [3/3]

HPS::StandAloneWindowOptionsKit::StandAloneWindowOptionsKit ( StandAloneWindowOptionsKit && in_that )

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

Parameters

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

◆ ~StandAloneWindowOptionsKit()

virtual HPS::StandAloneWindowOptionsKit::~StandAloneWindowOptionsKit ( )

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

virtual

Indicates whether this StandAloneWindowOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source StandAloneWindowOptionsKit is equivalent to this StandAloneWindowOptionsKit.

Parameters

in_kit The source StandAloneWindowOptionsKit to compare to this StandAloneWindowOptionsKit.

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

static

Creates an StandAloneWindowOptionsKit 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: An StandAloneWindowOptionsKit 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::StandAloneWindowOptionsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

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

Parameters

in_kit The source StandAloneWindowOptionsKit to compare to this StandAloneWindowOptionsKit.

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

◆ operator=() [1/2]

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

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

Parameters

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

Returns: A reference to this StandAloneWindowOptionsKit.

◆ operator=() [2/2]

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

Copies the source StandAloneWindowOptionsKit into this StandAloneWindowOptionsKit.

Parameters

in_kit The source StandAloneWindowOptionsKit to copy.

Returns: A reference to this StandAloneWindowOptionsKit.

◆ operator==()

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

Check if the source StandAloneWindowOptionsKit is equivalent to this StandAloneWindowOptionsKit.

Parameters

in_kit The source StandAloneWindowOptionsKit to compare to this StandAloneWindowOptionsKit.

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

Copies the source StandAloneWindowOptionsKit into this StandAloneWindowOptionsKit.

Parameters

in_kit The source StandAloneWindowOptionsKit to copy.

◆ SetAntiAliasCapable()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::SetAntiAliasCapable	(	bool	in_state,
		unsigned int	in_samples = `4`
	)

Sets the anti-alias options for this StandAloneWindowOptionsKit.

Parameters

in_state	Whether the associated application window should be anti-alias capable.
in_samples	The number of anti-alias samples to use for the associated stand-alone window. Defaults to 4.

Returns: A reference to this StandAloneWindowOptionsKit.

◆ SetDriver()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::SetDriver ( Window::Driver in_driver )

Sets the driver for this StandAloneWindowOptionsKit.

Parameters

in_driver The driver for this StandAloneWindowOptionsKit.

Returns: A reference to this StandAloneWindowOptionsKit.

◆ SetFullScreen()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::SetFullScreen ( bool in_state )

Sets whether the associated stand-alone window should fill the screen.

Parameters

in_state Whether the associated stand-alone window should fill the screen.

Returns: A reference to this StandAloneWindowOptionsKit.

◆ SetMobility()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::SetMobility ( Window::Mobility in_mobility )

Sets the mobility for this StandAloneWindowOptionsKit.

Parameters

in_mobility The mobility for this StandAloneWindowOptionsKit.

Returns: A reference to this StandAloneWindowOptionsKit.

◆ SetSubscreen()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::SetSubscreen ( Rectangle const & in_subscreen )

Sets the subscreen to render into for this StandAloneWindowOptionsKit.

Parameters

in_subscreen The subscreen to render into for this StandAloneWindowOptionsKit. The units of the Rectangle are in window space, so -1.0f corresponds to the left (or bottom) of the window and 1.0f corresponds to the right (or top) of the window.

Returns: A reference to this StandAloneWindowOptionsKit.

◆ SetTitle()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::SetTitle ( char const * in_window_name )

Sets the title for this StandAloneWindowOptionsKit.

Parameters

in_window_name UTF8-encoded title for this StandAloneWindowOptionsKit.

Returns: A reference to this StandAloneWindowOptionsKit.

◆ Show()

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

Copies this StandAloneWindowOptionsKit into the given StandAloneWindowOptionsKit.

Parameters

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

◆ ShowAntiAliasCapable()

bool HPS::StandAloneWindowOptionsKit::ShowAntiAliasCapable	(	bool &	out_state,
		unsigned int &	out_samples
	)		const

Shows the anti-alias options for this StandAloneWindowOptionsKit.

Parameters

out_state	Whether the associated stand-alone window should be anti-alias capable.
out_samples	The number of anti-alias samples to use for the stand-alone application window.

Returns: true if anti-alias options were set, false otherwise.

◆ ShowDriver()

bool HPS::StandAloneWindowOptionsKit::ShowDriver ( Window::Driver & out_driver ) const

Shows the driver for this StandAloneWindowOptionsKit.

Parameters

out_driver The driver for this StandAloneWindowOptionsKit.

Returns: true if a driver was set, false otherwise.

◆ ShowFullScreen()

bool HPS::StandAloneWindowOptionsKit::ShowFullScreen ( bool & out_state ) const

Shows whether the associated stand-alone window should fill the screen.

Parameters

out_state Whether the associated stand-alone window should fill the screen.

Returns: true if a full screen flag was set, false otherwise.

◆ ShowMobility()

bool HPS::StandAloneWindowOptionsKit::ShowMobility ( Window::Mobility & out_mobility ) const

Shows the mobility for this StandAloneWindowOptionsKit.

Parameters

out_mobility The mobility for this StandAloneWindowOptionsKit.

Returns: true if a mobility was set, false otherwise.

◆ ShowSubscreen()

bool HPS::StandAloneWindowOptionsKit::ShowSubscreen ( Rectangle & out_subscreen ) const

Shows the subscreen for this StandAloneWindowOptionsKit.

Parameters

out_subscreen The subscreen for this StandAloneWindowOptionsKit.

Returns: true if a subscreen was set, false otherwise.

◆ ShowTitle()

bool HPS::StandAloneWindowOptionsKit::ShowTitle ( UTF8 & out_window_name ) const

Shows the title for this StandAloneWindowOptionsKit.

Parameters

out_window_name UTF8-encoded title for this StandAloneWindowOptionsKit.

Returns: true if a title was set, 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.

◆ UnsetAntiAliasCapable()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::UnsetAntiAliasCapable ( )

Removes the anti-alias options for this StandAloneWindowOptionsKit.

Returns: A reference to this StandAloneWindowOptionsKit.

◆ UnsetDriver()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::UnsetDriver ( )

Removes the driver for this StandAloneWindowOptionsKit.

Returns: A reference to this StandAloneWindowOptionsKit.

◆ UnsetEverything()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::UnsetEverything ( )

Removes all settings from this StandAloneWindowOptionsKit.

Returns: A reference to this StandAloneWindowOptionsKit.

◆ UnsetFullScreen()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::UnsetFullScreen ( )

Removes whether the associated stand-alone window should fill the screen.

Returns: A reference to this StandAloneWindowOptionsKit.

◆ UnsetMobility()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::UnsetMobility ( )

Removes the mobility for this StandAloneWindowOptionsKit.

Returns: A reference to this StandAloneWindowOptionsKit.

◆ UnsetSubscreen()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::UnsetSubscreen ( )

Removes the subscreen for this StandAloneWindowOptionsKit.

Returns: A reference to this StandAloneWindowOptionsKit.

◆ UnsetTitle()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::UnsetTitle ( )

Removes the title for this StandAloneWindowOptionsKit.

Returns: A reference to this StandAloneWindowOptionsKit.

Member Data Documentation

◆ staticType

const HPS::Type HPS::StandAloneWindowOptionsKit::staticType = HPS::Type::StandAloneWindowOptionsKit

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

◆ StandAloneWindowOptionsKit() [1/3]

◆ StandAloneWindowOptionsKit() [2/3]

◆ StandAloneWindowOptionsKit() [3/3]

◆ ~StandAloneWindowOptionsKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetAntiAliasCapable()

◆ SetDriver()

◆ SetFullScreen()

◆ SetMobility()

◆ SetSubscreen()

◆ SetTitle()

◆ Show()

◆ ShowAntiAliasCapable()

◆ ShowDriver()

◆ ShowFullScreen()

◆ ShowMobility()

◆ ShowSubscreen()

◆ ShowTitle()

◆ Type()

◆ UnsetAntiAliasCapable()

◆ UnsetDriver()

◆ UnsetEverything()

◆ UnsetFullScreen()

◆ UnsetMobility()

◆ UnsetSubscreen()

◆ UnsetTitle()

Member Data Documentation

◆ staticType