More...

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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this GlyphKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.GlyphKit in_kit)
 Check if the source GlyphKit is equivalent to this GlyphKit. More...
 
override int GetHashCode ()
 
 GlyphKit ()
 The default constructor creates an empty GlyphKit object. More...
 
 GlyphKit (HPS.GlyphKit in_kit)
 The copy constructor creates a new GlyphKit object that contains the same settings as the source GlyphKit. 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.GlyphKit in_kit)
 Copies the source GlyphKit into this GlyphKit. More...
 
HPS.GlyphKit SetElement (HPS.GlyphElement in_element)
 Set a single element for this GlyphKit. This must be specified when defining a glyph. More...
 
HPS.GlyphKit SetElements (HPS.GlyphElement[] in_def)
 Sets the elements for this GlyphKit. This must be specified when defining a glyph. More...
 
HPS.GlyphKit SetOffset (HPS.GlyphPoint in_point)
 Sets the offset for this GlyphKit. This will determine how the glyph gets shifted relative to the insertion point when the glyph is use. This must be specified when defining a glyph. More...
 
HPS.GlyphKit SetRadius (sbyte in_radius)
 Sets the radius of this GlyphKit. This must be specified when defining a glyph. More...
 
void Show (out HPS.GlyphKit out_kit)
 Copies this GlyphKit into the given GlyphKit. More...
 
bool ShowElements (out HPS.GlyphElement[] out_def)
 Shows the elements for this GlyphKit. More...
 
bool ShowOffset (out HPS.GlyphPoint out_point)
 Shows the offset for this GlyphKit. More...
 
bool ShowRadius (out sbyte out_radius)
 Shows the radius for this GlyphKit. More...
 
HPS.GlyphKit UnsetElements ()
 Removes the elements for the glyph. More...
 
HPS.GlyphKit UnsetEverything ()
 Removes all settings from this GlyphKit. More...
 
HPS.GlyphKit UnsetOffset ()
 Removes the offset for the glyph. More...
 
HPS.GlyphKit UnsetRadius ()
 Removes the radius for the glyph. More...
 
- Public Member Functions inherited from HPS.Kit
override void Dispose ()
 
 Kit (HPS.Kit in_that)
 
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...
 
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.GlyphKit GetDefault (HPS.Glyph.Default in_default_glyph)
 Creates a GlyphKit which contains the definition of the specified default glyph. More...
 
static bool operator!= (HPS.GlyphKit a, HPS.GlyphKit b)
 
static bool operator== (HPS.GlyphKit a, HPS.GlyphKit 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.Kit
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 GlyphKit class is a user space object. It is used when defining a glyph.

Constructor & Destructor Documentation

HPS.GlyphKit.GlyphKit ( )
inline

The default constructor creates an empty GlyphKit object.

HPS.GlyphKit.GlyphKit ( HPS.GlyphKit  in_kit)
inline

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

Parameters
in_kitThe source GlyphKit to copy.

Member Function Documentation

override bool HPS.GlyphKit.Empty ( )
inlinevirtual

Indicates whether this GlyphKit has any values set on it.

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

Reimplemented from HPS.Object.

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

Check if the source GlyphKit is equivalent to this GlyphKit.

Parameters
in_kitThe source GlyphKit to compare to this GlyphKit.
Returns
    true if the objects are equivalent, false otherwise.
static HPS.GlyphKit HPS.GlyphKit.GetDefault ( HPS.Glyph.Default  in_default_glyph)
inlinestatic

Creates a GlyphKit which contains the definition of the specified default glyph.

Parameters
in_default_glyphThe default glyph for which to get the corresponding GlyphKit.
Returns
    A GlyphKit which contains the definition of the specified default glyph.
override HPS.Type HPS.GlyphKit.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.GlyphKit.Set ( HPS.GlyphKit  in_kit)
inline

Copies the source GlyphKit into this GlyphKit.

Parameters
in_kitThe source GlyphKit to copy.
HPS.GlyphKit HPS.GlyphKit.SetElement ( HPS.GlyphElement  in_element)
inline

Set a single element for this GlyphKit. This must be specified when defining a glyph.

Parameters
in_elementA reference to the GlyphElement to set on this kit.
Returns
    A reference to this GlyphKit.
HPS.GlyphKit HPS.GlyphKit.SetElements ( HPS.GlyphElement[]  in_def)
inline

Sets the elements for this GlyphKit. This must be specified when defining a glyph.

Parameters
in_defThe array of elements for the glyph.
Returns
    A reference to this GlyphKit.
HPS.GlyphKit HPS.GlyphKit.SetOffset ( HPS.GlyphPoint  in_point)
inline

Sets the offset for this GlyphKit. This will determine how the glyph gets shifted relative to the insertion point when the glyph is use. This must be specified when defining a glyph.

Parameters
in_pointThe offset for the glyph.
Returns
    A reference to this GlyphKit.
HPS.GlyphKit HPS.GlyphKit.SetRadius ( sbyte  in_radius)
inline

Sets the radius of this GlyphKit. This must be specified when defining a glyph.

Parameters
in_radiusThe radius of the glyph. The value must be in the range [0,127].
Returns
    A reference to this GlyphKit.
void HPS.GlyphKit.Show ( out HPS.GlyphKit  out_kit)
inline

Copies this GlyphKit into the given GlyphKit.

Parameters
out_kitThe GlyphKit to populate with the contents of this GlyphKit.
bool HPS.GlyphKit.ShowElements ( out HPS.GlyphElement[]  out_def)
inline

Shows the elements for this GlyphKit.

Parameters
out_defThe elements for the glyph.
Returns
    true if elements were set, false otherwise.
bool HPS.GlyphKit.ShowOffset ( out HPS.GlyphPoint  out_point)
inline

Shows the offset for this GlyphKit.

Parameters
out_pointThe offset for the glyph.
Returns
    true if an offset was set, false otherwise.
bool HPS.GlyphKit.ShowRadius ( out sbyte  out_radius)
inline

Shows the radius for this GlyphKit.

Parameters
out_radiusThe radius for the glyph.
Returns
    true if a radius was set, false otherwise.
HPS.GlyphKit HPS.GlyphKit.UnsetElements ( )
inline

Removes the elements for the glyph.

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

Removes all settings from this GlyphKit.

Returns
    A reference to this GlyphKit.
HPS.GlyphKit HPS.GlyphKit.UnsetOffset ( )
inline

Removes the offset for the glyph.

Returns
    A reference to this GlyphKit.
HPS.GlyphKit HPS.GlyphKit.UnsetRadius ( )
inline

Removes the radius for the glyph.

Returns
    A reference to this GlyphKit.

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