Project

General

Profile

$window » History » Revision 22

Revision 21 (Per Amundsen, 09/26/2016 04:14 PM) → Revision 22/58 (Per Amundsen, 11/24/2016 03:57 PM)

_Added in 1.9.0_ 

 *$window(N/@name/@wildcard, M)* 

 Returns properties for a window. 

 *Parameters* 

 N/@name/@wildcard - Name of the window or the Nth window. (@wildcard is also possible if M is defined) 
 M - The Nth @wildcard match. (optional) 

 If N is -1, returns properties for the desktop area. 
 If N is -2, returns properties for the AdiIRC main window. 
 If N is -3, returns properties for the MDI client area of the main window. 

 *Properties* 

 .x - Horizontal position of the window relative to the mainform. 
 .y - Vertical position of the window relative to the mainform.  
 .w - Window width. 
 .h - Window height.  
 .dx - Horizontal position of the window relative to the desktop. 
 .dy - Vertical position of the window relative to the desktop. 
 .dw - Width of the text display area. 
 .dh - Height of the text display area.  
 .bw - Width of the bitmap for a picture window. 
 .bh - Height of the bitmap for a picture window.  
 .mdi - [[$true]] if the window is a MDI window/docked, otherwise [[$false]] 
 .title - The text of the window Titlebar. 
 .state - minimized/maximized/hidden/normal. 
 .font - Name of the current font. 
 .fontsize - Size of the current font.  
 .fontbold - [[$true]] if the font is bold, otherwise [[$false]]. 
 .fontitalic - [[$true]] if the font is italic, otherwise [[$false]].  
 .fontunderline - [[$true]] if the font is underline, otherwise [[$false]].  
 .fontcs - returns the character set of the current font. 
 .logfile - Name of logfile if one is open for the window. 
 .historyfile - Name of the file Editbox history will be saved to. (AdiIRC only) 
 .iconfile - Name of the icon file used for a custom icon. (AdiIRC only) 
 .backgroundfile - Name of the background file used for a custom background. (AdiIRC only) 
 .stamp - [[$true]] if timestamp is on for this window, otherwise [[$false]]. 
 .icon - [[$true]] if icon is visible in Switchbar otherwise [[$false]]. 
 .ontop - [[$true]] if window is on top otherwise [[$false]]. 
 .type - Window type, channel/status/query/custom/chat/tool/panel. 
 .anysc - [[$true]] if the window was created with the [[/window]] -i parameter, otherwise [[$false]]. 
 .wid - Window id. 
 .cid - Connection id. 
 .hwnd - Window handle. 
 .sbtext - Switchbar button text for this window. 
 .sbcolor - Switchbar color event event/message/highlight for this window. 
 .sbstate - Switchbar button state (1 = visible, 2 = not visible) for this window. 
 .tbtext - Treebar text for this window. 
 .tbstate - Treebar state (1 = visible, 0 = not visible) for this window. 
 .lb - Nicklist state (2 = visible, 0 = not visible) for this window. 
 .topicbox - Topicbox state (2 = Show sticky, 1 = show, 2 = off) for this window. 
 .idle - idle state. 
 .isbottom - [[$true]] if the textarea is scrolled to the bottom, otherwise [[$false]]. (AdiIRC only) 
 .unread - Returns number of unread messages. (this include system messages, use .sbcolor to check the type, AdiIRC only) 
 .layer - Returns the window [[/setlayer|layer]]. (AdiIRC only)