C# Class Scroller.ScrollerPlugin

Inheritance: IPlugin, IHighlighterService

Show file Open project: Invenietis/ck-certified Class Usage Examples

Public Properties

Property	Type	Description
PluginId	INamedVersionedUniqueId

Private Properties

Property	Type	Description
BrowseTree	bool
OnConfigChanged	void
OnInputTriggered	void

Public Methods

Method	Description
HighlightImmediately ( IHighlightableElement element ) : void	This function forces the highlight of the given element. This function is useful only when there is no alternative to.
Pause ( bool forceEndHighlight = false ) : void
RegisterInRegisteredElementAt ( string targetModuleName, string extensibleElementName, ChildPosition position, IHighlightableElement element ) : bool	Enables registering a tree node (and its children) in an already registered module. The module has to have an IExtensibleHighlightableElement whose name matches the extensibleElementName set as parameter.
RegisterTree ( string targetModuleName, string targetDisplayName, IHighlightableElement element, bool HighlightDirectly = false ) : void
Resume ( ) : void
Setup ( CK.Plugin.IPluginSetupInfo info ) : bool
Start ( ) : void
Stop ( ) : void
Teardown ( ) : void
UnregisterInRegisteredElement ( string targetModuleName, string extensibleElementName, ChildPosition position, IHighlightableElement element ) : bool	Enables unregistering a tree node (and its children) that had been registered inside an already registered module (see RegisterInRegisteredElementAt )
UnregisterTree ( string targetModuleName, IHighlightableElement element ) : void

Private Methods

Method	Description
BrowseTree ( IHighlightableElement element, bool>.Func doing ) : bool	This method calls the function with with "element" as parameter and then calls it on each of its hightlightable children. At any point, if the function returns false, the browsing stops.
OnConfigChanged ( object sender, CK.Plugin.Config.ConfigChangedEventArgs e ) : void
OnInputTriggered ( ITrigger t ) : void

Method Details

HighlightImmediately() public method

This function forces the highlight of the given element.

This function is useful only when there is no alternative to.

public HighlightImmediately ( IHighlightableElement element ) : void
element	IHighlightableElement	The element highlight.
return	void

Pause() public method

public Pause ( bool forceEndHighlight = false ) : void
forceEndHighlight	bool
return	void

RegisterInRegisteredElementAt() public method

Enables registering a tree node (and its children) in an already registered module. The module has to have an IExtensibleHighlightableElement whose name matches the extensibleElementName set as parameter.

public RegisterInRegisteredElementAt ( string targetModuleName, string extensibleElementName, ChildPosition position, IHighlightableElement element ) : bool
targetModuleName	string	The name of the target module
extensibleElementName	string	The name of the target node
position	ChildPosition
element	IHighlightableElement	The element to register
return	bool

RegisterTree() public method

public RegisterTree ( string targetModuleName, string targetDisplayName, IHighlightableElement element, bool HighlightDirectly = false ) : void
targetModuleName	string
targetDisplayName	string
element	IHighlightableElement
HighlightDirectly	bool
return	void

Resume() public method

public Resume ( ) : void
return	void

Setup() public method

public Setup ( CK.Plugin.IPluginSetupInfo info ) : bool
info	CK.Plugin.IPluginSetupInfo
return	bool

Start() public method

public Start ( ) : void
return	void

Stop() public method

public Stop ( ) : void
return	void

Teardown() public method

public Teardown ( ) : void
return	void

UnregisterInRegisteredElement() public method

Enables unregistering a tree node (and its children) that had been registered inside an already registered module (see RegisterInRegisteredElementAt )

public UnregisterInRegisteredElement ( string targetModuleName, string extensibleElementName, ChildPosition position, IHighlightableElement element ) : bool
targetModuleName	string	The name of the target module
extensibleElementName	string	The name of the target node
position	ChildPosition
element	IHighlightableElement	The element to unregister
return	bool

UnregisterTree() public method

public UnregisterTree ( string targetModuleName, IHighlightableElement element ) : void
targetModuleName	string
element	IHighlightableElement
return	void

Property Details

PluginId public static property

public static INamedVersionedUniqueId PluginId
return	INamedVersionedUniqueId