C# Class _3PA.MainFeatures.InfoToolTip.InfoToolTip

Datei anzeigen Open project: jcaillon/3P

Public Properties

Property Type Description
CurrentWord string
GoToDefinitionFile string
GoToDefinitionPoint Point
IndexToShow int

Public Methods

Method Description
Close ( bool calledFromDwellEnd = false ) : void

Closes the form

CloseIfOpenedForCompletion ( ) : void

Closes the tooltip, but only if it was opened to help for an autocompletion item

ForceClose ( ) : void

Forces the form to close, only when leaving npp

GetCurrentlyDisplayedCompletionData ( ) : CompletionItem

Returns the current CompletionItem used in the tooltip

InitIfneeded ( ) : void

Method to init the tooltip form if needed

IsMouseIn ( ) : bool

Returns true if the cursor is within the form window

ShowToolTipFromAutocomplete ( CompletionItem item, Rectangle completionRectangle, bool reversedForm ) : void

Method called when the tooltip is opened to help the user during autocompletion

ShowToolTipFromDwell ( bool openTemporary = true ) : void

Method called when the tooltip is opened from the mouse being inactive on scintilla

TryToShowIndex ( ) : void

Called when a tooltip is shown and the user presses CTRL + down/up to show the other definitions available

Private Methods

Method Description
ClickHandler ( YamuiFramework.HtmlRenderer.Core.Core.Entities.HtmlLinkClickedEventArgs htmlLinkClickedEventArgs ) : void

Handles the clicks on the link displayed in the tooltip

FormatRow ( string describe, string result ) : string
FormatRowParam ( string paramType, string text ) : string
FormatRowWithImg ( string image, string text ) : string
FormatSubString ( string text ) : string
FormatSubtitle ( string text ) : string
SetToolTip ( ) : void

Sets the content of the tooltip (when we want to descibe something present in the completionData list)

Method Details

Close() public static method

Closes the form
public static Close ( bool calledFromDwellEnd = false ) : void
calledFromDwellEnd bool
return void

CloseIfOpenedForCompletion() public static method

Closes the tooltip, but only if it was opened to help for an autocompletion item
public static CloseIfOpenedForCompletion ( ) : void
return void

ForceClose() public static method

Forces the form to close, only when leaving npp
public static ForceClose ( ) : void
return void

GetCurrentlyDisplayedCompletionData() public static method

Returns the current CompletionItem used in the tooltip
public static GetCurrentlyDisplayedCompletionData ( ) : CompletionItem
return _3PA.MainFeatures.AutoCompletion.CompletionItem

InitIfneeded() public static method

Method to init the tooltip form if needed
public static InitIfneeded ( ) : void
return void

IsMouseIn() public static method

Returns true if the cursor is within the form window
public static IsMouseIn ( ) : bool
return bool

ShowToolTipFromAutocomplete() public static method

Method called when the tooltip is opened to help the user during autocompletion
public static ShowToolTipFromAutocomplete ( CompletionItem item, Rectangle completionRectangle, bool reversedForm ) : void
item _3PA.MainFeatures.AutoCompletion.CompletionItem
completionRectangle System.Drawing.Rectangle
reversedForm bool
return void

ShowToolTipFromDwell() public static method

Method called when the tooltip is opened from the mouse being inactive on scintilla
public static ShowToolTipFromDwell ( bool openTemporary = true ) : void
openTemporary bool
return void

TryToShowIndex() public static method

Called when a tooltip is shown and the user presses CTRL + down/up to show the other definitions available
public static TryToShowIndex ( ) : void
return void

Property Details

CurrentWord public_oe static_oe property

the current word that the tooltip displays
public static string CurrentWord
return string

GoToDefinitionFile public_oe static_oe property

public static string GoToDefinitionFile
return string

GoToDefinitionPoint public_oe static_oe property

If a tooltip is opened and it's a parsed item, this point leads to its definition
public static Point GoToDefinitionPoint
return Point

IndexToShow public_oe static_oe property

Index of the tooltip to show in case where a word corresponds to several items in the CompletionItem list
public static int IndexToShow
return int