Public Member Functions | Protected Member Functions | List of all members
HPS.UpdateOptionsControl Class Reference

The HPS::UpdateOptionsControl class is a smart pointer that is tied to a database object. It is used to set selection related options on a HPS::WindowKey. Options include the selection algorithm, granularity, internal limit, related limit, level, proximity, and sorting. Default values for the various fields of HPS::UpdateOptionsControl can be found here. More...

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

Public Member Functions

override void Dispose ()
 
 UpdateOptionsControl (HPS.WindowKey in_window)
 This constructor creates a UpdateOptionsControl object which is tied to the specified window. More...
 
 UpdateOptionsControl (HPS.UpdateOptionsControl in_that)
 The copy constructor creates a UpdateOptionsControl object that shares the underlying smart-pointer of the source UpdateOptionsControl. More...
 
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.UpdateOptionsControl SetUpdateControl (HPS.Window.UpdateControl in_control)
 Sets the type of update of this UpdateOptionsControl. More...
 
HPS.UpdateOptionsControl SetTimeLimit (double in_time_limit)
 Sets the time limit of this UpdateOptionsControl. More...
 
HPS.UpdateOptionsControl UnsetUpdateControl ()
 Removes the type of control for this update Control. More...
 
HPS.UpdateOptionsControl UnsetTimeLimit ()
 Removes the time limit of this UpdateOptionsControl. More...
 
HPS.UpdateOptionsControl UnsetEverything ()
 Removes all settings from this UpdateOptionsControl. More...
 
bool ShowUpdateControl (out HPS.Window.UpdateControl out_control)
 Shows the type of control from this UpdateOptionsControl. More...
 
bool ShowTimeLimit (out double out_time_limit)
 Shows the time limit from this UpdateOptionsControl. More...
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object that)
 
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...
 
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
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...
 

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
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

Detailed Description

The HPS::UpdateOptionsControl class is a smart pointer that is tied to a database object. It is used to set selection related options on a HPS::WindowKey. Options include the selection algorithm, granularity, internal limit, related limit, level, proximity, and sorting. Default values for the various fields of HPS::UpdateOptionsControl can be found here.

Constructor & Destructor Documentation

HPS.UpdateOptionsControl.UpdateOptionsControl ( HPS.WindowKey  in_window)
inline

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

Parameters
in_windowThe window which this UpdateOptionsControl should operate on.
HPS.UpdateOptionsControl.UpdateOptionsControl ( HPS.UpdateOptionsControl  in_that)
inline

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

Parameters
in_thatThe source UpdateOptionsControl to copy.

Member Function Documentation

override HPS.Type HPS.UpdateOptionsControl.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.UpdateOptionsControl HPS.UpdateOptionsControl.SetTimeLimit ( double  in_time_limit)
inline

Sets the time limit of this UpdateOptionsControl.

Parameters
in_time_limitThe time limit for this UpdateOptionsControl update.
Returns
A reference to this UpdateOptionsControl.
HPS.UpdateOptionsControl HPS.UpdateOptionsControl.SetUpdateControl ( HPS.Window.UpdateControl  in_control)
inline

Sets the type of update of this UpdateOptionsControl.

Parameters
in_controlThe type of update that this UpdateOptionsControl will perform.
Returns
A reference to this UpdateOptionsControl.
bool HPS.UpdateOptionsControl.ShowTimeLimit ( out double  out_time_limit)
inline

Shows the time limit from this UpdateOptionsControl.

Returns
true if the time limit is valid, false otherwise.
bool HPS.UpdateOptionsControl.ShowUpdateControl ( out HPS.Window.UpdateControl  out_control)
inline

Shows the type of control from this UpdateOptionsControl.

Returns
true if the control is valid, false otherwise.
HPS.UpdateOptionsControl HPS.UpdateOptionsControl.UnsetEverything ( )
inline

Removes all settings from this UpdateOptionsControl.

Returns
A reference to this UpdateOptionsControl.
HPS.UpdateOptionsControl HPS.UpdateOptionsControl.UnsetTimeLimit ( )
inline

Removes the time limit of this UpdateOptionsControl.

Returns
A reference to this UpdateOptionsControl.
HPS.UpdateOptionsControl HPS.UpdateOptionsControl.UnsetUpdateControl ( )
inline

Removes the type of control for this update Control.

Returns
A reference to this UpdateOptionsControl.

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