# $fmtlink

Returns a formatted link buffer

Usage

    $fmtlink(<link_text>,<double_click_command>[,<tooltip_text>])

Description

Returns a link formatted for the echo command.
If you pass the returned string to the echo command, the string will be displayed as a link and will be highlighted when the user moves the mouse over it.
If the user leaves the mouse for a few seconds over the link, 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 link.
Please remember that if <double_click_command> contains identifiers that must be evaluated at double-click time, you MUST escape them in the $fmtlink() call to prevent the evaluation.
You might also take a look at the escape sequences documentation to learn more about how the links are implemented and how to create more powerful links (add right and middle button actions, use predefined kvirc links etc...). Also take a look at $link which has related functionality.

Syntax Specification

    <string> $fmtlink(<link_text:string>,<double_click_command:string>[,<tooltip_text:string>])

See also
echo, the escape sequences documentation, $link

Index, Functions

KVIrc 4.2.0.6190 Documentation
Generated by root at Mon Sep 23 13:56:02 2013