HPS.ApplicationWindowOptionsControl Class Reference

The HPS.ApplicationWindowOptionsControl class is a smart pointer that is tied to a database object. It is used to query and manipulate options pertaining to an HPS.ApplicationWindowKey. Default values for the various fields of HPS.ApplicationWindowOptionsControl can be found here. More...

Inheritance diagram for HPS.ApplicationWindowOptionsControl:
HPS.Control HPS.Object

Public Member Functions

 ApplicationWindowOptionsControl (HPS.ApplicationWindowKey in_seg)
 This constructor creates a ApplicationWindowOptionsControl object which is tied to the specified offscreen window. More...
 
 ApplicationWindowOptionsControl (HPS.ApplicationWindowOptionsControl in_that)
 The copy constructor creates a ApplicationWindowOptionsControl object that shares the underlying smart-pointer of the source ApplicationWindowOptionsControl. More...
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
HPS.ApplicationWindowOptionsControl SetFallbackFonts (string[] in_fonts)
 Supplies an array of fonts to be used as fallbacks for when a character can not be found in the active font. More...
 
HPS.ApplicationWindowOptionsControl SetPlatformData (IntPtr in_platform_data)
 Sets the platform specific data for the associated application window. More...
 
HPS.ApplicationWindowOptionsControl SetWindowHandle (IntPtr in_window_handle)
 Sets the window handle for the associated application window. Used to rebind the application window to a new window handle. More...
 
bool ShowAntiAliasCapable (out bool out_state, out uint out_samples)
 Shows the whether this application window is anti-alias capable, and if so, how many samples it uses for anti-aliasing. More...
 
bool ShowDriver (out HPS.Window.Driver out_driver)
 Shows the driver for the associated application window. More...
 
ulong ShowFallbackFonts (out string[] out_fonts)
 Returns an array of fonts set to be used as fallbacks for when a character can not be found in the active font. More...
 
bool ShowFramebufferRetention (out bool out_retain)
 Shows the framebuffer retention setting for the associated application window. More...
 
bool ShowPlatformData (out IntPtr out_platform_data)
 Shows the platform specific data for the associated application window. More...
 
bool ShowWindowHandle (out IntPtr out_window_handle)
 Shows the window handle for the associated application window. More...
 
override HPS.Type Type ()
 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. More...
 
HPS.ApplicationWindowOptionsControl UnsetFallbackFonts ()
 Unsets any fonts currently used as fallback fonts. More...
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
override HPS.Type Type ()
 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. More...
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 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. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Control
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The HPS.ApplicationWindowOptionsControl class is a smart pointer that is tied to a database object. It is used to query and manipulate options pertaining to an HPS.ApplicationWindowKey. Default values for the various fields of HPS.ApplicationWindowOptionsControl can be found here.

Constructor & Destructor Documentation

HPS.ApplicationWindowOptionsControl.ApplicationWindowOptionsControl ( HPS.ApplicationWindowKey  in_seg)
inline

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

HPS.ApplicationWindowOptionsControl.ApplicationWindowOptionsControl ( HPS.ApplicationWindowOptionsControl  in_that)
inline

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

Parameters
in_thatThe source ApplicationWindowOptionsControl to copy.

Member Function Documentation

override HPS.Type HPS.ApplicationWindowOptionsControl.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.Object.

HPS.ApplicationWindowOptionsControl HPS.ApplicationWindowOptionsControl.SetFallbackFonts ( string[]  in_fonts)
inline

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.
HPS.ApplicationWindowOptionsControl HPS.ApplicationWindowOptionsControl.SetPlatformData ( IntPtr  in_platform_data)
inline

Sets the platform specific data for the associated application window.

Parameters
in_platform_dataPlatform specific data for the associated application window.
Returns
A reference to this ApplicationWindowOptionsControl.
HPS.ApplicationWindowOptionsControl HPS.ApplicationWindowOptionsControl.SetWindowHandle ( IntPtr  in_window_handle)
inline

Sets the window handle for the associated application window. Used to rebind the application window to a new window handle.

Parameters
in_window_handleHandle to the new WindowHandle that Visualize will draw into.
Returns
A reference to this ApplicationWindowOptionsControl.
bool HPS.ApplicationWindowOptionsControl.ShowAntiAliasCapable ( out bool  out_state,
out uint  out_samples 
)
inline

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

Parameters
out_stateWhether this application window is anti-alias capable.
out_samplesThe number of anti-alias samples supported by this application window.
Returns
true if any anti-alias options were set, false otherwise.
bool HPS.ApplicationWindowOptionsControl.ShowDriver ( out HPS.Window.Driver  out_driver)
inline

Shows the driver for the associated application window.

Parameters
out_driverThe driver for the associated application window.
Returns
true if a driver was set, false otherwise.
ulong HPS.ApplicationWindowOptionsControl.ShowFallbackFonts ( out string[]  out_fonts)
inline

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.
bool HPS.ApplicationWindowOptionsControl.ShowFramebufferRetention ( out bool  out_retain)
inline

Shows the framebuffer retention setting for the associated application window.

Parameters
out_retainThe framebuffer retention setting for the associated application window.
Returns
true if framebuffer retention option was set, false otherwise.
bool HPS.ApplicationWindowOptionsControl.ShowPlatformData ( out IntPtr  out_platform_data)
inline

Shows the platform specific data for the associated application window.

Parameters
out_platform_dataThe platform specific data for the associated application window.
Returns
true if platform specific data was set, false otherwise.
bool HPS.ApplicationWindowOptionsControl.ShowWindowHandle ( out IntPtr  out_window_handle)
inline

Shows the window handle for the associated application window.

Parameters
out_window_handleThe window handle for the associated application window.
Returns
true if a window handle was set, false otherwise.
override HPS.Type HPS.ApplicationWindowOptionsControl.Type ( )
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.

Returns
The true type of the object in question.

Reimplemented from HPS.Object.

HPS.ApplicationWindowOptionsControl HPS.ApplicationWindowOptionsControl.UnsetFallbackFonts ( )
inline

Unsets any fonts currently used as fallback fonts.


The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.ApplicationWindowOptionsControl.cs