The WindowInfoKit class is a user space object, useful for carrying a group attribute settings. More...

#include <hps.h>

Inheritance diagram for HPS::WindowInfoKit:

Collaboration diagram for HPS::WindowInfoKit:

Public Member Functions
	WindowInfoKit ()
	Initializes an empty kit. More...

	WindowInfoKit (WindowInfoKit const &in_kit)
	Copies the kit in_kit into this kit. More...

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

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

virtual	~WindowInfoKit ()
	Destroy this kit. More...

HPS::Type	ObjectType () const

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

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

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

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

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

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

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

WindowInfoKit &	SetPhysicalPixels (unsigned int in_width, unsigned int in_height)
	Sets the number of pixels in the physical display (monitor, off-screen renderer, printer, etc.). More...

WindowInfoKit &	SetPhysicalSize (float in_width, float in_height)
	Sets the size, in centimeters, of the physical display (monitor, off-screen renderer, printer, etc.). More...

WindowInfoKit &	SetWindowPixels (unsigned int in_width, unsigned int in_height)
	Sets the number of pixels in the window. More...

WindowInfoKit &	SetWindowSize (float in_width, float in_height)
	Sets the size, in centimeters, of the window. More...

WindowInfoKit &	UnsetPhysicalPixels ()
	Unsets the number of pixels in the physical display (monitor, off-screen renderer, printer, etc.). More...

WindowInfoKit &	UnsetPhysicalSize ()
	Unsets the size, in centimeters, of the physical display (monitor, off-screen renderer, printer, etc.). More...

WindowInfoKit &	UnsetWindowPixels ()
	Unsets the number of pixels in the window. More...

WindowInfoKit &	UnsetWindowSize ()
	Unsets the size, in centimeters, of the window. More...

WindowInfoKit &	UnsetEverything ()
	Removes all settings from this object. More...

bool	ShowPhysicalPixels (unsigned int &out_width, unsigned int &out_height) const
	Shows the number of pixels in the physical display (monitor, off-screen renderer, printer, etc.). More...

bool	ShowPhysicalSize (float &out_width, float &out_height) const
	Shows the size, in centimeters, of the physical display (monitor, off-screen renderer, printer, etc.). More...

bool	ShowWindowPixels (unsigned int &out_width, unsigned int &out_height) const
	Shows the number of pixels in the window. More...

bool	ShowWindowSize (float &out_width, float &out_height) const
	Shows the size, in centimeters, of the window. More...

bool	ShowResolution (float &out_horizontal, float &out_vertical) const
	Shows both the horizontal and vertical resolution of the window. More...

bool	ShowWindowAspectRatio (float &out_window_aspect) const
	Shows the aspect ratio of the window. More...

bool	ShowPixelAspectRatio (float &out_pixel_aspect) const
	Shows the aspect ratio of the window's pixels. 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
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::WindowInfoKit

Detailed Description

The WindowInfoKit class is a user space object, useful for carrying a group attribute settings.

Constructor & Destructor Documentation

◆ WindowInfoKit() [1/3]

HPS::WindowInfoKit::WindowInfoKit ( )

Initializes an empty kit.

◆ WindowInfoKit() [2/3]

HPS::WindowInfoKit::WindowInfoKit ( WindowInfoKit const & in_kit )

Copies the kit in_kit into this kit.

◆ WindowInfoKit() [3/3]

HPS::WindowInfoKit::WindowInfoKit ( WindowInfoKit && in_that )

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

Parameters

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

◆ ~WindowInfoKit()

virtual HPS::WindowInfoKit::~WindowInfoKit ( )

virtual

Destroy this kit.

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

virtual

Indicates whether this object has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source WindowInfoKit is equivalent to this object.

Parameters

in_kit The source WindowInfoKit to compare to this object.

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.

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

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

Check if the source WindowInfoKit is not equivalent to this object.

Parameters

in_kit The source WindowInfoKit to compare to this object.

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

◆ operator=() [1/2]

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

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

Parameters

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

Returns: A reference to this WindowInfoKit.

◆ operator=() [2/2]

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

Copies the source WindowInfoKit into this object.

Parameters

in_kit The source WindowInfoKit to copy.

Returns: A reference to this object.

◆ operator==()

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

Check if the source WindowInfoKit is equivalent to this object.

Parameters

in_kit The source WindowInfoKit to compare to this object.

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

Copies the source WindowInfoKit into this object.

Parameters

in_kit The source object to copy.

◆ SetPhysicalPixels()

WindowInfoKit& HPS::WindowInfoKit::SetPhysicalPixels	(	unsigned int	in_width,
		unsigned int	in_height
	)

Sets the number of pixels in the physical display (monitor, off-screen renderer, printer, etc.).

Parameters

in_width	The width of the physical display in pixels.
in_height	The height of the physical display in pixels.

Returns: A reference to this object.

◆ SetPhysicalSize()

WindowInfoKit& HPS::WindowInfoKit::SetPhysicalSize	(	float	in_width,
		float	in_height
	)

Sets the size, in centimeters, of the physical display (monitor, off-screen renderer, printer, etc.).

Parameters

in_width	The width of the physical display in centimeters.
in_height	The height of the physical display in centimeters.

Returns: A reference to this object.

◆ SetWindowPixels()

WindowInfoKit& HPS::WindowInfoKit::SetWindowPixels	(	unsigned int	in_width,
		unsigned int	in_height
	)

Sets the number of pixels in the window.

Parameters

in_width	The width of the window in pixels.
in_height	The height of the window in pixels.

Returns: A reference to this object.

◆ SetWindowSize()

WindowInfoKit& HPS::WindowInfoKit::SetWindowSize	(	float	in_width,
		float	in_height
	)

Sets the size, in centimeters, of the window.

Parameters

in_width	The width of the window in centimeters.
in_height	The height of the window in centimeters.

Returns: A reference to this object.

◆ Show()

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

Copies this object into the given WindowInfoKit.

Parameters

out_kit The WindowInfoKit to populate with the contents of this object.

◆ ShowPhysicalPixels()

bool HPS::WindowInfoKit::ShowPhysicalPixels	(	unsigned int &	out_width,
		unsigned int &	out_height
	)		const

Shows the number of pixels in the physical display (monitor, off-screen renderer, printer, etc.).

Parameters

out_width	The width of the physical display in pixels.
out_height	The height of the physical display in pixels.

Returns: true if the setting is valid, false otherwise.

◆ ShowPhysicalSize()

bool HPS::WindowInfoKit::ShowPhysicalSize	(	float &	out_width,
		float &	out_height
	)		const

Shows the size, in centimeters, of the physical display (monitor, off-screen renderer, printer, etc.).

Parameters

out_width	The width of the physical display in centimeters.
out_height	The height of the physical display in centimeters.

Returns: true if the setting is valid, false otherwise.

◆ ShowPixelAspectRatio()

bool HPS::WindowInfoKit::ShowPixelAspectRatio ( float & out_pixel_aspect ) const

Shows the aspect ratio of the window's pixels.

This is computed as the horizontal resolution divided by the vertical resolution.

Parameters

out_pixel_aspect The aspect ratio of the window defined as width / height in pixels.

Returns: true if the setting is valid, false otherwise.

◆ ShowResolution()

bool HPS::WindowInfoKit::ShowResolution	(	float &	out_horizontal,
		float &	out_vertical
	)		const

Shows both the horizontal and vertical resolution of the window.

Resolution is computed as pixels per centimeter. If the size or the pixels are not set, this function will return false.

Parameters

out_horizontal	The horizontal resolution of the window.
out_vertical	The vertical resolution of the window.

Returns: true if the setting is valid, false otherwise.

◆ ShowWindowAspectRatio()

bool HPS::WindowInfoKit::ShowWindowAspectRatio ( float & out_window_aspect ) const

Shows the aspect ratio of the window.

Aspect ratio is computed as width / height in centimeters.

Parameters

out_window_aspect The aspect ratio of the window defined as width / height in centimeters.

Returns: true if the setting is valid, false otherwise.

◆ ShowWindowPixels()

bool HPS::WindowInfoKit::ShowWindowPixels	(	unsigned int &	out_width,
		unsigned int &	out_height
	)		const

Shows the number of pixels in the window.

Parameters

out_width	The width of the window in pixels.
out_height	The height of the window in pixels.

Returns: true if the setting is valid, false otherwise.

◆ ShowWindowSize()

bool HPS::WindowInfoKit::ShowWindowSize	(	float &	out_width,
		float &	out_height
	)		const

Shows the size, in centimeters, of the window.

Parameters

out_width	The width of the window in centimeters.
out_height	The height of the window in centimeters.

Returns: true if the setting 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()

WindowInfoKit& HPS::WindowInfoKit::UnsetEverything ( )

Removes all settings from this object.

Returns: A reference to this object.

◆ UnsetPhysicalPixels()

WindowInfoKit& HPS::WindowInfoKit::UnsetPhysicalPixels ( )

Unsets the number of pixels in the physical display (monitor, off-screen renderer, printer, etc.).

Returns: A reference to this object.

◆ UnsetPhysicalSize()

WindowInfoKit& HPS::WindowInfoKit::UnsetPhysicalSize ( )

Unsets the size, in centimeters, of the physical display (monitor, off-screen renderer, printer, etc.).

Returns: A reference to this object.

◆ UnsetWindowPixels()

WindowInfoKit& HPS::WindowInfoKit::UnsetWindowPixels ( )

Unsets the number of pixels in the window.

Returns: A reference to this object.

◆ UnsetWindowSize()

WindowInfoKit& HPS::WindowInfoKit::UnsetWindowSize ( )

Unsets the size, in centimeters, of the window.

Returns: A reference to this object.

Member Data Documentation

◆ staticType

const HPS::Type HPS::WindowInfoKit::staticType = HPS::Type::WindowInfoKit

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

◆ WindowInfoKit() [1/3]

◆ WindowInfoKit() [2/3]

◆ WindowInfoKit() [3/3]

◆ ~WindowInfoKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetPhysicalPixels()

◆ SetPhysicalSize()

◆ SetWindowPixels()

◆ SetWindowSize()

◆ Show()

◆ ShowPhysicalPixels()

◆ ShowPhysicalSize()

◆ ShowPixelAspectRatio()

◆ ShowResolution()

◆ ShowWindowAspectRatio()

◆ ShowWindowPixels()

◆ ShowWindowSize()

◆ Type()

◆ UnsetEverything()

◆ UnsetPhysicalPixels()

◆ UnsetPhysicalSize()

◆ UnsetWindowPixels()

◆ UnsetWindowSize()

Member Data Documentation

◆ staticType