eric7.Network.IRC.IrcNetworkManager

Module implementing the IRC data structures and their manager.

Global Attributes

None

Classes

IrcChannel Class implementing the IRC channel object.
IrcIdentity Class implementing the IRC identity object.
IrcNetwork Class implementing the IRC network object.
IrcNetworkManager Class implementing the IRC identity object.
IrcServer Class implementing the IRC identity object.

Functions

None


IrcChannel

Class implementing the IRC channel object.

Derived from

None

Class Attributes

None

Class Methods

None

Methods

IrcChannel Constructor
autoJoin Public method to check the auto join status.
getKey Public method to get the channel key.
getName Public method to get the channel name.
load Public method to load the network data.
save Public method to save the channel data.
setAutoJoin Public method to set the auto join status of the channel.
setKey Public method to set a new channel key.

Static Methods

None

IrcChannel (Constructor)

IrcChannel(name)

Constructor

name (str)
name of the network

IrcChannel.autoJoin

autoJoin()

Public method to check the auto join status.

Return:
flag indicating if the channel should be joined automatically
Return Type:
bool

IrcChannel.getKey

getKey()

Public method to get the channel key.

Return:
channel key
Return Type:
str

IrcChannel.getName

getName()

Public method to get the channel name.

Return:
channel name
Return Type:
str

IrcChannel.load

load(settings)

Public method to load the network data.

settings (QSettings)
reference to the settings object

IrcChannel.save

save(settings)

Public method to save the channel data.

settings (QSettings)
reference to the settings object

IrcChannel.setAutoJoin

setAutoJoin(enable)

Public method to set the auto join status of the channel.

enable (bool)
flag indicating if the channel should be joined automatically

IrcChannel.setKey

setKey(key)

Public method to set a new channel key.

key (str)
channel key to set
Up


IrcIdentity

Class implementing the IRC identity object.

Derived from

None

Class Attributes

DefaultAwayMessage
DefaultIdentityDisplay
DefaultIdentityName
DefaultPartMessage
DefaultQuitMessage

Class Methods

createDefaultIdentity Class method to create the default identity.

Methods

IrcIdentity Constructor
getAwayMessage Public method to get the AWAY message.
getIdent Public method to get the real identity name.
getName Public method to get the identity name.
getNickNames Public method to get the nick names.
getPartMessage Public method to get the PART message.
getPassword Public method to get the password.
getQuitMessage Public method to get the QUIT message.
getRealName Public method to get the real name.
getServiceName Public method to get the service name of the identity used for identification.
load Public method to load the identity data.
rememberAwayPosition Public method to get a flag indicating to remember the chat position upon AWAY.
save Public method to save the identity data.
setAwayMessage Public method to set the AWAY message.
setIdent Public method to set the real identity name.
setName Public method to set the identity name.
setNickNames Public method to set the nick names of the identity.
setPartMessage Public method to set the PART message.
setPassword Public method to set a new password.
setQuitMessage Public method to set the QUIT message.
setRealName Public method to set the real name of the identity.
setRememberAwayPosition Public method to set to remember the chat position upon AWAY.
setServiceName Public method to set the service name of the identity used for identification.

Static Methods

None

IrcIdentity.createDefaultIdentity (class method)

createDefaultIdentity()

Class method to create the default identity.

Return:
default identity
Return Type:
IrcIdentity

IrcIdentity (Constructor)

IrcIdentity(name)

Constructor

name (str)
name of the identity

IrcIdentity.getAwayMessage

getAwayMessage()

Public method to get the AWAY message.

Return:
AWAY message
Return Type:
str

IrcIdentity.getIdent

getIdent()

Public method to get the real identity name.

Return:
real identity name
Return Type:
str

IrcIdentity.getName

getName()

Public method to get the identity name.

Return:
identity name
Return Type:
str

IrcIdentity.getNickNames

getNickNames()

Public method to get the nick names.

Return:
nick names
Return Type:
list of str

IrcIdentity.getPartMessage

getPartMessage()

Public method to get the PART message.

Return:
PART message
Return Type:
str

IrcIdentity.getPassword

getPassword()

Public method to get the password.

Return:
password
Return Type:
str

IrcIdentity.getQuitMessage

getQuitMessage()

Public method to get the QUIT message.

Return:
QUIT message
Return Type:
str

IrcIdentity.getRealName

getRealName()

Public method to get the real name.

Return:
real name
Return Type:
str

IrcIdentity.getServiceName

getServiceName()

Public method to get the service name of the identity used for identification.

Return:
service name
Return Type:
str

IrcIdentity.load

load(settings)

Public method to load the identity data.

settings (QSettings)
reference to the settings object

IrcIdentity.rememberAwayPosition

rememberAwayPosition()

Public method to get a flag indicating to remember the chat position upon AWAY.

Return:
flag indicating to remember the chat position
Return Type:
bool

IrcIdentity.save

save(settings)

Public method to save the identity data.

settings (QSettings)
reference to the settings object

IrcIdentity.setAwayMessage

setAwayMessage(message)

Public method to set the AWAY message.

message (str)
AWAY message

IrcIdentity.setIdent

setIdent(name)

Public method to set the real identity name.

name (str)
real identity name

IrcIdentity.setName

setName(name)

Public method to set the identity name.

name (str)
identity name

IrcIdentity.setNickNames

setNickNames(names)

Public method to set the nick names of the identity.

names (list of str)
nick names

IrcIdentity.setPartMessage

setPartMessage(message)

Public method to set the PART message.

message (str)
PART message

IrcIdentity.setPassword

setPassword(password)

Public method to set a new password.

password (str)
password to set

IrcIdentity.setQuitMessage

setQuitMessage(message)

Public method to set the QUIT message.

message (str)
QUIT message

IrcIdentity.setRealName

setRealName(name)

Public method to set the real name of the identity.

name (str)
real name

IrcIdentity.setRememberAwayPosition

setRememberAwayPosition(remember)

Public method to set to remember the chat position upon AWAY.

remember (bool)
flag indicating to remember the chat position

IrcIdentity.setServiceName

setServiceName(name)

Public method to set the service name of the identity used for identification.

name (str)
service name
Up


IrcNetwork

Class implementing the IRC network object.

Derived from

None

Class Attributes

None

Class Methods

createDefaultNetwork Class method to create the default network.

Methods

IrcNetwork Constructor
addChannel Public method to add a channel.
autoConnect Public method to check, if the network should be connected to at start-up.
deleteChannel Public method to delete the given channel.
getChannel Public method to get a channel.
getChannelNames Public method to get the list of channels.
getChannels Public method to get the channels.
getIdentityName Public method to get the name of the identity.
getName Public method to get the network name.
getServer Public method to get the server object.
getServerName Public method to get the server name.
load Public method to load the network data.
save Public method to save the network data.
setAutoConnect Public method to set the auto connect flag.
setChannel Public method to set a channel.
setChannels Public method to set the list of channels.
setIdentityName Public method to set the name of the identity.
setName Public method to set the network name.
setServer Public method to set the server.

Static Methods

None

IrcNetwork.createDefaultNetwork (class method)

createDefaultNetwork(ssl=False)

Class method to create the default network.

ssl (bool)
flag indicating to create a SSL network configuration
Return:
default network object
Return Type:
IrcNetwork

IrcNetwork (Constructor)

IrcNetwork(name)

Constructor

name (str)
name of the network

IrcNetwork.addChannel

addChannel(channel)

Public method to add a channel.

channel (IrcChannel)
channel object to add

IrcNetwork.autoConnect

autoConnect()

Public method to check, if the network should be connected to at start-up.

Return:
flag indicating an auto connect
Return Type:
bool

IrcNetwork.deleteChannel

deleteChannel(channelName)

Public method to delete the given channel.

channelName (str)
name of the channel to be deleted

IrcNetwork.getChannel

getChannel(channelName)

Public method to get a channel.

channelName (str)
name of the channel to retrieve
Return:
reference to the channel
Return Type:
IrcChannel

IrcNetwork.getChannelNames

getChannelNames()

Public method to get the list of channels.

Return:
list of channel names
Return Type:
list of str

IrcNetwork.getChannels

getChannels()

Public method to get the channels.

Return:
list of channels for the network
Return Type:
list of IrcChannel

IrcNetwork.getIdentityName

getIdentityName()

Public method to get the name of the identity.

Return:
identity name
Return Type:
str

IrcNetwork.getName

getName()

Public method to get the network name.

Return:
network name
Return Type:
str

IrcNetwork.getServer

getServer()

Public method to get the server object.

Return:
reference to the server
Return Type:
IrcServer

IrcNetwork.getServerName

getServerName()

Public method to get the server name.

Return:
server name
Return Type:
str

IrcNetwork.load

load(settings)

Public method to load the network data.

settings (QSettings)
reference to the settings object

IrcNetwork.save

save(settings)

Public method to save the network data.

settings (QSettings)
reference to the settings object

IrcNetwork.setAutoConnect

setAutoConnect(enable)

Public method to set the auto connect flag.

enable (bool)
flag indicate to connect to the network at start-up

IrcNetwork.setChannel

setChannel(channel)

Public method to set a channel.

channel (IrcChannel)
channel object to set

IrcNetwork.setChannels

setChannels(channels)

Public method to set the list of channels.

channels (list of IrcChannel)
list of channels for the network

IrcNetwork.setIdentityName

setIdentityName(name)

Public method to set the name of the identity.

name (str)
identity name

IrcNetwork.setName

setName(name)

Public method to set the network name.

name (str)
network name

IrcNetwork.setServer

setServer(server)

Public method to set the server.

server (IrcServer)
server object to set
Up


IrcNetworkManager

Class implementing the IRC identity object.

Signals

dataChanged()
emitted after some data has changed
identitiesChanged()
emitted after an identity object has changed
networksChanged()
emitted after a network object has changed

Derived from

QObject

Class Attributes

None

Class Methods

None

Methods

IrcNetworkManager Constructor
__load Private slot to load the IRC data.
__loadDefaults Private method to load default values.
addIdentity Public method to add a new identity.
addNetwork Public method to add a network.
close Public method to close the open search engines manager.
deleteIdentity Public method to delete the given identity.
deleteNetwork Public method to delete the given network.
getIdentities Public method to get a copy of all identities.
getIdentity Public method to get an identity object.
getIdentityNames Public method to get the names of all identities.
getNetwork Public method to get a network object.
getNetworkNames Public method to get a list of all known network names.
identityChanged Public method to indicate a change of an identity object.
networkChanged Public method to indicate a change of a network object.
renameIdentity Public method to rename an identity.
save Public slot to save the IRC data.
setIdentities Public method to set the identities.
setNetwork Public method to set a network.

Static Methods

None

IrcNetworkManager (Constructor)

IrcNetworkManager(parent=None)

Constructor

parent (QObject)
reference to the parent object

IrcNetworkManager.__load

__load()

Private slot to load the IRC data.

IrcNetworkManager.__loadDefaults

__loadDefaults(identityOnly=False)

Private method to load default values.

identityOnly (bool)
flag indicating to just load the default identity

IrcNetworkManager.addIdentity

addIdentity(identity)

Public method to add a new identity.

identity (IrcIdentity)
reference to the identity to add

IrcNetworkManager.addNetwork

addNetwork(network)

Public method to add a network.

network (IrcNetwork)
network object to add

IrcNetworkManager.close

close()

Public method to close the open search engines manager.

IrcNetworkManager.deleteIdentity

deleteIdentity(name)

Public method to delete the given identity.

name (str)
name of the identity to delete

IrcNetworkManager.deleteNetwork

deleteNetwork(name)

Public method to delete the given network.

name (str)
name of the network to delete

IrcNetworkManager.getIdentities

getIdentities()

Public method to get a copy of all identities.

Return:
dictionary of all identities
Return Type:
dict of IrcIdentity

IrcNetworkManager.getIdentity

getIdentity(name, create=False)

Public method to get an identity object.

name (str)
name of the identity to get
create (bool)
flag indicating to create a new object, if none exists
Return:
reference to the identity
Return Type:
IrcIdentity

IrcNetworkManager.getIdentityNames

getIdentityNames()

Public method to get the names of all identities.

Return:
names of all identities
Return Type:
list of string)

IrcNetworkManager.getNetwork

getNetwork(name)

Public method to get a network object.

name (str)
name of the network
Return:
reference to the network object
Return Type:
IrcNetwork

IrcNetworkManager.getNetworkNames

getNetworkNames()

Public method to get a list of all known network names.

Return:
list of network names
Return Type:
list of str

IrcNetworkManager.identityChanged

identityChanged()

Public method to indicate a change of an identity object.

IrcNetworkManager.networkChanged

networkChanged()

Public method to indicate a change of a network object.

IrcNetworkManager.renameIdentity

renameIdentity(oldName, newName)

Public method to rename an identity.

oldName (str)
old name of the identity
newName (str)
new name of the identity

IrcNetworkManager.save

save()

Public slot to save the IRC data.

IrcNetworkManager.setIdentities

setIdentities(identities)

Public method to set the identities.

identities (dict of IrcIdentity)
dictionary of all identities

IrcNetworkManager.setNetwork

setNetwork(network, networkName="")

Public method to set a network.

network (IrcNetwork)
network object to set
networkName (str)
name the network was known for
Up


IrcServer

Class implementing the IRC identity object.

Derived from

None

Class Attributes

DefaultPort
DefaultSslPort

Class Methods

None

Methods

IrcServer Constructor
getName Public method to get the server name.
getPassword Public method to get the password.
getPort Public method to get the server port number.
load Public method to load the server data.
save Public method to save the server data.
setName Public method to set the server name.
setPassword Public method to set a new password.
setPort Public method to set the server port number.
setUseSSL Public method to set the SSL usage.
useSSL Public method to check for SSL usage.

Static Methods

None

IrcServer (Constructor)

IrcServer(name)

Constructor

name (str)
name of the server

IrcServer.getName

getName()

Public method to get the server name.

Return:
server name
Return Type:
str

IrcServer.getPassword

getPassword()

Public method to get the password.

Return:
password
Return Type:
str

IrcServer.getPort

getPort()

Public method to get the server port number.

Return:
port number
Return Type:
int

IrcServer.load

load(settings)

Public method to load the server data.

settings (QSettings)
reference to the settings object

IrcServer.save

save(settings)

Public method to save the server data.

settings (QSettings)
reference to the settings object

IrcServer.setName

setName(name)

Public method to set the server name.

name (str)
server name

IrcServer.setPassword

setPassword(password)

Public method to set a new password.

password (str)
password to set

IrcServer.setPort

setPort(port)

Public method to set the server port number.

port (int)
server port number

IrcServer.setUseSSL

setUseSSL(on)

Public method to set the SSL usage.

on (bool)
flag indicating SSL usage

IrcServer.useSSL

useSSL()

Public method to check for SSL usage.

Return:
flag indicating SSL usage
Return Type:
bool
Up