Class hierachy

 

[r/o] = Read Only.

 

 

Index

Class application : application class, ircle prefs

 

This class contains the following subclasses:

window
channel
connection
argument
color
friend
shortcut
button
sound
nickbuffer

Properties of this class are:

*Application*

frontmost boolean [r/o] -- Is this the frontmost application?

name international text [r/o] -- the name of the application

version string [r/o] -- the version of the application

argstring string -- all script arguments

currenttarget reference -- description of the current target (channel "x" of connection y)

currentconnection small integer -- the number of the current connection

currentchannel string -- the name of the current channel

myhostname string [r/o] -- My hostname

myipnumber string [r/o] -- my ip number

frontmost boolean [r/o] -- Is this the frontmost application?

clipboard list of anything -- the contents of the clipboard for this application

 

*Ircle Preferences*

 

- Color

filtercolor boolean -- filter color messages

Color has it's own class as well.

 

- Sound

soundwithquery boolean -- private msg sound in query

speechinsteadofsounds boolean -- use spoken text instead of ircle sounds

 

- Speech

usespeech boolean -- use speech when installed

speakalltext boolean -- speak all channel text

speaknick boolean -- speak only text with my nick

speechvoice string -- speech voice

speechrate integer -- speech rate

speechpitch integer -- speech pitch

 

- Text

ircii boolean -- ircii text layout

showmotd boolean -- show motd

texttranlation integer -- text translation

japanese boolean -- japanese

chinese boolean -- chinese text

 

- DCC

autodccchat boolean -- auto accept dcc chat

autodccget boolean -- auto dcc get

autodccsave boolean -- auto dcc save

autodccresume boolean -- auto dcc resume

dccgetfolder file specification -- dcc receive folder

fservefolder file specification -- fserve folder

tia boolean -- tia connection

tiaip string -- tia ip number

dccblocksize integer -- dcc send block size (in bytes)

dccprotocol integer -- dcc send protocol, 0=text, 1=binary, 2=macbinary

fserve boolean -- fserve on/off

 

- CTCP

ctcp_off boolean -- ctcp on/off

soundfolder file specification -- ctcp sound folder

acceptctcp boolean -- accept ctcp requests

showctcp boolean -- show ctcp requests

floodprotection boolean -- ctcp flood protection

ctcpsound boolean -- ctcp sound

noquicktime boolean -- dont use quicktime

mediaplayer file specification -- the mediaplayer

 

- Faces

handlefacegets boolean -- handle face get

facefile file specification -- face file

 

- Buttons

The buttons have their own class.

 

- Friends

The Friendslist has it's own class

 

- Scripts

scriptfolder file specification -- script folder

startupscript file specification -- startup script

friendskickmsg string -- friends kick message

clonekickmsg string -- clone kick msg

protectionkickmsg string -- prot deop kick

 

- Misc.

indent boolean -- indent text

showendof boolean -- show /end of messages

serverprefix string -- server message prefix

timestamp boolean -- time stamp messages

timestampaway boolean -- time stamp only when away

escclear boolean -- escape key clear inputline

showjoin boolean -- show join messages

showleave boolean -- show leave

showkick boolean -- show kick messages

showmode boolean -- show mode changes

autoreconnect boolean -- auto reconnect

closewindows boolean -- close channel windows when server connection

extendedwhois boolean -- extended whois

enumerate boolean -- enumerate users in userlist

optionscroll boolean -- option up/down to scroll through text history buffer

autorejoinafterkick boolean -- auto rejoin channel after kick

autojoinafterinvite boolean -- auto join channel after invite

showhostnameinmsg boolean -- show hostname in incoming notice/privmsg

maxclones integer -- max # of clones on a channel

autodeopserverops boolean -- auto deop users gettings ops from servers (after a netsplit for instance)

servernoticetoconsole boolean -- Server notices to console

allnoticestoconsole boolean -- all notices to console

wallopstoconsole boolean -- wallops to console instead of front window

privmsgstoconsole boolean -- private messages to console instead of front window

showicmp boolean -- show icmp requests

 

- Logging

autologging boolean -- auto logging

logfolder file specification -- log folder

logperday boolean -- make logs in subfolders for every day

logappend boolean -- append to existing logfiles

 

 

Index

Class argument : the arguments with which the script is called

 

This class is a subclass from the Application class

 

Index

 

Class ban : channel banlist

Plural form:

bans

Properties of this class are:

banmask string [r/o] -- banmask

bannumber integer [r/o] -- the item # of this ban

bantime date [r/o] -- the time the ban was set

banby string [r/o] -- nick/server that set the ban

 

This class gives you access to the channels banlist. This class is a subclass of the Channel class.

 

Index

 

Class button : buttons (userlist)

Properties of this class are:

title string -- button title

command integer -- command # (see table)

 

#		Action	Group	#		Action	Group
1		op	---	26		ping	|
2		deop	|	27		sound	|
3		kick	|	28		cping	|
4		ban	|	29		userprofile	|
5		bankick	channel modes	30		ctcp toggle	---
6		+ voice	|	31		query	---
7		- voice	|	32		whois	|
8		unban	---	33		msg	|
9		(spare)		34		join	|
10		(spare)		35		lusers	|
11		dcc chat	---	36		notice	General
12		dcc send	|	37		omsg	|
13		dcc get	|	38		onotice	|
14		dcc close	|	39		oper	|
15		xdcc list	|	40		kill	---
16		send audiostream	DCC Options	41		face get	---
17		get audiostream	|	42		mass op	|
18		fserve	|	43		mass deop	|
19		send videostream	|	44		mass unban	|
20		get videostream	---	45		invite	|
21		finger	---	46		ignore	Misc.
22		version	|	47		friends	|
23		time	|	48		DNS	|
24		userinfo	|	49		wallops	|
25		clientinfo	CTCP	50		gestalt	---

 

This class is a subclass from the Application class

 

Index

 

Class channel : channel (query, dcc chat) class

 

This class is a subclass from the Application class

 

This class contains the following subclasses:

user
ban

 

Properties of this class are:

name string [r/o] -- channel name

topic string [r/o] -- channel topic

notopicchange boolean [r/o] -- mode +t

nomessages boolean [r/o] -- no messages from outside (+n)

invite boolean [r/o] -- invite only channel (+i)

private boolean [r/o] -- private channel (+p)

secret boolean [r/o] -- secret channel (+s)

moderated boolean [r/o] -- is a moderated channel (+m)

limited boolean [r/o] -- Has a limit on the number of users (+l)

maxusers integer [r/o] -- maximum number of users

key boolean [r/o] -- channel key/password enabled (+k)

password string [r/o] -- channel password

numberofusers integer [r/o] -- number of users

connectionnumber integer [r/o] -- the number of the associated server connection (1..10)

topicsetby string [r/o] -- nick that made the topic change

topicdate date [r/o] -- date of topic change

logging boolean -- channel is being logged

lastjoiner string [r/o] -- the nick that last joined the channel

logfile file specification -- the logfile

showjoin boolean -- show join

showleave boolean -- show leave

showkick boolean -- show kicks

showmode boolean -- show mode changes

 

Index

 

Class color : color

 

This class is a subclass of the Application class.

 

Index

 

Class connection : connection object

 

This class is a subclass from the Application class

 

This class contains the following subclasses:

channel

 

Properties of this class are:

servername string -- Server name

nickname string -- Nick

status offline/namelookup/opening/connected/userclose/serverclose [r/o] -- Connection Status

away boolean -- is away

ircop boolean [r/o] -- is ircop (has usermode +O)

wallops boolean -- receive WALLOPS (usermode +w setting at login)

servermsgs boolean -- receive server messages (usermode +s at login)

invisible boolean -- invisible (usermode +i setting at login)

whoistext string -- whois info text

autoexec string -- autoexecute commands

username string -- username

fingertext string -- ctcp fingertext

userinfotext string -- ctcp userinfotext

ipnumber string [r/o] -- the ip number that we are connected to

connectiontype normal/dccchat/dccsend/dccget/sendface/getface/sendvideo/getvideo/sendvideostream/getvideostream/fserve [r/o] -- type of the connection

filename file specification [r/o] -- the filename of the file that we are sending/receiving (DCC only)

starttime date [r/o] -- the time this connection was opened

idletime integer [r/o] -- idle time of this connection (in seconds)

filesize integer [r/o] -- total size (data+rsrc fork + optional macbinary header) of file sent/received by DCC

bytesdone integer [r/o] -- bytes sent/received so far

fservedirectory file specification -- the current directory of this fserve (DCC Chat with fserve only)

 

Index

 

Class friend : friendslist

 

This class is a subclass from the Application class

 

Properties of this class are:

mask string -- mask (with wildcards..)

level integer -- friends level (raw)

autoop boolean -- give op

autodeop boolean -- auto deop

autovoice boolean -- auto voice (mode +v)

ban boolean -- ban

ignore boolean -- ignore

opprotect boolean -- protect against opping

deopprotect boolean -- protect against deopping

kick boolean -- kick

 

Index

 

Class nickbuffer : the history buffer of nick/connections that recently sent a msg or a notice to the user.

 

This class is a subclass from the Application class

 

Properties of this class are:

nickname string -- the nickname

nickconnection integer -- the connection number associated with this nick

lastmsg date -- the last time this nick was sent a msg

 

Index

 

Class shortcut : shortcut

 

This class is a subclass from the Application class

 

 

Index 

 

Class sound : custom sounds (sound prefs)

 

This class is a subclass from the Application class

 

Properties of this class are:

soundfile file specification -- the custom sound filespec

soundreplace boolean -- replace the normal sound with the soundfile filespec

soundswitch boolean -- if this is true and soundreplace = true then 'soundfile' will be played.

if this is off no sound is played at all

 

Index

 

Class user : user record

 

This class is a subclass from the Application class

 

Properties of this class are:

nickname string -- User's nickname

usernumber integer [r/o] -- the number of this user

username string -- Username (with ~ if not idented)

hostname string [r/o] -- hostname or ip number

op boolean [r/o] -- Is channel operator

voice boolean [r/o] -- may speak on channel (+v)

ircop boolean [r/o] -- is an IRC operator

away boolean [r/o] -- is away

selected boolean -- the user is selected in the userlist window

jointime date [r/o] -- the time when nick joined the channel

friend boolean [r/o] -- is a friend

nickuserhost string [r/o] -- nick!user@hostname

userhost string [r/o] -- user@hostname

 

Index

 

Class window : window (this includes the floating windows and channel windows)

 

This class is a subclass from the Application class

 

Index

Properties of this class are:

title string -- title of window

visible boolean -- is the window visible

bounds bounding rectangle -- boundsrect

floating boolean [r/o] -- is the window a floater

collapsed boolean -- is the window collapsed (OS 8)

zoomed boolean -- is the window zoomed

windowtext string [r/o] -- the window text

selectedtext string [r/o] -- the selected text

windowtype console/channel/dccchat/query/user/floater [r/o]