
Public Member Functions | |
override void | Dispose () |
override HPS.Type | ObjectType () |
HPS.UpdateOptionsControl | SetTimeLimit (double in_time_limit) |
HPS.UpdateOptionsControl | SetUpdateType (HPS.Window.UpdateType in_type) |
bool | ShowTimeLimit (out double out_time_limit) |
bool | ShowUpdateType (out HPS.Window.UpdateType out_type) |
override HPS.Type | Type () |
HPS.UpdateOptionsControl | UnsetEverything () |
HPS.UpdateOptionsControl | UnsetTimeLimit () |
HPS.UpdateOptionsControl | UnsetUpdateType () |
UpdateOptionsControl (HPS.WindowKey in_window) | |
UpdateOptionsControl (HPS.UpdateOptionsControl in_that) | |
![]() | |
Control (HPS.Control in_that) | |
![]() | |
virtual bool | Empty () |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
bool | HasType (HPS.Type in_mask) |
Object (HPS.Object that) | |
virtual void | Reset () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
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
◆ UpdateOptionsControl() [1/2]
|
inline |
This constructor creates a UpdateOptionsControl object which is tied to the specified window.
- Parameters
-
in_window The window which this UpdateOptionsControl should operate on.
◆ UpdateOptionsControl() [2/2]
|
inline |
The copy constructor creates a UpdateOptionsControl object that shares the underlying smart-pointer of the source UpdateOptionsControl.
- Parameters
-
in_that The source UpdateOptionsControl to copy.
Member Function Documentation
◆ ObjectType()
|
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.
◆ SetTimeLimit()
|
inline |
Sets the time limit of this UpdateOptionsControl.
- Parameters
-
in_time_limit The time limit for this UpdateOptionsControl update.
- Returns
- A reference to this UpdateOptionsControl.
◆ SetUpdateType()
|
inline |
Sets the type of update of this UpdateOptionsControl.
- Parameters
-
in_type The type of update that this UpdateOptionsControl will perform.
- Returns
- A reference to this UpdateOptionsControl.
◆ ShowTimeLimit()
|
inline |
Shows the time limit from this UpdateOptionsControl.
- Returns
- true if the time limit is valid, false otherwise.
◆ ShowUpdateType()
|
inline |
Shows the type of control from this UpdateOptionsControl.
- Parameters
-
out_type The type of update.
- Returns
- true if the type is valid, false otherwise.
◆ 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.Control.
◆ UnsetEverything()
|
inline |
Removes all settings from this UpdateOptionsControl. If the control is attached to a WindowKey this function restores the default settings of this control as specified by UpdateOptionsKit.GetDefault().
- Returns
- A reference to this UpdateOptionsControl.
◆ UnsetTimeLimit()
|
inline |
Removes the time limit of this UpdateOptionsControl. If the control is attached to a WindowKey this function restores the default value of this setting as specified by UpdateOptionsKit.GetDefault().
- Returns
- A reference to this UpdateOptionsControl.
◆ UnsetUpdateType()
|
inline |
Removes the type of control for this update Control. If the control is attached to a WindowKey this function restores the default value of this setting as specified by UpdateOptionsKit.GetDefault().
- Returns
- A reference to this UpdateOptionsControl.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.UpdateOptionsControl.cs