#include <hps.h>

Inheritance diagram for HPS::ApplicationWindowOptionsKit:

Collaboration diagram for HPS::ApplicationWindowOptionsKit:

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

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

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

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

virtual	~ApplicationWindowOptionsKit ()

HPS::Type	ObjectType () const

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

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

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

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

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

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

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

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

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

ApplicationWindowOptionsKit &	SetPlatformData (PlatformData in_platform_data)
	Sets the platform specific data for this ApplicationWindowOptionsKit. More...

ApplicationWindowOptionsKit &	SetFramebufferRetention (bool in_retain)
	Sets the framebuffer retention option for this ApplicationWindowOptionsKit. More...

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

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

ApplicationWindowOptionsKit &	UnsetPlatformData ()
	Removes the platform specific data for this ApplicationWindowOptionsKit. More...

ApplicationWindowOptionsKit &	UnsetFramebufferRetention ()
	Removes the framebuffer retention setting for this ApplicationWindowOptionsKit. More...

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

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

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

bool	ShowPlatformData (PlatformData &out_platform_data) const
	Shows the platform specific data for this ApplicationWindowOptionsKit. More...

bool	ShowFramebufferRetention (bool &out_retain) const
	Shows the framebuffer retention setting for this ApplicationWindowOptionsKit. 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 ApplicationWindowOptionsKit	GetDefault ()
	Creates an ApplicationWindowOptionsKit 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::ApplicationWindowOptionsKit

Detailed Description

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

Constructor & Destructor Documentation

◆ ApplicationWindowOptionsKit() [1/3]

HPS::ApplicationWindowOptionsKit::ApplicationWindowOptionsKit ( )

The default constructor creates an empty ApplicationWindowOptionsKit object.

◆ ApplicationWindowOptionsKit() [2/3]

HPS::ApplicationWindowOptionsKit::ApplicationWindowOptionsKit ( ApplicationWindowOptionsKit const & in_kit )

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

Parameters

in_kit The source ApplicationWindowOptionsKit to copy.

◆ ApplicationWindowOptionsKit() [3/3]

HPS::ApplicationWindowOptionsKit::ApplicationWindowOptionsKit ( ApplicationWindowOptionsKit && in_that )

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

Parameters

in_that An rvalue reference to an ApplicationWindowOptionsKit to take the impl from.

◆ ~ApplicationWindowOptionsKit()

virtual HPS::ApplicationWindowOptionsKit::~ApplicationWindowOptionsKit ( )

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

virtual

Indicates whether this ApplicationWindowOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source ApplicationWindowOptionsKit is equivalent to this ApplicationWindowOptionsKit.

Parameters

in_kit The source ApplicationWindowOptionsKit to compare to this ApplicationWindowOptionsKit.

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

static

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

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

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

Parameters

in_kit The source ApplicationWindowOptionsKit to compare to this ApplicationWindowOptionsKit.

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

◆ operator=() [1/2]

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

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

Parameters

in_that An rvalue reference to an ApplicationWindowOptionsKit to take the impl from.

Returns: A reference to this ApplicationWindowOptionsKit.

◆ operator=() [2/2]

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

Copies the source ApplicationWindowOptionsKit into this ApplicationWindowOptionsKit.

Parameters

in_kit The source ApplicationWindowOptionsKit to copy.

Returns: A reference to this ApplicationWindowOptionsKit.

◆ operator==()

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

Check if the source ApplicationWindowOptionsKit is equivalent to this ApplicationWindowOptionsKit.

Parameters

in_kit The source ApplicationWindowOptionsKit to compare to this ApplicationWindowOptionsKit.

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

Copies the source ApplicationWindowOptionsKit into this ApplicationWindowOptionsKit.

Parameters

in_kit The source ApplicationWindowOptionsKit to copy.

◆ SetAntiAliasCapable()

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

Sets the anti-alias options for this ApplicationWindowOptionsKit.

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 application window. Defaults to 4.

Returns: A reference to this ApplicationWindowOptionsKit.

◆ SetDriver()

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

Sets the driver for this ApplicationWindowOptionsKit.

Parameters

in_driver The driver for this ApplicationWindowOptionsKit.

Returns: A reference to this ApplicationWindowOptionsKit.

◆ SetFramebufferRetention()

ApplicationWindowOptionsKit& HPS::ApplicationWindowOptionsKit::SetFramebufferRetention ( bool in_retain )

Sets the framebuffer retention option for this ApplicationWindowOptionsKit.

Parameters

in_retain Whether the associated application window retains the image from the previous frame.

Returns: A reference to this ApplicationWindowOptionsKit.

◆ SetPlatformData()

ApplicationWindowOptionsKit& HPS::ApplicationWindowOptionsKit::SetPlatformData ( PlatformData in_platform_data )

Sets the platform specific data for this ApplicationWindowOptionsKit.

Parameters

in_platform_data Platform specific data for this ApplicationWindowOptionsKit.

Returns: A reference to this ApplicationWindowOptionsKit.

◆ Show()

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

Copies this ApplicationWindowOptionsKit into the given ApplicationWindowOptionsKit.

Parameters

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

◆ ShowAntiAliasCapable()

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

Shows the anti-alias options for this ApplicationWindowOptionsKit.

Parameters

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

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

◆ ShowDriver()

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

Shows the driver for this ApplicationWindowOptionsKit.

Parameters

out_driver The driver for this ApplicationWindowOptionsKit.

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

◆ ShowFramebufferRetention()

bool HPS::ApplicationWindowOptionsKit::ShowFramebufferRetention ( bool & out_retain ) const

Shows the framebuffer retention setting for this ApplicationWindowOptionsKit.

Parameters

out_retain The framebuffer retention setting for this ApplicationWindowOptionsKit.

Returns: true if platform specific data was set, false otherwise.

◆ ShowPlatformData()

bool HPS::ApplicationWindowOptionsKit::ShowPlatformData ( PlatformData & out_platform_data ) const

Shows the platform specific data for this ApplicationWindowOptionsKit.

Parameters

out_platform_data The platform specific data for this ApplicationWindowOptionsKit.

Returns: true if platform specific data 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()

ApplicationWindowOptionsKit& HPS::ApplicationWindowOptionsKit::UnsetAntiAliasCapable ( )

Removes the anti-alias options for this ApplicationWindowOptionsKit.

Returns: A reference to this ApplicationWindowOptionsKit.

◆ UnsetDriver()

ApplicationWindowOptionsKit& HPS::ApplicationWindowOptionsKit::UnsetDriver ( )

Removes the driver for this ApplicationWindowOptionsKit.

Returns: A reference to this ApplicationWindowOptionsKit.

◆ UnsetEverything()

ApplicationWindowOptionsKit& HPS::ApplicationWindowOptionsKit::UnsetEverything ( )

Removes all settings from this ApplicationWindowOptionsKit.

Returns: A reference to this ApplicationWindowOptionsKit.

◆ UnsetFramebufferRetention()

ApplicationWindowOptionsKit& HPS::ApplicationWindowOptionsKit::UnsetFramebufferRetention ( )

Removes the framebuffer retention setting for this ApplicationWindowOptionsKit.

Returns: A reference to this ApplicationWindowOptionsKit.

◆ UnsetPlatformData()

ApplicationWindowOptionsKit& HPS::ApplicationWindowOptionsKit::UnsetPlatformData ( )

Removes the platform specific data for this ApplicationWindowOptionsKit.

Returns: A reference to this ApplicationWindowOptionsKit.

Member Data Documentation

◆ staticType

const HPS::Type HPS::ApplicationWindowOptionsKit::staticType = HPS::Type::ApplicationWindowOptionsKit

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

◆ ApplicationWindowOptionsKit() [1/3]

◆ ApplicationWindowOptionsKit() [2/3]

◆ ApplicationWindowOptionsKit() [3/3]

◆ ~ApplicationWindowOptionsKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetAntiAliasCapable()

◆ SetDriver()

◆ SetFramebufferRetention()

◆ SetPlatformData()

◆ Show()

◆ ShowAntiAliasCapable()

◆ ShowDriver()

◆ ShowFramebufferRetention()

◆ ShowPlatformData()

◆ Type()

◆ UnsetAntiAliasCapable()

◆ UnsetDriver()

◆ UnsetEverything()

◆ UnsetFramebufferRetention()

◆ UnsetPlatformData()

Member Data Documentation

◆ staticType