Custom Windows (@windows)

The /window command creates generic text windows - an area with individually colorable text lines, plus an optional side list box and an optional input box at the bottom. Handy for showing script output, logs, listings, or small text interfaces. A practical subset of the official mIRC documentation, with omissions explicitly noted below.

Creating a window

/window [-switch] [-tN,..,N] [+style] <@name> [x y w h]
   [/command | [popup.txt] [font [size]] [iconfile]]

@name must start with @. x y w h are optional (without them, the window is centered with a default size). After x y w h comes EITHER a /command (run every time the user types text in the editbox and presses Enter - the typed text arrives as if it had been written right after the command, so as $1- if it's an alias), OR alternatively popup.txt/font [size]/iconfile: these are mutually exclusive here (not combinable in the same call like in real mIRC) so a command name can be reliably told apart from a file name, with no ambiguity.

window -e1l15 @log 50 50 400 300
aline @log Window ready.

/window switches

-tN,..,N switch (separate from the rest, with a space before it): sets the side list box's tab stops, in characters - a line's text containing tabs (\t) is placed starting at those positions. -t0 hides the text before the first tab.

Appearance styles (+ prefix, e.g. /window +tnx @name ...): t shows the title bar, n shows the minimize button, x shows the maximize button, d removes the border.

Text lines

/aline [c] <@name> <text>      appends a line at the end
/cline [c] <@name> <N>          changes line N's color
/dline <@name> <N[-N2]>          deletes line N (or N to N2)
/iline [c] <@name> <N> <text>   inserts at line N
/rline [c] <@name> <N> <text>   replaces line N
/sline <@name> <N>               selects line N

c (optional, right after the switch) is a 0-15 color number (same classic IRC palette). All of these commands accept -l to operate on the side list box instead of the main text. /aline//iline also accept -n (don't add if the text already exists), -i[N] (indents by N spaces, 2 by default), -s/-a (select the just-added/inserted line). /cline -r resets the line to the default color.

aline @log Connection established
aline 3 @log Warning: timeout
cline 9 @log 1
dline @log 2

/renwin

/renwin <@oldname> <@newname> [topic]

Renames an already-open window. The topic parameter (an extra context argument in real mIRC) is accepted but ignored: here a @window has no real "topic".

$window(N/@name)[.property]

Supported properties: x, y, cx, cy (identical to x/y here - we don't manage a real multi-monitor distinction), w, h, dw, dh (size of the text area or canvas), mdi, title, fulltitle, state (normal/hidden/maximized), font, fontsize, fontbold, fontitalic, ontop, type (custom or picture), wid, hwnd, lb (0 = no list box, 1 = present), pbstate/ pbpercent (progress bar state/percentage, see /window -q above).

$line(@name,N[,T])[.property]

Optional T: 1 to refer to the side list box instead of the main text (like -l in the commands above). N=0 returns the number of lines.

$line(@log,3)          ; text of line 3
$line(@log,0)          ; how many lines there are
$line(@log,3).color    ; color number of line 3 (empty if none)
$line(@log,3).state    ; 1/0 depending on whether it's the selected line
$line(@log,2,1)        ; line 2 of the side list box

$fline(@name,text,N,T,S)

Finds the position of the Nth line matching text (wildcard by default, T=2 or T=3 for a regular expression; T=1 operates on the list box). N=0 returns the number of matching lines. S sets where to start the search. The found position also stays in $flinen (bare identifier).

popup.txt and iconfile

popup.txt (positional parameter of /window, must end in .txt) loads a right-click menu for the window from a plain text file - same Label:command syntax used in popups.ini, without the [...] sections. iconfile (must have an image extension: ico/png/jpg/jpeg/bmp/gif) sets the titlebar icon - the N index (for files with multiple icons, typical of Windows .ico/.exe) is not supported, ignored.

window @log 50 50 400 300 mypopup.txt "Courier New" 12
window @log 50 50 400 300 icon.png

Picture Windows (/window -p)

A picture window is a @window with a drawing area (<canvas>) instead of text. You draw on it with the /draw* commands, and mouse clicks/movements can be intercepted.

window -p @canvas 50 50 300 200
drawrect -f @canvas 4 1 10 10 100 60
drawtext @canvas 1 Arial 14 20 20 Hi!

Colors in /draw* commands

Without the -r switch, <color> is a 0-15 index into the same classic palette used by /aline etc. With -r, it's a "packed" RGB value like the one returned by $rgb(r,g,b) (R + G×256 + B×65536 format, the same one real mIRC uses internally).

Drawing commands

Mouse events

Real mIRC defines them inside a menu @name { mouse:/command sclick:/command ... } block. Here, for consistency with the rest of the scripting engine (same structure as on dialog events), you use instead:

on 1:mouse:@name:event: {
  echo $mouse.x $mouse.y
}

Picture Windows identifiers

What is NOT supported