~ubuntu-branches/ubuntu/edgy/kvirc/edgy

                @parameters:

                        None

                @window:

                @description:

                        This event is triggered on KVIrc startup.

                        This is a little tricky, since this event is triggered

                        before the related [event:onirccontextcreated]OnIRCContextCreated[/event] event.

                        This is to make OnApplicationStartup be the absolutely first

                @parameters:

                        None

                @window:

                @description:

                        This event is triggered on KVIrc shutdown.

                        This is a little tricky, since this event is triggered

                    immediately after the on [event:onirccontextdestroyed]OnIRCContextDestroyed[/event] event,

                        so in theory the console should be already destroyed.

                @title:

                        OnIRCContextCreated

                @short:

                @parameters:

                        None

                @window:

                @description:

                        that is the first window that is created.

                @seealso:

                        [event:onirccontextdestroyed]OnIRCContextDestroyed[/event]

                @title:

                        OnIRCContextDestroyed

                @short:

                @parameters:

                        None

                @window:

                @description:

                        that is the last window of the context that is destroyed.

                @seealso:

                        [event:onirccontextcreated]OnIRCContextCreated[/event]

                @type:

                        event

                @title:

                @short:

                @parameters:

                        None

                @window:

                @description:

                        has been established. No data has been sent to the server yet

                        and you have not logged in: it is not a good idea

                        attempting to send data to the server (READ: [b]This is NOT

                @seealso:

                        [event:onircconnectionterminated]OnIRCConnectionTerminated[/event]

        */

        /*

                @doc: onircconnectionterminated

                @type:

                @title:

                        OnIRCConnectionTerminated

                @short:

                @parameters:

                        None

                @window:

                @description:

                        has been terminated. The socket is already closed, so you

                        can't send data to the server. You can still read

                        the connection parameters like the server name or

                        network name. By calling [cmd]halt[/cmd] in this

                        event you will stop the "Connection terminated..." output.

                @seealso:

        */

        EVENT("OnIRCConnectionTerminated",""),

        /*

                @parameters:

                        None

                @window:

                @description:

                        This event is triggered immediately after the login

                        operations have been terminated. From now on you are

                        By calling [cmd]halt[/cmd] in this event you will

                        stop the "Login operations complete..." output.

                @seealso:

                        [event:onircconnectionterminated]OnIRCConnectionTerminated[/event]

        */

        EVENT("OnIRC",""),

                @title:

                        OnURL

                @short:

                @parameters:

                        $0 = URL

                @window:

                        The window that the URL appeared in

                @description:

        */

        EVENT("OnURL","$0 = URL"),

        /*

        @description:

            Triggered when someone has changed his nickname.

                        The change has already been processed by the server, but not by the

        @seealso:

            [event:onmenickchange]OnMeNickChange[/event]

    */

        @description:

            Triggered when the local user is going to change his nickname.

                        The change has already been processed by the server, but not by the

        @seealso:

            [event:onnickchange]OnNickChange[/event]

    */

            Console window

        @description:

            A CTCP request has been received.[br]

        @seealso:

            [event:onctcpreply]OnCTCPReply[/event]

    */

            Console window

        @description:

            A CTCP reply has been received.[br]

        @seealso:

            [event:onctcpreply]OnCTCPReply[/event]

    */

                @short:

                        A dcc chat window has been just created

                @parameters:

                @window:

                        DCC Chat

                @description:

                @seealso:

                        [event:ondccchatterminated]OnDCCChatTerminated[/event]

        */

        /*

                @doc: ondccchatconnectioninprogress

                @type:

                @short:

                        A DCC Chat connection has just been started

                @parameters:

                @window:

                        DCC Chat

                @description:

                        are known from the moment that this event triggers.

                @seealso:

        */

        /*

                @doc: ondccchatconnected

                @type:

                @short:

                        A DCC Chat connection has been established

                @parameters:

                @window:

                        DCC Chat

                @description:

                        window and the data transfer.

                @seealso:

        */

        /*

                @doc: ondccchatmessage

                @type:

                        A DCC Chat message has just been received

                @parameters:

                        $0 = message text

                @window:

                        DCC Chat

                @description:

                        window and the data transfer.

                @seealso:

        */

        /*

                @doc: ondccchaterror

                @type:

                        A DCC Chat error has just been triggered

                @parameters:

                        $0 = error message

                @window:

                        DCC Chat

                @description:

                        an error.

                @seealso:

        */

        /*

                @doc: ondccchatdisconnected

                @type:

                @short:

                        A DCC Chat has been just disconnected

                @parameters:

                @window:

                        DCC Chat

                @description:

                        window and the data transfer.

                @seealso:

        */

        /*

                @doc: ondccchatwindowclosing

                @type:

                @short:

                        A DCC Chat is going to be closed

                @parameters:

                @window:

                        DCC Chat

                @description:

                        window and the data transfer.

                @seealso:

        */

        /*

                @doc: onaccelkeypressed

                @type:

                        The key sequence that the user has pressed is passed in $0 as a

                        human readable string.[br]

                        The keys that actually work with KVIrc are:[br]

                        This means that you can set up 33 "quick" aliases...that's really more than

                        an user can remember.[br]

                        If you need more keys , mail me , I'll see what I can do :)[br]

                        Since the CTCP ACTION messages generally have different format of output

                        then for your convenience $6 contains 1 if the message was caused by a

                        CTCP ACTION and 0 otherwise.[br]

    */

        EVENT("OnHighlight", "$0 = source nick\n$1 = source username\n$2 = source hostname\n$3 = message\n$4 = highlight word"),

        /*

                @type:

                        event

                @title:

                @short:

                        An user in the notify list is on-line

                @parameters:

                        $0 = nickname

                @window:

                @description:

                        This event is triggered when one of the users in your [doc:notify_list]notify[/doc] lists

                        is detected to be ON-Line.[br]

                        on the user options.[br]

                        (Note: If you call [cmd]halt[/cmd] in this event , you will stop the "Nick is on irc" output,

                        but this is rather a bad idea since KVIrc gives a lot of additional informations to the

                        This is a good place to play a sound or attract the user attention in some other way.[br]

 

        */

        /*

                @doc: onnotifyoffline

                @type:

                        event

                @title:

                @short:

                        An user in the notify list went off-line

                @parameters:

                        $0 = nickname

                @window:

                @description:

                        This event is triggered when one of the users in your [doc:notify_list]notify[/doc] lists

                        has just left IRC.[br]

                        on the user options.[br]

                        (Note: If you call [cmd]halt[/cmd] in this event , you will stop the "Nick has left irc" output,

                        but this is rather a bad idea since KVIrc gives a lot of additional informations to the

                        user with some notify-methods).[br]

                        This is a good place to play a sound or attract the user attention in some other way.[br]

        */

        /*

                @doc: onpong

                @type:

                        Triggered when a new remote target has been added to a query window.

                        This is the event to catch when you want to perform some specific actions

                        when someone queries you.

                        when a new query target is added by using [cmd]addtarget[/cmd].[br]

        */

        EVENT("OnQueryTargetAdded","$0 = nick\n$1 = username (may be *)\n$2 = hostname (may be *)"),

                @short:

                        A new DCC session has just been created

                @parameters:

                @window:

                        console

                @description:

                        You can retrieve the session information by calling the [module:dcc]dcc[/module].*

                        module functions.

        */

        /*

                @doc: ondccsessiondestroyed

                @type:

                @short:

                        A new DCC session has just been destroyed

                @parameters:

                @window:

                        console

                @description:

                        Triggered when a new DCC session has just been destroyed.

                        You can retrieve the session information by calling the [module:dcc]dcc[/module].*

        */

        /*

                @doc: ontextinput

                @type:

                @short:

                        Triggered when the DCC chat text view is right-clicked

                @parameters:

                @window:

                        DCC Chat window

                @description:

                        text view with the right mouse button. It is a good place

                        to activate a [cmd]popup[/cmd] menu :)

                        You can retrieve the session information by calling the [module:dcc]dcc[/module].*

                @seealso:

                        [event:onconsolepuprequest]OnConsolePopupRequest[/event],

                        [event:onchannelpopuprequest]OnChannelPopupRequest[/event],

                        [event:onquerypopuprequest]OnQueryPopupRequest[/event]

        */

        /*

                @doc: ondccfiletransferconnectioninprogress

                @type:

                @short:

                        Triggered when a DCC File transfer is waiting for a connection

                @parameters:

                @window:

                        unspecified

                @description:

                        Triggered when a DCC File transfer has been set up and

                        Note that the real data transfer is not started until

                        [event:ondccfiletransferbegin]OnDCCFileTransferBegin[/event] is triggered

                        but from this moment on you will be notified of success

                        or failure by the means of [event:ondccfiletransfersuccess]OnDCCFileTransferSuccess[/event]

                        or [event:ondccfiletransferfailed]OnDCCFileTransferFailed[/event].[br]

                        You can retrieve the session information by calling the [module:dcc]dcc[/module].*

                @seealso:

                        [event:ondccfiletransferfailed]OnDCCFileTransferFailed[/event],

                        [event:ondccfiletransfersuccess]OnDCCFileTransferSuccess[/event],

                        [event:ondccfiletransferbegin]OnDCCFileTransferBegin[/event]

        */

        /*

                @doc: ondccfiletransferbegin

                @type:

                @short:

                        Triggered when a DCC File transfer begins

                @parameters:

                @window:

                        unspecified

                @description:

                        and the real data transfer starts.[br]

                        You can retrieve the session information by calling the [module:dcc]dcc[/module].*

                @seealso:

                        [event:ondccfiletransferconnectioninprogress]OnDCCFileTransferConnectionInProgress[/event],

                        [event:ondccfiletransfersuccess]OnDCCFileTransferSuccess[/event],

                        [event:ondccfiletransferfailed]OnDCCFileTransferFailed[/event]

        */

        /*

                @doc: ondccfiletransfersuccess

                @type:

                        Triggered when a DCC File transfer succeeds

                @parameters:

                        $0 = bytes transferred

                @window:

                        unspecified

                @description:

                        Triggered when a DCC File transfer terminates succesfully.[br]

                        $0 contains the number of bytes transferred in the session.[br]

                        You can retrieve the session information by calling the [module:dcc]dcc[/module].*

                @seealso:

                        [event:ondccfiletransferconnectioninprogress]OnDCCFileTransferConnectionInProgress[/event],

                        [event:ondccfiletransferfailed]OnDCCFileTransferFailed[/event],

                        [event:ondccfiletransferbegin]OnDCCFileTransferBegin[/event]

        */

        /*

                @doc: ondccfiletransferfailed

                @type:

                @short:

                        Triggered when a DCC File transfer fails

                @parameters:

                        $1 = bytes transferred

                @window:

                        unspecified

                @description:

                        explaining the reason of the failure.[br]

                        $1 contains the number of bytes transferred in the session, eventually 0.[br]

                        You can retrieve the session information by calling the [module:dcc]dcc[/module].*

                @seealso:

                        [event:ondccfiletransferconnectioninprogress]OnDCCFileTransferConnectionInProgress[/event],

                        [event:ondccfiletransfersuccess]OnDCCFileTransferSuccess[/event],

                        [event:ondccfiletransferbegin]OnDCCFileTransferBegin[/event]

        */

        /*

                @doc: onwallops

                @type:

                        Triggered when user clicks on server name in any window

                        It will be triggered only at the left mouse button click

        */

};