Project

General

Profile

$window » History » Revision 56

Revision 55 (Per Amundsen, 09/11/2022 10:44 PM) → Revision 56/58 (Per Amundsen, 09/11/2022 10:44 PM)

{{css 
 .ktable{width:99%}.ktable td{border-bottom:none!important;border-top:none!important}.ktable th:nth-child(1){min-width:130px!important}.ktable tr:not(:first-child):hover{background-color:#ffffdd} 
 }} 

 _Added in 1.9.0_ 

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

 Returns properties for a window. 

 *Parameters* 

 table(ktable). 
 |_<.Parameter|_<.Description| 
 | N/@name/@[[Scripting_Wildcards|wildcard]] | Name of the window or the Nth window. (@[[Scripting_Wildcards|wildcard]] is also possible if M is defined) | 
 | M | The Nth @[[Scripting_Wildcards|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* 

 table(ktable). 
 |_<.Propertie|_<.Description| 
 | .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. | 
 | .cx | *TODO* | 
 | .cy | *TODO* | 
 | .dx | Horizontal position of the window relative to the desktop. | 
 | .dy | Vertical position of the window relative to the desktop. | 
 | .dw | Width of the [[TextArea Control|Text Area]]. | 
 | .dh | Height of the [[TextArea Control|Text 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 Control|Titlebar]]. | 
 | .state | minimized/maximized/hidden/normal. | 
 | .font | Name of the current font. | 
 | .fontsize | Size of the current font using the current display "DPI":https://en.wikipedia.org/wiki/Dots_per_inch. | 
 | .fontdialogsize | The real 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 Control|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_Control|Switchbar]] otherwise [[$false]]. | 
 | .ontop | [[$true]] if window is on top otherwise [[$false]]. | 
 | .type | Window type, channel/status/query/custom/picture/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_Control|Switchbar]] button text for this window. | 
 | .sbcolor | [[Switchbar_Control|Switchbar]] color event event/message/highlight for this window. | 
 | .sbstate | [[Switchbar_Control|Switchbar]] button state (1 = visible, 0 = not visible) for this window. | 
 | .tbtext | [[Treebar_Control|Treebar]] text for this window. | 
 | .tbstate | [[Treebar_Control|Treebar]] state (1 = visible, 0 = not visible) for this window. | 
 | .lb | [[Nicklist Contro|listbox]] state (2 = side listbox, 1 = listbox, 0 = no listbox) for this window. | 
 | .topicbox | [[Topicbox Control|Topicbox]] state (2 = Show sticky, 1 = show, 2 = off) for this window. *(AdiIRC only)* | 
 | .idle | idle state. | 
 | .isbottom | [[$true]] if the [[TextArea Control|Text Area]] 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)* | 
 | .mscrollpos | Returns the current scrollbar position for the [[TextArea Control|Text Area]]. *(AdiIRC only)* | 
 | .mscrollmax | Returns the max scrollbar position for the [[TextArea Control|Text Area]]. *(AdiIRC only)* | 
 | .collapsed | Returns [[$true]] if the associated Status Window is collapsed in the [[Treebar_Control|Treebar]], otherwise [[$false]]. *(AdiIRC only)* | 
 | .eb | Returns 1 if the window has a [[Editbox Control|Editbox]], otherwise 0. *(AdiIRC only)* | 
 | .fullscreen | Returns [[$true]] if the window is fullscreen, otherwise [[$false]]. |