# $fmtsocket

Returns a formatted socket buffer

Syntax

    $fmtsocket(<socket_text>,<double_click_command>[,<tooltip_text>])

Description

Returns a socket formatted for the echo command.
If you pass the returned string to the echo command, the string will be displayed as a socket and will be highlighted when the user moves the mouse over it.
If the user will leave the mouse for a few seconds over the socket, the <tooltip_text> will be displayed in a small tooltip window. If <tooltip_text> is not given, then no tooltip will be shown.
The <double_click_command> will be executed when the user will double click on the socket.
Please remember that if <double_click_command> contains identifiers that must be evaluated at double-click time, you MUST escape them in the $fmtsocket() call to prevent the evaluation.
You might also take a look at the escape sequences documentation to learn more about how the sockets are implemented and how to create more powerful sockets (add right and middle button actions, use predefined kvirc sockets etc...)

See also
the escape sequences documentation

Index, Functions

KVIrc 3.2.0 Documentation
Generated by kris at Wed Oct 25 20:15:27 2006