HPS::StandAloneWindowOptionsControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::StandAloneWindowOptionsControl:
HPS::Control HPS::Object

Public Member Functions

HPS::Type ObjectType () const
 
StandAloneWindowOptionsControloperator= (StandAloneWindowOptionsControl &&in_that)
 
StandAloneWindowOptionsControloperator= (StandAloneWindowOptionsControl const &in_that)
 
StandAloneWindowOptionsControlSetAntiAliasCapable (bool in_state, unsigned int in_samples=4)
 
StandAloneWindowOptionsControlSetFallbackFonts (UTF8Array const &in_fonts)
 
StandAloneWindowOptionsControlSetFullScreen (bool in_state)
 
StandAloneWindowOptionsControlSetMobility (Window::Mobility in_mobility)
 
StandAloneWindowOptionsControlSetScreenAntiAliasing (bool in_state)
 
StandAloneWindowOptionsControlSetSubscreen (Rectangle const &in_subscreen)
 
bool ShowAntiAliasCapable (bool &out_state, unsigned int &out_samples) const
 
bool ShowDriver (Window::Driver &out_driver) const
 
size_t ShowFallbackFonts (UTF8Array &out_fonts) const
 
bool ShowFullScreen (bool &out_state) const
 
bool ShowMobility (Window::Mobility &out_mobility) const
 
bool ShowSubscreen (Rectangle &out_subscreen) const
 
bool ShowTitle (UTF8 &out_window_name) const
 
bool ShowWindowHandle (WindowHandle &out_window_handle) const
 
 StandAloneWindowOptionsControl (StandAloneWindowKey &in_seg)
 
 StandAloneWindowOptionsControl (StandAloneWindowOptionsControl const &in_that)
 
 StandAloneWindowOptionsControl (StandAloneWindowOptionsControl &&in_that)
 
virtual HPS::Type Type () const
 
StandAloneWindowOptionsControlUnsetFallbackFonts ()
 
 ~StandAloneWindowOptionsControl ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::StandAloneWindowOptionsControl
 
- Static Public Attributes inherited from HPS::Control
static const HPS::Type staticType = HPS::Type::Control
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Control
 Control (Control &&in_that)
 
Controloperator= (Control &&in_that)
 

Detailed Description

The HPS::StandAloneWindowOptionsControl class is a smart pointer that is tied to a database object. It is used to set and query stand-alone-window-specific options on a HPS::StandAloneWindowKey.

Default values for the various fields of HPS::StandAloneWindowOptionsControl can be found here.

Standalone windows are not supported on Android, iOS, or macOS as all GUI / windowing is controlled at the application level.

Constructor & Destructor Documentation

◆ StandAloneWindowOptionsControl() [1/3]

HPS::StandAloneWindowOptionsControl::StandAloneWindowOptionsControl ( StandAloneWindowKey in_seg)
explicit

This constructor creates a StandAloneWindowOptionsControl object which is tied to the specified offscreen window.

Parameters
in_windowThe application window which this StandAloneWindowOptionsControl should operate on.

◆ StandAloneWindowOptionsControl() [2/3]

HPS::StandAloneWindowOptionsControl::StandAloneWindowOptionsControl ( StandAloneWindowOptionsControl const &  in_that)

The copy constructor creates a StandAloneWindowOptionsControl object that shares the underlying smart-pointer of the source StandAloneWindowOptionsControl.

Parameters
in_thatThe source StandAloneWindowOptionsControl to copy.

◆ StandAloneWindowOptionsControl() [3/3]

HPS::StandAloneWindowOptionsControl::StandAloneWindowOptionsControl ( StandAloneWindowOptionsControl &&  in_that)

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

Parameters
in_thatAn rvalue reference to a StandAloneWindowOptionsControl to take the impl from.

◆ ~StandAloneWindowOptionsControl()

HPS::StandAloneWindowOptionsControl::~StandAloneWindowOptionsControl ( )

Releases a reference to the database object this control is tied to.

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::StandAloneWindowOptionsControl::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS::Control.

◆ operator=() [1/2]

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

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

Parameters
in_thatAn rvalue reference to an StandAloneWindowOptionsControl to take the impl from.
Returns
A reference to this StandAloneWindowOptionsControl.

◆ operator=() [2/2]

StandAloneWindowOptionsControl& HPS::StandAloneWindowOptionsControl::operator= ( StandAloneWindowOptionsControl const &  in_that)

Share the underlying smart-pointer of the StandAloneWindowOptionsControl source.

Parameters
in_thatThe StandAloneWindowOptionsControl source of the assignment.
Returns
A reference to this StandAloneWindowOptionsControl.

◆ SetAntiAliasCapable()

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

Sets the anti-alias options for this StandAloneWindowOptionsControl.

Parameters
in_stateWhether the associated stand-alone window should be anti-alias capable.
in_samplesThe number of anti-alias samples to use for the associated stand-alone window. Defaults to 4.
Returns
A reference to this StandAloneWindowOptionsControl.

◆ SetFallbackFonts()

StandAloneWindowOptionsControl& HPS::StandAloneWindowOptionsControl::SetFallbackFonts ( UTF8Array const &  in_fonts)

Supplies an array of fonts to be used as fallbacks for when a character can not be found in the active font.

Parameters
in_fontsAn array of UTF8 encoded strings that correspond to the fallback fonts being used.

◆ SetFullScreen()

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

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

Parameters
in_stateWhether this stand-alone window should fill the screen.
Returns
A reference to this StandAloneWindowOptionsControl.

◆ SetMobility()

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

Sets the mobility for this stand-alone window. Mobility refers to the resizing and positioning behaviors of a window.

Parameters
in_mobilityThe mobility for this stand-alone window.
Returns
A reference to this StandAloneWindowOptionsControl.

◆ SetScreenAntiAliasing()

StandAloneWindowOptionsControl& HPS::StandAloneWindowOptionsControl::SetScreenAntiAliasing ( bool  in_state)

Manipulates the state of screen anti-aliasing.

Parameters
in_stateWhether screen anti-aliasing should be used.
Returns
A reference to this object.

◆ SetSubscreen()

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

Sets the subscreen to render into for this stand-alone window.

Parameters
in_subscreenThe subscreen to render into for this stand-alone window. 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 StandAloneWindowOptionsControl.

◆ ShowAntiAliasCapable()

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

Shows the whether this stand-alone window is anti-alias capable, and if so, how many samples it uses for anti-aliasing.

Parameters
out_stateWhether this stand-alone window is anti-alias capable.
out_samplesThe number of anti-alias samples supported by this stand-alone window.
Returns
true if any anti-alias options were set, false otherwise.

◆ ShowDriver()

bool HPS::StandAloneWindowOptionsControl::ShowDriver ( Window::Driver out_driver) const

Shows the driver for this stand-alone window.

Parameters
out_driverThe driver for this stand-alone window.
Returns
true if a driver was set, false otherwise.

◆ ShowFallbackFonts()

size_t HPS::StandAloneWindowOptionsControl::ShowFallbackFonts ( UTF8Array out_fonts) const

Returns an array of fonts set to be used as fallbacks for when a character can not be found in the active font.

Parameters
out_fontsAn array of UTF8 encoded strings that correspond to the fallback fonts being used.

◆ ShowFullScreen()

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

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

Parameters
out_stateWhether this stand-alone window should fill the screen.
Returns
true if a full screen flag was set, false otherwise.

◆ ShowMobility()

bool HPS::StandAloneWindowOptionsControl::ShowMobility ( Window::Mobility out_mobility) const

Shows the mobility for this stand-alone window.

Parameters
out_mobilityThe mobility for this stand-alone window.
Returns
true if a mobility was set, false otherwise.

◆ ShowSubscreen()

bool HPS::StandAloneWindowOptionsControl::ShowSubscreen ( Rectangle out_subscreen) const

Shows the subscreen for this stand-alone window.

Parameters
out_subscreenThe subscreen for this stand-alone window.
Returns
true if a subscreen was set, false otherwise.

◆ ShowTitle()

bool HPS::StandAloneWindowOptionsControl::ShowTitle ( UTF8 out_window_name) const

Shows the title for this stand-alone window.

Parameters
out_window_nameUTF8-encoded title for this stand-alone window.
Returns
true if a title was set, false otherwise.

◆ ShowWindowHandle()

bool HPS::StandAloneWindowOptionsControl::ShowWindowHandle ( WindowHandle &  out_window_handle) const

Shows the window handle for the associated standalone window.

Parameters
out_window_handleThe window handle for the associated standalone window.
Returns
true if a window handle is available, false otherwise.

◆ Type()

virtual HPS::Type HPS::StandAloneWindowOptionsControl::Type ( ) const
inlinevirtual

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.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS::Control.

◆ UnsetFallbackFonts()

StandAloneWindowOptionsControl& HPS::StandAloneWindowOptionsControl::UnsetFallbackFonts ( )

Unsets any fonts currently used as fallback fonts.


The documentation for this class was generated from the following file: