HighlightOptionsKit

class HPS.HighlightOptionsKit : public HPS.Kit 

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.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this HighlightOptionsKit has any values set on it.

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

bool Equals (HPS.HighlightOptionsKit in_kit)

Check if the source HighlightOptionsKit is equivalent to this HighlightOptionsKit.

Param in_kit: The source HighlightOptionsKit to compare to this HighlightOptionsKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

HighlightOptionsKit (): The default constructor creates an empty HighlightOptionsKit object.

HighlightOptionsKit (HPS.HighlightOptionsKit in_kit)

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

Param in_kit: The source HighlightOptionsKit to copy.

HighlightOptionsKit (string in_style_name)

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

Param in_style_name: The style name to set on this HighlightOptionsKit.

HighlightOptionsKit (string in_style_name, string in_secondary_style_name)

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

Param in_style_name: The style name to set on this HighlightOptionsKit.
Param in_secondary_style_name: The style name to set on this HighlightOptionsKit.

override HPS.Type ObjectType ()

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

Return: The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.HighlightOptionsKit in_kit)

Copies the source HighlightOptionsKit into this HighlightOptionsKit.

Param in_kit: The source HighlightOptionsKit to copy.

HPS.HighlightOptionsKit SetNotification (bool in_state)

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

See: Notification default value

Param in_state: Whether to inject a notification event after highlighting (or unhighlighting).
Return: A reference to this HighlightOptionsKit.

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

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.

See: Overlay default value

Note

If in_overlay is specified as Drawing.Overlay.None, Drawing.Overlay.InPlace will be used instead

Param in_overlay: The 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.
Return: A reference to this object.

HPS.HighlightOptionsKit SetPassive (bool in_pasive)

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

Param in_pasive: If 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.
Return: A reference to this HighlightOptionsKit.

HPS.HighlightOptionsKit SetSecondaryStyleName (string in_style_name)

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

Param in_style_name: UTF8-encoded style name.
Return: A reference to this HighlightOptionsKit.

HPS.HighlightOptionsKit SetStyleName (string in_style_name)

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

Param in_style_name: UTF8-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.
Return: A reference to this HighlightOptionsKit.

HPS.HighlightOptionsKit SetSubentityHighlighting (bool in_enable)

Sets whether subentity highlighting is enabled.

Param in_enable: Whether subentity highlighting is enabled.
Return: A reference to this HighlightOptionsKit.

void Show (out HPS.HighlightOptionsKit out_kit)

Copies this HighlightOptionsKit into the given HighlightOptionsKit.

Param out_kit: The HighlightOptionsKit to populate with the contents of this HighlightOptionsKit.

bool ShowNotification (out bool out_state)

Shows the notification setting.

Param out_state: Whether to inject a notification event after highlighting (or unhighlighting).
Return: true if a notification setting was specified, false otherwise.

bool ShowOverlay (out HPS.Drawing.Overlay out_overlay)

Shows the overlay setting.

Param out_overlay: The type of overlay, if any, used.
Return: true if the setting is valid, false otherwise.

bool ShowPassive (out bool out_pasive)

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

Param out_pasive: Indicates whether the highlight(s) to apply (or unapply) is passive.
Return: A reference to this HighlightOptionsKit.

bool ShowSecondaryStyleName (out string out_style_name)

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

Param out_style_name: UTF8-encoded style name.
Return: true if a style was specified, false otherwise.

bool ShowStyleName (out string out_style_name)

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

Param out_style_name: UTF8-encoded style name.
Return: true if a style was specified, false otherwise.

bool ShowSubentityHighlighting (out bool out_enable)

Shows whether subentity highlighting is enabled.

Param out_enable: Whether subentity highlighting is enabled.
Return: true if a flag was specified, false otherwise.

HPS.HighlightOptionsKit UnsetEverything ()

Removes all settings from this HighlightOptionsKit.

Return: A reference to this HighlightOptionsKit.

HPS.HighlightOptionsKit UnsetNotification ()

Removes the notification setting.

Return: A reference to this HighlightOptionsKit.

HPS.HighlightOptionsKit UnsetOverlay ()

Removes an overlay setting.

Return: A reference to this object.

HPS.HighlightOptionsKit UnsetPassive ()

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

Return: A reference to this HighlightOptionsKit.

HPS.HighlightOptionsKit UnsetSecondaryStyleName ()

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

Return: A reference to this HighlightOptionsKit.

HPS.HighlightOptionsKit UnsetStyleName ()

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

Return: A reference to this HighlightOptionsKit.

HPS.HighlightOptionsKit UnsetSubentityHighlighting ()

Removes whether subentity highlighting is enabled.

Return: A reference to this HighlightOptionsKit.

Public Static Functions

HPS.HighlightOptionsKit GetDefault ()

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.

Return: A HighlightOptionsKit with the default settings.

bool operator!= (HPS.HighlightOptionsKit a, HPS.HighlightOptionsKit b)

bool operator== (HPS.HighlightOptionsKit a, HPS.HighlightOptionsKit b)