< Home

< Table of Contents

REFERENCE MANUAL

HPS.StandAloneWindowOptionsControl Class Reference

The StandAloneWindowOptionsControl class is a smart pointer that is tied to a database object. More...

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

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
HPS.StandAloneWindowOptionsControl SetFullScreen (bool in_state)
 Sets whether this stand-alone window should fill the screen. More...
 
HPS.StandAloneWindowOptionsControl SetMobility (HPS.Window.Mobility in_mobility)
 Sets the mobility for this stand-alone window. More...
 
HPS.StandAloneWindowOptionsControl SetSubscreen (HPS.Rectangle in_subscreen)
 Sets the subscreen to render into for this stand-alone window. More...
 
bool ShowAntiAliasCapable (out bool out_state, out uint out_samples)
 Shows the whether this stand-alone 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 this stand-alone window. More...
 
bool ShowFullScreen (out bool out_state)
 Shows whether this stand-alone window should fill the screen. More...
 
bool ShowMobility (out HPS.Window.Mobility out_mobility)
 Shows the mobility for this stand-alone window. More...
 
bool ShowSubscreen (out HPS.Rectangle out_subscreen)
 Shows the subscreen for this stand-alone window. More...
 
bool ShowTitle (out string out_window_name)
 Shows the title for this stand-alone window. More...
 
 StandAloneWindowOptionsControl (HPS.StandAloneWindowKey in_seg)
 This constructor creates a StandAloneWindowOptionsControl object which is tied to the specified offscreen window. More...
 
 StandAloneWindowOptionsControl (HPS.StandAloneWindowOptionsControl in_that)
 The copy constructor creates a StandAloneWindowOptionsControl object that shares the underlying smart-pointer of the source StandAloneWindowOptionsControl. More...
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- 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. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Protected Member Functions

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
 
HandleRef scptr
 

Detailed Description

The 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 StandAloneWindowKey. Default values for the various fields of StandAloneWindowOptionsControl can be found here.

Constructor & Destructor Documentation

HPS.StandAloneWindowOptionsControl.StandAloneWindowOptionsControl ( HPS.StandAloneWindowKey  in_seg)

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

HPS.StandAloneWindowOptionsControl.StandAloneWindowOptionsControl ( HPS.StandAloneWindowOptionsControl  in_that)

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

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_stand_alone_window_options_control" kindref="compound">StandAloneWindowOptionsControl</ref> to copy.

Member Function Documentation

override HPS.Type HPS.StandAloneWindowOptionsControl.ObjectType ( )
virtual

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.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.
HPS.StandAloneWindowOptionsControl HPS.StandAloneWindowOptionsControl.SetMobility ( HPS.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.
HPS.StandAloneWindowOptionsControl HPS.StandAloneWindowOptionsControl.SetSubscreen ( HPS.Rectangle  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 <ref refid="struct_h_p_s_1_1_rectangle" kindref="compound">Rectangle</ref> 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.
bool HPS.StandAloneWindowOptionsControl.ShowAntiAliasCapable ( out bool  out_state,
out uint  out_samples 
)

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.
bool HPS.StandAloneWindowOptionsControl.ShowDriver ( out HPS.Window.Driver  out_driver)

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.
bool HPS.StandAloneWindowOptionsControl.ShowFullScreen ( out bool  out_state)

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.
bool HPS.StandAloneWindowOptionsControl.ShowMobility ( out HPS.Window.Mobility  out_mobility)

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.
bool HPS.StandAloneWindowOptionsControl.ShowSubscreen ( out HPS.Rectangle  out_subscreen)

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.
bool HPS.StandAloneWindowOptionsControl.ShowTitle ( out string  out_window_name)

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.

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