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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.HighlightOptionsKit in_kit)
 
override int GetHashCode ()
 
 HighlightOptionsKit ()
 
 HighlightOptionsKit (string in_style_name)
 
 HighlightOptionsKit (string in_style_name, string in_secondary_style_name)
 
 HighlightOptionsKit (HPS.HighlightOptionsKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.HighlightOptionsKit in_kit)
 
HPS.HighlightOptionsKit SetNotification (bool in_state)
 
HPS.HighlightOptionsKit SetOverlay (HPS.Drawing.Overlay in_overlay)
 
HPS.HighlightOptionsKit SetPassive (bool in_pasive)
 
HPS.HighlightOptionsKit SetSecondaryStyleName (string in_style_name)
 
HPS.HighlightOptionsKit SetStyleName (string in_style_name)
 
HPS.HighlightOptionsKit SetSubentityHighlighting (bool in_enable)
 
void Show (out HPS.HighlightOptionsKit out_kit)
 
bool ShowNotification (out bool out_state)
 
bool ShowOverlay (out HPS.Drawing.Overlay out_overlay)
 
bool ShowPassive (out bool out_pasive)
 
bool ShowSecondaryStyleName (out string out_style_name)
 
bool ShowStyleName (out string out_style_name)
 
bool ShowSubentityHighlighting (out bool out_enable)
 
HPS.HighlightOptionsKit UnsetEverything ()
 
HPS.HighlightOptionsKit UnsetNotification ()
 
HPS.HighlightOptionsKit UnsetOverlay ()
 
HPS.HighlightOptionsKit UnsetPassive ()
 
HPS.HighlightOptionsKit UnsetSecondaryStyleName ()
 
HPS.HighlightOptionsKit UnsetStyleName ()
 
HPS.HighlightOptionsKit UnsetSubentityHighlighting ()
 
- Public Member Functions inherited from HPS.Kit
override void Dispose ()
 
 Kit (HPS.Kit in_that)
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.HighlightOptionsKit GetDefault ()
 
static bool operator!= (HPS.HighlightOptionsKit a, HPS.HighlightOptionsKit b)
 
static bool operator== (HPS.HighlightOptionsKit a, HPS.HighlightOptionsKit 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 HighlightOptionsKit class is a user space object. It is used to hold settings needed when performing a highlight or unhighlight. HPS.HighlightOptionsKit.GetDefault() will return a highlight options kit with values found in this table.

Constructor & Destructor Documentation

◆ HighlightOptionsKit() [1/4]

HPS.HighlightOptionsKit.HighlightOptionsKit ( )
inline

The default constructor creates an empty HighlightOptionsKit object.

◆ HighlightOptionsKit() [2/4]

HPS.HighlightOptionsKit.HighlightOptionsKit ( string  in_style_name)
inline

This constructor creates a HighlightOptionsKit object with the specified style name set on it.

Parameters
in_style_nameThe style name to set on this HighlightOptionsKit.

◆ HighlightOptionsKit() [3/4]

HPS.HighlightOptionsKit.HighlightOptionsKit ( string  in_style_name,
string  in_secondary_style_name 
)
inline

This constructor creates a HighlightOptionsKit object with the specified style and secondary style names set on it.

Parameters
in_style_nameThe style name to set on this HighlightOptionsKit.
in_secondary_style_nameThe style name to set on this HighlightOptionsKit.

◆ HighlightOptionsKit() [4/4]

HPS.HighlightOptionsKit.HighlightOptionsKit ( HPS.HighlightOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source HighlightOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.HighlightOptionsKit.Empty ( )
inlinevirtual

Indicates whether this HighlightOptionsKit has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

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

Check if the source HighlightOptionsKit is equivalent to this HighlightOptionsKit.

Parameters
in_kitThe source HighlightOptionsKit to compare to this HighlightOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.HighlightOptionsKit HPS.HighlightOptionsKit.GetDefault ( )
inlinestatic

Creates a HighlightOptionsKit 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 HighlightOptionsKit with the default settings.

◆ ObjectType()

override HPS.Type HPS.HighlightOptionsKit.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.Object.

◆ Set()

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

Copies the source HighlightOptionsKit into this HighlightOptionsKit.

Parameters
in_kitThe source HighlightOptionsKit to copy.

◆ SetNotification()

HPS.HighlightOptionsKit HPS.HighlightOptionsKit.SetNotification ( bool  in_state)
inline

Whether to inject a notification event after highlighting (or unhighlighting).

Parameters
in_stateWhether to inject a notification event after highlighting (or unhighlighting).
Returns
A reference to this HighlightOptionsKit.
See also
Notification default value

◆ SetOverlay()

HPS.HighlightOptionsKit HPS.HighlightOptionsKit.SetOverlay ( HPS.Drawing.Overlay  in_overlay)
inline

Allows highlighting to take place in a segment without triggering a full-screen redraw. If any type of overlay is used, transparency in the highlighted object(s) will be ignored.

Note
If in_overlay is specified as Drawing.Overlay.None, Drawing.Overlay.InPlace will be used instead
Parameters
in_overlayThe type of overlay, if any, to be used. If this HighlightOptionsKit is being passed to an Unhighlight call, only highlights whose overlay type match in_overlay will be removed.
Returns
A reference to this object.
See also
Overlay default value

◆ SetPassive()

HPS.HighlightOptionsKit HPS.HighlightOptionsKit.SetPassive ( bool  in_pasive)
inline

Sets whether the highlight(s) to apply (or unapply) are passive.

Parameters
in_pasiveIf set to true attribute locks set on the path being highlighted will be honored by the highlight. If set to false attribute locks set on the path being highlighted will be overriden by the highlight. If unspecified the default is false. If this HighlightOptionsKit is being passed to an Unhighlight call, only highlights whose passiveness match in_pasive will be removed.
Returns
A reference to this HighlightOptionsKit.

◆ SetSecondaryStyleName()

HPS.HighlightOptionsKit HPS.HighlightOptionsKit.SetSecondaryStyleName ( string  in_style_name)
inline

Sets the name of the secondary style to apply (or unapply) when highlighting (or unhighlighting).

Parameters
in_style_nameUTF8-encoded style name.
Returns
A reference to this HighlightOptionsKit.

◆ SetStyleName()

HPS.HighlightOptionsKit HPS.HighlightOptionsKit.SetStyleName ( string  in_style_name)
inline

Sets the name of the style to apply (or unapply) when highlighting (or unhighlighting).

Parameters
in_style_nameUTF8-encoded style name. If this HighlightOptionsKit is being passed to an Unhighlight call, only highlights whose style name match in_style_name will be removed.
Returns
A reference to this HighlightOptionsKit.

◆ SetSubentityHighlighting()

HPS.HighlightOptionsKit HPS.HighlightOptionsKit.SetSubentityHighlighting ( bool  in_enable)
inline

Sets whether subentity highlighting is enabled.

Parameters
in_enableWhether subentity highlighting is enabled.
Returns
A reference to this HighlightOptionsKit.

◆ Show()

void HPS.HighlightOptionsKit.Show ( out HPS.HighlightOptionsKit  out_kit)
inline

Copies this HighlightOptionsKit into the given HighlightOptionsKit.

Parameters
out_kitThe HighlightOptionsKit to populate with the contents of this HighlightOptionsKit.

◆ ShowNotification()

bool HPS.HighlightOptionsKit.ShowNotification ( out bool  out_state)
inline

Shows the notification setting.

Parameters
out_stateWhether to inject a notification event after highlighting (or unhighlighting).
Returns
true if a notification setting was specified, false otherwise.

◆ ShowOverlay()

bool HPS.HighlightOptionsKit.ShowOverlay ( out HPS.Drawing.Overlay  out_overlay)
inline

Shows the overlay setting.

Parameters
out_overlayThe type of overlay, if any, used.
Returns
true if the setting is valid, false otherwise.

◆ ShowPassive()

bool HPS.HighlightOptionsKit.ShowPassive ( out bool  out_pasive)
inline

Shows whether the highlight(s) to apply (or unapply) is passive.

Parameters
out_pasiveIndicates whether the highlight(s) to apply (or unapply) is passive.
Returns
A reference to this HighlightOptionsKit.

◆ ShowSecondaryStyleName()

bool HPS.HighlightOptionsKit.ShowSecondaryStyleName ( out string  out_style_name)
inline

Shows the name of the secondary style to apply (or unapply) when highlighting (or unhighlighting).

Parameters
out_style_nameUTF8-encoded style name.
Returns
true if a style was specified, false otherwise.

◆ ShowStyleName()

bool HPS.HighlightOptionsKit.ShowStyleName ( out string  out_style_name)
inline

Shows the name of the style to apply (or unapply) when highlighting (or unhighlighting).

Parameters
out_style_nameUTF8-encoded style name.
Returns
true if a style was specified, false otherwise.

◆ ShowSubentityHighlighting()

bool HPS.HighlightOptionsKit.ShowSubentityHighlighting ( out bool  out_enable)
inline

Shows whether subentity highlighting is enabled.

Parameters
out_enableWhether subentity highlighting is enabled.
Returns
true if a flag was specified, false otherwise.

◆ UnsetEverything()

HPS.HighlightOptionsKit HPS.HighlightOptionsKit.UnsetEverything ( )
inline

Removes all settings from this HighlightOptionsKit.

Returns
A reference to this HighlightOptionsKit.

◆ UnsetNotification()

HPS.HighlightOptionsKit HPS.HighlightOptionsKit.UnsetNotification ( )
inline

Removes the notification setting.

Returns
A reference to this HighlightOptionsKit.

◆ UnsetOverlay()

HPS.HighlightOptionsKit HPS.HighlightOptionsKit.UnsetOverlay ( )
inline

Removes an overlay setting.

Returns
A reference to this object.

◆ UnsetPassive()

HPS.HighlightOptionsKit HPS.HighlightOptionsKit.UnsetPassive ( )
inline

Removes any preference on whether this highlight is passive or active.

Returns
A reference to this HighlightOptionsKit.

◆ UnsetSecondaryStyleName()

HPS.HighlightOptionsKit HPS.HighlightOptionsKit.UnsetSecondaryStyleName ( )
inline

Removes the secondary style to apply (or unapply) when highlighting (or unhighlighting).

Returns
A reference to this HighlightOptionsKit.

◆ UnsetStyleName()

HPS.HighlightOptionsKit HPS.HighlightOptionsKit.UnsetStyleName ( )
inline

Removes the style to apply (or unapply) when highlighting (or unhighlighting).

Returns
A reference to this HighlightOptionsKit.

◆ UnsetSubentityHighlighting()

HPS.HighlightOptionsKit HPS.HighlightOptionsKit.UnsetSubentityHighlighting ( )
inline

Removes whether subentity highlighting is enabled.

Returns
A reference to this HighlightOptionsKit.

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