< Home

< Table of Contents

REFERENCE MANUAL

HPS.HighlightOptionsKit Class Reference

The HighlightOptionsKit class is a user space object. More...

Inheritance diagram for HPS.HighlightOptionsKit:
HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this HighlightOptionsKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.HighlightOptionsKit in_kit)
 Check if the source HighlightOptionsKit is equivalent to this HighlightOptionsKit. More...
 
override int GetHashCode ()
 
 HighlightOptionsKit ()
 The default constructor creates an empty HighlightOptionsKit object. More...
 
 HighlightOptionsKit (string in_style_name)
 This constructor creates a HighlightOptionsKit object with the specified style name set on it. More...
 
 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. More...
 
 HighlightOptionsKit (HPS.HighlightOptionsKit in_kit)
 The copy constructor creates a new HighlightOptionsKit object that contains the same settings as the source HighlightOptionsKit. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.HighlightOptionsKit in_kit)
 Copies the source HighlightOptionsKit into this HighlightOptionsKit. More...
 
HPS.HighlightOptionsKit SetNotification (bool in_state)
 Whether to inject a notification event after highlighting (or unhighlighting). More...
 
HPS.HighlightOptionsKit SetOverlay (HPS.Drawing.Overlay in_overlay)
 Allows highlighting to take place in a segment without triggering a full-screen redraw. More...
 
HPS.HighlightOptionsKit SetSecondaryStyleName (string in_style_name)
 Sets the name of the secondary style to apply (or unapply) when highlighting (or unhighlighting). More...
 
HPS.HighlightOptionsKit SetStyleName (string in_style_name)
 Sets the name of the style to apply (or unapply) when highlighting (or unhighlighting). More...
 
void Show (out HPS.HighlightOptionsKit out_kit)
 Copies this HighlightOptionsKit into the given HighlightOptionsKit. More...
 
bool ShowNotification (out bool out_state)
 Shows the notification setting. More...
 
bool ShowOverlay (out HPS.Drawing.Overlay out_overlay)
 Shows the overlay setting. More...
 
bool ShowSecondaryStyleName (out string out_style_name)
 Shows the name of the secondary style to apply (or unapply) when highlighting (or unhighlighting). More...
 
bool ShowStyleName (out string out_style_name)
 Shows the name of the style to apply (or unapply) when highlighting (or unhighlighting). More...
 
HPS.HighlightOptionsKit UnsetEverything ()
 Removes all settings from this HighlightOptionsKit. More...
 
HPS.HighlightOptionsKit UnsetNotification ()
 Removes the notification setting. More...
 
HPS.HighlightOptionsKit UnsetOverlay ()
 Removes an overlay setting. More...
 
HPS.HighlightOptionsKit UnsetSecondaryStyleName ()
 Removes the secondary style to apply (or unapply) when highlighting (or unhighlighting). More...
 
HPS.HighlightOptionsKit UnsetStyleName ()
 Removes the style to apply (or unapply) when highlighting (or unhighlighting). 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. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Static Public Member Functions

static HPS.HighlightOptionsKit GetDefault ()
 Creates a HighlightOptionsKit which contains the default settings. More...
 
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.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

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

Detailed Description

The HighlightOptionsKit class is a user space object.

It is used to hold settings needed when performing a highlight or unhighlight. HighlightOptionsKit::GetDefault() will return a highlight options kit with values found in this table.

Constructor & Destructor Documentation

HPS.HighlightOptionsKit.HighlightOptionsKit ( )

The default constructor creates an empty HighlightOptionsKit object.

HPS.HighlightOptionsKit.HighlightOptionsKit ( string  in_style_name)

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

Parameters
in_style_nameThe style name to set on this <ref refid="class_h_p_s_1_1_highlight_options_kit" kindref="compound">HighlightOptionsKit</ref>.
HPS.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.

Parameters
in_style_nameThe style name to set on this <ref refid="class_h_p_s_1_1_highlight_options_kit" kindref="compound">HighlightOptionsKit</ref>.
in_secondary_style_nameThe style name to set on this <ref refid="class_h_p_s_1_1_highlight_options_kit" kindref="compound">HighlightOptionsKit</ref>.
HPS.HighlightOptionsKit.HighlightOptionsKit ( HPS.HighlightOptionsKit  in_kit)

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_highlight_options_kit" kindref="compound">HighlightOptionsKit</ref> to copy.

Member Function Documentation

override bool HPS.HighlightOptionsKit.Empty ( )
virtual

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.

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

Check if the source HighlightOptionsKit is equivalent to this HighlightOptionsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_highlight_options_kit" kindref="compound">HighlightOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_highlight_options_kit" kindref="compound">HighlightOptionsKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
static HPS.HighlightOptionsKit HPS.HighlightOptionsKit.GetDefault ( )
static

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.
override HPS.Type HPS.HighlightOptionsKit.ObjectType ( )
virtual

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.HighlightOptionsKit.Set ( HPS.HighlightOptionsKit  in_kit)

Copies the source HighlightOptionsKit into this HighlightOptionsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_highlight_options_kit" kindref="compound">HighlightOptionsKit</ref> to copy.
HPS.HighlightOptionsKit HPS.HighlightOptionsKit.SetNotification ( bool  in_state)

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.

Notification default value

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

Parameters
in_overlayThe type of overlay, if any, to be used.
Returns
A reference to this object.

Overlay default value

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

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.
HPS.HighlightOptionsKit HPS.HighlightOptionsKit.SetStyleName ( string  in_style_name)

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

Parameters
in_style_nameUTF8-encoded style name.
Returns
A reference to this HighlightOptionsKit.
void HPS.HighlightOptionsKit.Show ( out HPS.HighlightOptionsKit  out_kit)

Copies this HighlightOptionsKit into the given HighlightOptionsKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_highlight_options_kit" kindref="compound">HighlightOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_highlight_options_kit" kindref="compound">HighlightOptionsKit</ref>.
bool HPS.HighlightOptionsKit.ShowNotification ( out bool  out_state)

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.
bool HPS.HighlightOptionsKit.ShowOverlay ( out HPS.Drawing.Overlay  out_overlay)

Shows the overlay setting.

Parameters
out_overlayThe type of overlay, if any, used.
Returns
true if the setting is valid, false otherwise.
bool HPS.HighlightOptionsKit.ShowSecondaryStyleName ( out string  out_style_name)

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.
bool HPS.HighlightOptionsKit.ShowStyleName ( out string  out_style_name)

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.
HPS.HighlightOptionsKit HPS.HighlightOptionsKit.UnsetEverything ( )

Removes all settings from this HighlightOptionsKit.

Returns
A reference to this HighlightOptionsKit.
HPS.HighlightOptionsKit HPS.HighlightOptionsKit.UnsetNotification ( )

Removes the notification setting.

Returns
A reference to this HighlightOptionsKit.
HPS.HighlightOptionsKit HPS.HighlightOptionsKit.UnsetOverlay ( )

Removes an overlay setting.

Returns
A reference to this object.
HPS.HighlightOptionsKit HPS.HighlightOptionsKit.UnsetSecondaryStyleName ( )

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

Returns
A reference to this HighlightOptionsKit.
HPS.HighlightOptionsKit HPS.HighlightOptionsKit.UnsetStyleName ( )

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

Returns
A reference to this HighlightOptionsKit.

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