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

The EllipseKit class is a user space object. It is the kit analog to an EllipseKey. More...

Inheritance diagram for HPS.EllipseKit:
HPS.Object

Public Member Functions

override void Dispose ()
 
 EllipseKit ()
 The default constructor creates an empty EllipseKit object. More...
 
 EllipseKit (HPS.EllipseKit in_kit)
 The copy constructor creates a new EllipseKit object that contains the same settings as the source EllipseKit. 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 Consume (HPS.EllipseKit in_kit)
 Copies the source EllipseKit into this EllipseKit and resets the source kit. More...
 
void Set (HPS.EllipseKit in_kit)
 Copies the source EllipseKit into this EllipseKit. More...
 
void Show (out HPS.EllipseKit out_kit)
 Copies this EllipseKit into the given EllipseKit. More...
 
override bool Empty ()
 Indicates whether this EllipseKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.EllipseKit in_kit)
 Check if the source EllipseKit is equivalent to this EllipseKit. More...
 
HPS.EllipseKit SetPriority (int in_priority)
 Assigns a specific drawing priority value to the EllipseKit. It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority. More...
 
HPS.EllipseKit UnsetPriority ()
 Removes a drawing priority setting. More...
 
bool ShowPriority (out int out_priority)
 Shows the drawing priority. More...
 
HPS.EllipseKit SetCenter (HPS.Point in_center)
 Sets the center point for the ellipse. More...
 
HPS.EllipseKit SetMajor (HPS.Point in_major)
 Sets the intersection point of the major axis and the ellipse. More...
 
HPS.EllipseKit SetMinor (HPS.Point in_minor)
 Sets the intersection point of the minor axis and the ellipse. More...
 
HPS.EllipseKit UnsetCenter ()
 Removes the center point for the ellipse. More...
 
HPS.EllipseKit UnsetMajor ()
 Removes the intersection point of the major axis and the ellipse. More...
 
HPS.EllipseKit UnsetMinor ()
 Removes the intersection point of the minor axis and the ellipse. More...
 
HPS.EllipseKit UnsetEverything ()
 Removes all settings from this EllipseKit. More...
 
bool ShowCenter (out HPS.Point out_center)
 Shows the center point for the ellipse. More...
 
bool ShowMajor (out HPS.Point out_major)
 Shows the intersection point of the major axis and the ellipse. More...
 
bool ShowMinor (out HPS.Point out_minor)
 Shows the intersection point of the minor axis and the ellipse. More...
 
HPS.EllipseKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 Sets user data on this kit. More...
 
HPS.EllipseKit SetUserData (IntPtr in_index, byte[] in_data)
 Sets user data on this kit. More...
 
HPS.EllipseKit SetUserData (IntPtr[] in_indices, byte[][] in_data)
 Sets user data on this kit. More...
 
HPS.EllipseKit UnsetUserData (IntPtr in_index)
 Removes the user data at the given index from this kit. More...
 
HPS.EllipseKit UnsetUserData (IntPtr[] in_indices)
 Removes the user data at the given indices from this kit. More...
 
HPS.EllipseKit UnsetAllUserData ()
 Removes all user data from this kit. More...
 
ulong ShowUserDataCount ()
 Get the number of user data indices set on this kit. More...
 
bool ShowUserDataIndices (out IntPtr[] out_indices)
 Shows the indices of all user data set on this kit. More...
 
bool ShowUserData (IntPtr in_index, out byte[] out_data)
 Shows the user data at a given index for this kit. More...
 
bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)
 Shows all user data for this kit. More...
 
- 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 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 bool operator== (HPS.EllipseKit a, HPS.EllipseKit b)
 
static bool operator!= (HPS.EllipseKit a, HPS.EllipseKit 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
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

Detailed Description

The EllipseKit class is a user space object. It is the kit analog to an EllipseKey.

Constructor & Destructor Documentation

HPS.EllipseKit.EllipseKit ( )
inline

The default constructor creates an empty EllipseKit object.

HPS.EllipseKit.EllipseKit ( HPS.EllipseKit  in_kit)
inline

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

Parameters
in_kitThe source EllipseKit to copy.

Member Function Documentation

void HPS.EllipseKit.Consume ( HPS.EllipseKit  in_kit)
inline

Copies the source EllipseKit into this EllipseKit and resets the source kit.

Parameters
in_kitThe source EllipseKit to consume.
override bool HPS.EllipseKit.Empty ( )
inlinevirtual

Indicates whether this EllipseKit has any values set on it.

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

Reimplemented from HPS.Object.

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

Check if the source EllipseKit is equivalent to this EllipseKit.

Parameters
in_kitThe source EllipseKit to compare to this EllipseKit.
Returns
true if the objects are equivalent, false otherwise.
override HPS.Type HPS.EllipseKit.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.

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

Copies the source EllipseKit into this EllipseKit.

Parameters
in_kitThe source EllipseKit to copy.
HPS.EllipseKit HPS.EllipseKit.SetCenter ( HPS.Point  in_center)
inline

Sets the center point for the ellipse.

Parameters
in_centerThe center point for the ellipse.
Returns
A reference to this EllipseKit.
HPS.EllipseKit HPS.EllipseKit.SetMajor ( HPS.Point  in_major)
inline

Sets the intersection point of the major axis and the ellipse.

Parameters
in_majorThe intersection point of the major axis and the ellipse.
Returns
A reference to this EllipseKit.
HPS.EllipseKit HPS.EllipseKit.SetMinor ( HPS.Point  in_minor)
inline

Sets the intersection point of the minor axis and the ellipse.

Parameters
in_minorThe intersection point of the minor axis and the ellipse.
Returns
A reference to this EllipseKit.
HPS.EllipseKit HPS.EllipseKit.SetPriority ( int  in_priority)
inline

Assigns a specific drawing priority value to the EllipseKit. It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority.

Parameters
in_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
A reference to this object.

SubwindowKit::SetPriority()

SubwindowKit::SetRenderingAlgorithm()

HPS.EllipseKit HPS.EllipseKit.SetUserData ( IntPtr  in_index,
ulong  in_bytes,
byte[]  in_data 
)
inline

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_bytesThe number of bytes of user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.
HPS.EllipseKit HPS.EllipseKit.SetUserData ( IntPtr  in_index,
byte[]  in_data 
)
inline

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.
HPS.EllipseKit HPS.EllipseKit.SetUserData ( IntPtr[]  in_indices,
byte  in_data[][] 
)
inline

Sets user data on this kit.

Parameters
in_indicesAn array of user data indices to set.
in_dataAn array of bytes of user data to set.
Returns
A reference to this kit.
void HPS.EllipseKit.Show ( out HPS.EllipseKit  out_kit)
inline

Copies this EllipseKit into the given EllipseKit.

Parameters
out_kitThe EllipseKit to populate with the contents of this EllipseKit.
bool HPS.EllipseKit.ShowCenter ( out HPS.Point  out_center)
inline

Shows the center point for the ellipse.

Parameters
out_centerThe center point for the ellipse.
Returns
true if a center was set, false otherwise.
bool HPS.EllipseKit.ShowMajor ( out HPS.Point  out_major)
inline

Shows the intersection point of the major axis and the ellipse.

Parameters
out_majorThe intersection point of the major axis and the ellipse.
Returns
true if an intersection point with the major axis was set, false otherwise.
bool HPS.EllipseKit.ShowMinor ( out HPS.Point  out_minor)
inline

Shows the intersection point of the minor axis and the ellipse.

Parameters
out_minorThe intersection point of the minor axis and the ellipse.
Returns
true if an intersection point with the minor axis was set, false otherwise.
bool HPS.EllipseKit.ShowPriority ( out int  out_priority)
inline

Shows the drawing priority.

Parameters
out_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
true if the setting is valid, false otherwise.
bool HPS.EllipseKit.ShowUserData ( IntPtr  in_index,
out byte[]  out_data 
)
inline

Shows the user data at a given index for this kit.

Parameters
in_indexThe index of the user data to show.
out_dataThe user data at the given index.
Returns
true if there is user data at the given index, false otherwise.
bool HPS.EllipseKit.ShowUserData ( out IntPtr[]  out_indices,
out byte  out_data[][] 
)
inline

Shows all user data for this kit.

Parameters
out_indicesAn array of all user data indices set on this kit.
out_dataAn array of all user data set on this kit.
Returns
true if there is user data on this kit, false otherwise.
ulong HPS.EllipseKit.ShowUserDataCount ( )
inline

Get the number of user data indices set on this kit.

bool HPS.EllipseKit.ShowUserDataIndices ( out IntPtr[]  out_indices)
inline

Shows the indices of all user data set on this kit.

Parameters
out_indicesThe user data indices set on this kit.
Returns
The number of user data indices set on this kit.
HPS.EllipseKit HPS.EllipseKit.UnsetAllUserData ( )
inline

Removes all user data from this kit.

Returns
A reference to this kit.
HPS.EllipseKit HPS.EllipseKit.UnsetCenter ( )
inline

Removes the center point for the ellipse.

Returns
A reference to this EllipseKit.
HPS.EllipseKit HPS.EllipseKit.UnsetEverything ( )
inline

Removes all settings from this EllipseKit.

Returns
A reference to this EllipseKit.
HPS.EllipseKit HPS.EllipseKit.UnsetMajor ( )
inline

Removes the intersection point of the major axis and the ellipse.

Returns
A reference to this EllipseKit.
HPS.EllipseKit HPS.EllipseKit.UnsetMinor ( )
inline

Removes the intersection point of the minor axis and the ellipse.

Returns
A reference to this EllipseKit.
HPS.EllipseKit HPS.EllipseKit.UnsetPriority ( )
inline

Removes a drawing priority setting.

Returns
A reference to this object.
HPS.EllipseKit HPS.EllipseKit.UnsetUserData ( IntPtr  in_index)
inline

Removes the user data at the given index from this kit.

Parameters
in_indexThe index of the user data to remove.
Returns
A reference to this kit.
HPS.EllipseKit HPS.EllipseKit.UnsetUserData ( IntPtr[]  in_indices)
inline

Removes the user data at the given indices from this kit.

Parameters
in_indicesThe indices of the user data to remove.
Returns
A reference to this kit.

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