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...

Inheritance diagram for HPS.UpdateOptionsKit:
HPS.Kit HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this UpdateOptionsKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.UpdateOptionsKit in_kit)
 Check if the source UpdateOptionsKit is equivalent to this UpdateOptionsKit. More...
 
override int GetHashCode ()
 
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...
 
HPS.UpdateOptionsKit SetTimeLimit (double in_time_limit)
 Sets the time limit of this UpdateOptionsKit. More...
 
HPS.UpdateOptionsKit SetUpdateType (HPS.Window.UpdateType in_type)
 Sets the type of update of this UpdateOptionsKit. More...
 
void Show (out HPS.UpdateOptionsKit out_kit)
 Copies this UpdateOptionsKit into the given UpdateOptionsKit. More...
 
bool ShowTimeLimit (out double out_time_limit)
 Shows the time limit from this UpdateOptionsKit. More...
 
bool ShowUpdateType (out HPS.Window.UpdateType out_type)
 Shows the type of control from this UpdateOptionsKit. More...
 
HPS.UpdateOptionsKit UnsetEverything ()
 Removes all settings from this UpdateOptionsKit. More...
 
HPS.UpdateOptionsKit UnsetTimeLimit ()
 Removes the time limit of this UpdateOptionsKit. More...
 
HPS.UpdateOptionsKit UnsetUpdateType ()
 Removes the type of control for this UpdateOptionsKit. More...
 
 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...
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
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
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...
 

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 Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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.

Constructor & Destructor Documentation

HPS.UpdateOptionsKit.UpdateOptionsKit ( )
inline

The default constructor creates an empty UpdateOptionsKit object.

HPS.UpdateOptionsKit.UpdateOptionsKit ( HPS.UpdateOptionsKit  in_kit)
inline

The copy constructor creates a new UpdateOptionsKit object that contains the same settings as the source UpdateOptionsKit.

Parameters
in_kitThe source UpdateOptionsKit to copy.

Member Function Documentation

override bool HPS.UpdateOptionsKit.Empty ( )
inlinevirtual

Indicates whether this UpdateOptionsKit has any values set on it.

Returns
true if no values are set on this UpdateOptionsKit, false otherwise.

Reimplemented from HPS.Object.

bool HPS.UpdateOptionsKit.Equals ( HPS.UpdateOptionsKit  in_kit)
inline

Check if the source UpdateOptionsKit is equivalent to this UpdateOptionsKit.

Parameters
in_kitThe source UpdateOptionsKit to compare to this UpdateOptionsKit.
Returns
true if the objects are equivalent, false otherwise.
static HPS.UpdateOptionsKit HPS.UpdateOptionsKit.GetDefault ( )
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.

Returns
A UpdateOptionsKit with the default settings.
override HPS.Type HPS.UpdateOptionsKit.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.Kit.

void HPS.UpdateOptionsKit.Set ( HPS.UpdateOptionsKit  in_kit)
inline

Copies the source UpdateOptionsKit into this UpdateOptionsKit.

Parameters
in_kitThe source UpdateOptionsKit to copy.
HPS.UpdateOptionsKit HPS.UpdateOptionsKit.SetTimeLimit ( double  in_time_limit)
inline

Sets the time limit of this UpdateOptionsKit.

Parameters
in_time_limitThe time limit for this UpdateOptionsKit update.
Returns
A reference to this UpdateOptionsKit.
HPS.UpdateOptionsKit HPS.UpdateOptionsKit.SetUpdateType ( HPS.Window.UpdateType  in_type)
inline

Sets the type of update of this UpdateOptionsKit.

Parameters
in_typeThe type of update that this UpdateOptionsKit will perform.
Returns
A reference to this UpdateOptionsKit.
void HPS.UpdateOptionsKit.Show ( out HPS.UpdateOptionsKit  out_kit)
inline

Copies this UpdateOptionsKit into the given UpdateOptionsKit.

Parameters
out_kitThe UpdateOptionsKit to populate with the contents of this UpdateOptionsKit.
bool HPS.UpdateOptionsKit.ShowTimeLimit ( out double  out_time_limit)
inline

Shows the time limit from this UpdateOptionsKit.

Returns
true if the time limit is valid, false otherwise.
bool HPS.UpdateOptionsKit.ShowUpdateType ( out HPS.Window.UpdateType  out_type)
inline

Shows the type of control from this UpdateOptionsKit.

Parameters
out_typeThe type of update.
Returns
true if the type is valid, false otherwise.
HPS.UpdateOptionsKit HPS.UpdateOptionsKit.UnsetEverything ( )
inline

Removes all settings from this UpdateOptionsKit.

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

Removes the time limit of this UpdateOptionsKit.

Returns
A reference to this UpdateOptionsKit.
HPS.UpdateOptionsKit HPS.UpdateOptionsKit.UnsetUpdateType ( )
inline

Removes the type of control for this UpdateOptionsKit.

Returns
A reference to this UpdateOptionsKit.

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