The HPS::UpdateOptionsKit class is a user space object. It contains options related to selection. Calling HPS::UpdateOptionsKit::GetDefault() will return a kit with values found in this table. More...
Public Member Functions | |
override void | Dispose () |
UpdateOptionsKit () | |
The default constructor creates an empty UpdateOptionsKit object. More... | |
UpdateOptionsKit (HPS.UpdateOptionsKit in_kit) | |
The copy constructor creates a new UpdateOptionsKit object that contains the same settings as the source UpdateOptionsKit. 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... | |
void | Set (HPS.UpdateOptionsKit in_kit) |
Copies the source UpdateOptionsKit into this UpdateOptionsKit. More... | |
void | Show (out HPS.UpdateOptionsKit out_kit) |
Copies this UpdateOptionsKit into the given UpdateOptionsKit. More... | |
override bool | Empty () |
Indicates whether this UpdateOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.UpdateOptionsKit in_kit) |
Check if the source UpdateOptionsKit is equivalent to this UpdateOptionsKit. More... | |
HPS.UpdateOptionsKit | SetUpdateControl (HPS.Window.UpdateControl in_control) |
Sets the type of update of this UpdateOptionsKit. More... | |
HPS.UpdateOptionsKit | SetTimeLimit (double in_time_limit) |
Sets the time limit of this UpdateOptionsKit. More... | |
HPS.UpdateOptionsKit | UnsetUpdateControl () |
Removes the type of control for this UpdateOptionsKit. More... | |
HPS.UpdateOptionsKit | UnsetTimeLimit () |
Removes the time limit of this UpdateOptionsKit. More... | |
HPS.UpdateOptionsKit | UnsetEverything () |
Removes all settings from this UpdateOptionsKit. More... | |
bool | ShowUpdateControl (out HPS.Window.UpdateControl out_control) |
Shows the type of control from this UpdateOptionsKit. More... | |
bool | ShowTimeLimit (out double out_time_limit) |
Shows the time limit from this UpdateOptionsKit. More... | |
![]() | |
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 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... | |
Static Public Member Functions | |
static HPS.UpdateOptionsKit | GetDefault () |
Creates a UpdateOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default. More... | |
static bool | operator== (HPS.UpdateOptionsKit a, HPS.UpdateOptionsKit b) |
static bool | operator!= (HPS.UpdateOptionsKit a, HPS.UpdateOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
The HPS::UpdateOptionsKit class is a user space object. It contains options related to selection. Calling HPS::UpdateOptionsKit::GetDefault() will return a kit with values found in this table.
|
inline |
The default constructor creates an empty UpdateOptionsKit object.
|
inline |
The copy constructor creates a new UpdateOptionsKit object that contains the same settings as the source UpdateOptionsKit.
in_kit | The source UpdateOptionsKit to copy. |
|
inlinevirtual |
Indicates whether this UpdateOptionsKit has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source UpdateOptionsKit is equivalent to this UpdateOptionsKit.
in_kit | The source UpdateOptionsKit to compare to this UpdateOptionsKit. |
|
inlinestatic |
Creates a UpdateOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
|
inline |
Copies the source UpdateOptionsKit into this UpdateOptionsKit.
in_kit | The source UpdateOptionsKit to copy. |
|
inline |
Sets the time limit of this UpdateOptionsKit.
in_time_limit | The time limit for this UpdateOptionsKit update. |
|
inline |
Sets the type of update of this UpdateOptionsKit.
in_control | The type of update that this UpdateOptionsKit will perform. |
|
inline |
Copies this UpdateOptionsKit into the given UpdateOptionsKit.
out_kit | The UpdateOptionsKit to populate with the contents of this UpdateOptionsKit. |
|
inline |
Shows the time limit from this UpdateOptionsKit.
|
inline |
Shows the type of control from this UpdateOptionsKit.
|
inline |
Removes all settings from this UpdateOptionsKit.
|
inline |
Removes the time limit of this UpdateOptionsKit.
|
inline |
Removes the type of control for this UpdateOptionsKit.