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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.HighlightSearchOptionsKit in_kit)
 
override int GetHashCode ()
 
 HighlightSearchOptionsKit ()
 
 HighlightSearchOptionsKit (HPS.HighlightSearchOptionsKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.HighlightSearchOptionsKit in_kit)
 
HPS.HighlightSearchOptionsKit SetOverlay (HPS.Drawing.Overlay in_overlay)
 
HPS.HighlightSearchOptionsKit SetOverlays (HPS.Drawing.Overlay[] in_overlays)
 
HPS.HighlightSearchOptionsKit SetStyleName (string in_style_name)
 
HPS.HighlightSearchOptionsKit SetStyleNames (string[] in_style_names)
 
void Show (out HPS.HighlightSearchOptionsKit out_kit)
 
bool ShowOverlays (out HPS.Drawing.Overlay[] out_overlays)
 
bool ShowStyleNames (out string[] out_style_names)
 
HPS.HighlightSearchOptionsKit UnsetEverything ()
 
HPS.HighlightSearchOptionsKit UnsetOverlays ()
 
HPS.HighlightSearchOptionsKit UnsetStyleNames ()
 
- 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.HighlightSearchOptionsKit GetDefault ()
 
static bool operator!= (HPS.HighlightSearchOptionsKit a, HPS.HighlightSearchOptionsKit b)
 
static bool operator== (HPS.HighlightSearchOptionsKit a, HPS.HighlightSearchOptionsKit 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 HighlightSearchOptionsKit class is a user space object. It is used to filter highlight queries via HighlightControl.ShowHighlightState, HighlightControl.ShowHighlightStates, and WindowKey.FindHighlights.

Constructor & Destructor Documentation

◆ HighlightSearchOptionsKit() [1/2]

HPS.HighlightSearchOptionsKit.HighlightSearchOptionsKit ( )
inline

The default constructor creates an empty HighlightSearchOptionsKit object.

◆ HighlightSearchOptionsKit() [2/2]

HPS.HighlightSearchOptionsKit.HighlightSearchOptionsKit ( HPS.HighlightSearchOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source HighlightSearchOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.HighlightSearchOptionsKit.Empty ( )
inlinevirtual

Indicates whether this HighlightSearchOptionsKit has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

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

Check if the source HighlightSearchOptionsKit is equivalent to this HighlightSearchOptionsKit.

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

◆ GetDefault()

static HPS.HighlightSearchOptionsKit HPS.HighlightSearchOptionsKit.GetDefault ( )
inlinestatic

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

◆ ObjectType()

override HPS.Type HPS.HighlightSearchOptionsKit.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.HighlightSearchOptionsKit.Set ( HPS.HighlightSearchOptionsKit  in_kit)
inline

Copies the source HighlightSearchOptionsKit into this HighlightSearchOptionsKit.

Parameters
in_kitThe source HighlightSearchOptionsKit to copy.

◆ SetOverlay()

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

Sets the overlay type to look for when querying highlights. Only highlights using this overlay type will be returned by highlight queries.

Parameters
in_overlayOverlay type.
Returns
A reference to this object.

◆ SetOverlays()

HPS.HighlightSearchOptionsKit HPS.HighlightSearchOptionsKit.SetOverlays ( HPS.Drawing.Overlay []  in_overlays)
inline

Sets the overlay types to look for when querying highlights. Only highlights using any overlay types in the array will be returned by highlight queries.

Parameters
in_overlaysOverlay types.
Returns
A reference to this object.

◆ SetStyleName()

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

Sets the name of the style to look for when querying highlights. Only highlights using this style will be returned by highlight queries.

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

◆ SetStyleNames()

HPS.HighlightSearchOptionsKit HPS.HighlightSearchOptionsKit.SetStyleNames ( string []  in_style_names)
inline

Sets the names of the styles to look for when querying highlights. Only highlights using any style in the array will be returned by highlight queries.

Parameters
in_style_namesUTF8-encoded style names.
Returns
A reference to this HighlightSearchOptionsKit.

◆ Show()

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

Copies this HighlightSearchOptionsKit into the given HighlightSearchOptionsKit.

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

◆ ShowOverlays()

bool HPS.HighlightSearchOptionsKit.ShowOverlays ( out HPS.Drawing.Overlay []  out_overlays)
inline

Shows the overlay types to look for when querying highlights.

Parameters
out_overlaysOverlay types.
Returns
true if the setting is valid, false otherwise.

◆ ShowStyleNames()

bool HPS.HighlightSearchOptionsKit.ShowStyleNames ( out string []  out_style_names)
inline

Shows the names of the styles to look for when querying highlights.

Parameters
out_style_namesUTF8-encoded style names.
Returns
true if any style was specified, false otherwise.

◆ UnsetEverything()

HPS.HighlightSearchOptionsKit HPS.HighlightSearchOptionsKit.UnsetEverything ( )
inline

Removes all settings from this HighlightSearchOptionsKit.

Returns
A reference to this HighlightSearchOptionsKit.

◆ UnsetOverlays()

HPS.HighlightSearchOptionsKit HPS.HighlightSearchOptionsKit.UnsetOverlays ( )
inline

Removes all overlay filters.

Returns
A reference to this object.

◆ UnsetStyleNames()

HPS.HighlightSearchOptionsKit HPS.HighlightSearchOptionsKit.UnsetStyleNames ( )
inline

Removes all style filters.

Returns
A reference to this HighlightSearchOptionsKit.

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