C# Class Yaircc.UI.IRCTabPage

Represents a TabPage that can communicate with an IRC server

Inheritance: System.Windows.Forms.TabPage

Mostrar archivo Open project: rastating/yaircc Class Usage Examples

Private Properties

Property	Type	Description
ChangeTreeNodeState	void
HandleCollapseAndExpansion	void
Initialise	void
InitialiseWebView	void
RemoveUserFromList	bool
RemoveUserFromTopLevelNodes	bool
SetSplashText	void
SetupConsoleContent	void
UserTreeView_AfterCollapse	void
UserTreeView_AfterExpand	void
WebView_PreviewKeyDown	void
WebView_PropertyChanged	void

Public Methods

Method	Description
AddUserToList ( IRCUser user ) : TreeNode	Adds a user to the tree view list.
AddUserToList ( IRCUser user, bool refresh ) : void	Adds a user to the tree view list.
AppendMessage ( string command, string source, string payload, MessageType type ) : void	Appends a message to the tab's browser control and transforms the payload accordingly to show custom font styles / colours.
AppendMessage ( string command, string source, string payload, MessageType type, string>.Func transform ) : void	Appends a message to the tab's browser control.
ClearLog ( ) : void	Clear the message log.
FlushQueuedMessages ( ) : void	Flush queued messages to the chat log.
IRCTabPage ( MainForm owningForm, string name, string text, IRCTabType type ) : System	Initialises a new instance of the IRCTabPage class.
ListEmoticons ( ) : void	Lists the supported emoticons in the tab.
LoadTheme ( string path ) : void	Load a theme into the web browser control.
RefreshTreeNodeCollapseState ( ) : void	Refreshes the collapse state of each tree node.
RemoveUserFromList ( IRCUser user ) : void	Removes a user from the user tree view.
ScrollToBottom ( ) : void	Scrolls to the bottom of the chat log.
SortByMode ( bool sortByMode ) : void	Sets the sorting mode of the user tree view.
ToggleGrouping ( ) : void	Toggles whether or not grouping is enabled.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Releases the unmanaged resources used by the System.Windows.Forms.Control and its child controls and optionally releases the managed resources.

Private Methods

Method	Description
ChangeTreeNodeState ( string name, bool collapsed ) : void	Change the collapsed state of a node in UserTreeView.
HandleCollapseAndExpansion ( TreeNode node ) : void	Update the fields that store the collapse state of the various "group nodes".
Initialise ( ) : void	Initialise the required components
InitialiseWebView ( ) : void	Initialise the WebView control
RemoveUserFromList ( IRCUser user, TreeNodeCollection nodes ) : bool	Removes a user from the user tree view.
RemoveUserFromTopLevelNodes ( IRCUser user ) : bool	Removes a user from the top level nodes in UserTreeView.
SetSplashText ( ) : void	Set the splash text that is shown at the top of a tab's browser control
SetupConsoleContent ( ) : void	Sets up the default content for the console tab.
UserTreeView_AfterCollapse ( object sender, TreeViewEventArgs e ) : void	Handles the AfterCollapse event of System.Windows.Forms.TreeView
UserTreeView_AfterExpand ( object sender, TreeViewEventArgs e ) : void	Handles the AfterExpand event of System.Windows.Forms.TreeView
WebView_PreviewKeyDown ( object sender, PreviewKeyDownEventArgs e ) : void	Handles the PreviewKeyDown event of System.Windows.Forms.WebBrowser.
WebView_PropertyChanged ( object sender, System e ) : void	Handles the PropertyChanged event of CefSharp.WinForms.WebView.

Method Details

AddUserToList() public method

Adds a user to the tree view list.

public AddUserToList ( IRCUser user ) : TreeNode
user	IRCUser	The user to add.
return	System.Windows.Forms.TreeNode

AddUserToList() public method

Adds a user to the tree view list.

public AddUserToList ( IRCUser user, bool refresh ) : void
user	IRCUser	The user to add.
refresh	bool	A value indicating whether or not to refresh the sorting.
return	void

AppendMessage() public method

Appends a message to the tab's browser control and transforms the payload accordingly to show custom font styles / colours.

public AppendMessage ( string command, string source, string payload, MessageType type ) : void
command	string	The command that invoked the call.
source	string	The source of the message.
payload	string	The message's payload.
type	MessageType	The type of message.
return	void

AppendMessage() public method

Appends a message to the tab's browser control.

public AppendMessage ( string command, string source, string payload, MessageType type, string>.Func transform ) : void
command	string	The command that invoked the call.
source	string	The source of the message.
payload	string	The message's payload.
type	MessageType	The type of message.
transform	string>.Func	A delegate that will be called to transform the payload content before appending.
return	void

ClearLog() public method

Clear the message log.

public ClearLog ( ) : void
return	void

Dispose() protected method

Releases the unmanaged resources used by the System.Windows.Forms.Control and its child controls and optionally releases the managed resources.

protected Dispose ( bool disposing ) : void
disposing	bool	true to release both managed and unmanaged resources; false to release only unmanaged resources.
return	void

FlushQueuedMessages() public method

Flush queued messages to the chat log.

public FlushQueuedMessages ( ) : void
return	void

IRCTabPage() public method

Initialises a new instance of the IRCTabPage class.

public IRCTabPage ( MainForm owningForm, string name, string text, IRCTabType type ) : System
owningForm	MainForm	The form that the tab page is displayed on.
name	string	The name of the tab page.
text	string	The text to display in the caption.
type	IRCTabType	The type of IRC entity being represented.
return	System

ListEmoticons() public method

Lists the supported emoticons in the tab.

public ListEmoticons ( ) : void
return	void

LoadTheme() public method

Load a theme into the web browser control.

public LoadTheme ( string path ) : void
path	string	The full path of the theme to load.
return	void

RefreshTreeNodeCollapseState() public method

Refreshes the collapse state of each tree node.

public RefreshTreeNodeCollapseState ( ) : void
return	void

RemoveUserFromList() public method

Removes a user from the user tree view.

public RemoveUserFromList ( IRCUser user ) : void
user	IRCUser	The user to remove.
return	void

ScrollToBottom() public method

Scrolls to the bottom of the chat log.

public ScrollToBottom ( ) : void
return	void

SortByMode() public method

Sets the sorting mode of the user tree view.

public SortByMode ( bool sortByMode ) : void
sortByMode	bool	A value indicating whether or not to sort by mode.
return	void

ToggleGrouping() public method

Toggles whether or not grouping is enabled.

public ToggleGrouping ( ) : void
return	void