- Index
- General Usage
- DCX Controls
- DCX Features
- About DCX
|
XDock |
XDock is the complete rewrite of UltraDock. It handles docking of all types of windows and customisation of behaviour upon resizing.
|
/xdock Command |
| The /xdock command is used to force the positioning of a window within another window, with specific behaviour. |
|
/xdock -b |
| This command docks a window to the mIRC TreeBar. |
| Syntax: |
/xdock -b [HWND_DOCK] [+FLAGS] |
| Example: |
/xdock -b $dialog(dcx).hwnd +h |
| Parameters: |
| HWND_DOCK |
The HWND of the window you wish to dock. |
| +FLAGS |
Flags for docking into the mIRC TreeBar. |
| s |
Docked window will be resized to fit its parent width & height automatically. |
| h |
Docked window will be resized to fit its parent width automatically. |
| v |
Docked window will be resized to fit its parent height automatically. |
| n |
Docked window will not be resized automatically. |
|
/xdock -c |
| This command docks a window to a custom window (channel, query, custom, or status windows). |
| Syntax: |
/xdock -c [HWND_DOCK] [+FLAGS] [DESTINATION] |
| Example: |
/xdock -c $dialog(dcx).hwnd +h $query(ClickHeRe).hwnd |
| Parameters: |
| HWND_DOCK |
The HWND of the window you wish to dock. |
| +FLAGS |
Flags for docking into a custom window. |
| s |
Docked window will be resized to fit its parent width & height automatically. |
| h |
Docked window will be resized to fit its parent width automatically. |
| v |
Docked window will be resized to fit its parent height automatically. |
| n |
Docked window will not be resized automatically. |
| DESTINATION |
The HWND of the window that you wish to dock your window into. |
|
/xdock -m |
| This command docks a window to your mIRC window. |
| Syntax: |
/xdock -m [HWND_DOCK] [+FLAGS] |
| Example: |
/xdock -m $dialog(dcx).hwnd +r |
| Parameters: |
| HWND_DOCK |
The HWND of the window you wish to dock. |
| +FLAGS |
Flags for docking into a mIRC window. |
| t |
Docks the window to the top. |
| b |
Docks the window to the bottom. |
| l |
Docks the window to the left. |
| r |
Docks the window to the right. |
|
/xdock -n |
| This command docks a window to a nicklist listbox. |
| Syntax: |
/xdock -n [HWND_DOCK] [+FLAGS] [DESTINATION] |
| Example: |
/xdock -n $dialog(dcx).hwnd +h $channel(#help).hwnd |
| Parameters: |
| HWND_DOCK |
The HWND of the window you wish to dock. |
| +FLAGS |
Flags for docking into a custom window. |
| s |
Docked window will be resized to fit its parent width & height automatically. |
| h |
Docked window will be resized to fit its parent width automatically. |
| v |
Docked window will be resized to fit its parent height automatically. |
| n |
Docked window will not be resized automatically. |
| DESTINATION |
The HWND of the channel window that you wish to dock your window into. |
|
/xdock -p |
| This command forces mIRC to update its docked windows. |
| Syntax: |
/xdock -p |
| Example: |
/xdock -p |
|
/xdock -r |
| This command resizes a docked window. |
| Syntax: |
/xdock -r [HWND_DOCK] [+FLAGS] [WIDTH] [HEIGHT] |
| Example: |
/xdock -r $dialog(dcx).hwnd + 250 3000 |
| Parameters: |
| HWND_DOCK |
The HWND of the window you wish to resize. |
| +FLAGS |
There are currently no flags. |
| WIDTH |
The width that the window will be set to. |
| HEIGHT |
The height that the window will be set to. |
| | Note.- If the window is docked in a top or bottom position, then WIDTH will be ignored.
- If the window is docked in a left or right position, then HEIGHT will be ignored.
|
|
/xdock -s |
| This command docks a window to the mIRC SwitchBar. |
| Syntax: |
/xdock -s [HWND_DOCK] [+FLAGS] |
| Example: |
/xdock -s $dialog(dcx).hwnd +v |
| Parameters: |
| HWND_DOCK |
The HWND of the window you wish to dock. |
| +FLAGS |
Flags for docking into the mIRC SwitchBar. |
| s |
Docked window will be resized to fit its parent width & height automatically. |
| h |
Docked window will be resized to fit its parent width automatically. |
| v |
Docked window will be resized to fit its parent height automatically. |
| n |
Docked window will not be resized automatically. |
|
/xdock -t |
| This command docks a window to the mIRC ToolBar. |
| Syntax: |
/xdock -t [HWND_DOCK] [+FLAGS] |
| Example: |
/xdock -t $dialog(dcx).hwnd +v |
| Parameters: |
| HWND_DOCK |
The HWND of the window you wish to dock. |
| +FLAGS |
Flags for docking into the mIRC ToolBar. |
| s |
Docked window will be resized to fit its parent width & height automatically. |
| h |
Docked window will be resized to fit its parent width automatically. |
| v |
Docked window will be resized to fit its parent height automatically. |
| n |
Docked window will not be resized automatically. |
|
/xdock -u |
| This command undocks a window. |
| Syntax: |
/xdock -u [HWND_DOCK] |
| Example: |
/xdock -u $dialog(dcx).hwnd |
| Parameters: |
| HWND_DOCK |
The HWND of the window you wish to undock. |
|
/xdock -F |
| This command allows you to set the font for the mIRC TreeBar. |
| Syntax: |
/xdock -F [+FLAGS] [ARGS] |
| Example: |
/xdock -F $dialog(dcx).hwnd +h $query(ClickHeRe).hwnd |
| Parameters: |
| +FLAGS |
Font style flags. |
| f |
Changes TreeBar font. |
| s |
Changes TreeBar styles. |
| Variable parameters ARGS: |
| f |
[+FONTFLAGS] [CHARSET] [SIZE] [FONTNAME] |
| +FONTFLAGS |
Array |
| CHARSET |
Can be any of the following: ansi, baltic, chinesebig, default, easteurope, gb2312, greek, hangul, mac, oem, russian, shiftjis, symbol, turkish, vietnamese. |
| SIZE |
Font size in points. |
| FONTNAME |
Font name. Ex: Tahoma, Courier New, Arial, ... |
| s |
[STYLES] |
| trackselect |
Enables hot-tracking. |
| notrackselect |
Disables hot-tracking. |
| tooltips |
Enables tooltips on items |
| notooltips |
Disables tooltip on items. |
| hasbuttons |
Enables ± buttons on the side of items containing child items for expand/collapse operations. |
| nohasbuttons |
Disables ± buttons on the side of items containing child items for expand/collapse operations. |
| rootlines |
Enables lines to be connected to the root item. |
| norootlines |
Disables lines to be connected to the root item. |
| singleexpand |
Causes the item being selected to expand and the item being unselected to collapse upon selection in the tree view. |
| nosingleexpand |
Disables singleexpand. |
| scroll |
Enables horizontal and vertical scrolling in the treeview. |
| noscroll |
Disables horizontal and vertical scrolling in the treeview. |
| | | Note. When using noscroll and a scrollbar is currently visible, this can lead to graphical glitches. |
|
/xdock -G |
| This command sets ghosted drag for the main mIRC window. |
| Syntax: |
/xdock -G [VALUE] |
| Example: |
/xdock -G 1 |
| Parameters: |
| VALUE |
The opacity of the dragged window. This can be a value between 0-255. |
|
/xdock -M |
| This command shows/hides the Menubar. |
| Syntax: |
/xdock -M [1|0] |
| Example: |
/xdock -M |
|
/xdock -R |
| This command shows/hides the Treebar. |
| Syntax: |
/xdock -R [1|0] |
| Example: |
/xdock -R |
|
/xdock -S |
| This command shows/hides the Switchbar. |
| Syntax: |
/xdock -S [1|0] |
| Example: |
/xdock -S |
|
/xdock -T |
| This command shows/hides the Toolbar. |
| Syntax: |
/xdock -T [1|0] |
| Example: |
/xdock -T |
$xdock Command |
| The $xdock command is used to retrieve docking information about windows and various mIRC components. |
|
$xdock().dockSide |
| Returns the side which the dialog is docked. |
| Syntax: |
$xdock(HWND).dockSide |
| Example: |
$xdock($dialog(dcx).hwnd).dockSide |
| Parameters: |
| SIDE |
Possible return values. |
| top |
The window is docked in the top position. |
| bottom |
The window is docked in the bottom position. |
| left |
The window is docked in the left position. |
| right |
The window is docked in the right position. |
|
$xdock().hasDocked |
| Return whether this window/dialog has another window docked in it. |
| Syntax: |
$xdock(HWND).hasDocked |
| Example: |
$xdock($dialog(dcx).hwnd).hasDocked |
|
$xdock().isAutoH |
| Returns whether the docked window automatically resize horizontally or not. |
| Syntax: |
$xdock(HWND).isAutoH |
| Example: |
$xdock($dialog(dcx).hwnd).isAutoH |
|
$xdock().isAutoS |
| Returns whether the docked window automatically resize both horizontally and vertically or not. |
| Syntax: |
$xdock(HWND).isAutoS |
| Example: |
$xdock($dialog(dcx).hwnd).isAutoS |
|
$xdock().isAutoV |
| Returns whether the docked window automatically resize vertically or not. |
| Syntax: |
$xdock(HWND).isAutoV |
| Example: |
$xdock($dialog(dcx).hwnd).isAutoV |
|
$xdock().isDocked |
| Return whether this window/dialog is docked or not. |
| Syntax: |
$xdock(HWND).isDocked |
| Example: |
$xdock($dialog(dcx).hwnd).isDocked |
|
$xdock().isMenuBar |
| Returns whether or not the mIRC MenuBar is visible. |
| Syntax: |
$xdock(mIRC).isMenuBar |
| Example: |
$xdock(mIRC).isMenuBar |
|
$xdock().isSwitchBar |
| Returns whether or not the mIRC SwitchBar is visible. |
| Syntax: |
$xdock(mIRC).isSwitchBar |
| Example: |
$xdock(mIRC).isSwitchBar |
|
$xdock().isToolBar |
| Returns whether or not the mIRC ToolBar is visible. |
| Syntax: |
$xdock(mIRC).isToolBar |
| Example: |
$xdock(mIRC).isToolBar |
|
$xdock().isTreeBar |
| Returns whether or not the mIRC TreeBar is visible. |
| Syntax: |
$xdock(mIRC).isTreeBar |
| Example: |
$xdock(mIRC).isTreeBar |
|
$xdock().switchBarPos |
| Returns the mIRC SwitchBar dock position. |
| Syntax: |
$xdock(mIRC).switchBarPos |
| Example: |
$xdock(mIRC).switchBarPos |
| Parameters: |
| POSITION |
Return values. |
| none |
The SwitchBar is not shown in mIRC. |
| top |
The SwitchBar is docked in the top position. |
| bottom |
The SwitchBar is docked in the bottom position. |
| left |
The SwitchBar is docked in the left position. |
| right |
The SwitchBar is docked in the right position. |
|
$xdock().switchBarSize |
| Returns the mIRC SwitchBar size. |
| Syntax: |
$xdock(mIRC).switchBarSize |
| Example: |
$xdock(mIRC).switchBarSize |
| Parameters: |
| DIMENSIONS |
Return values. |
| W |
The width of the mIRC SwitchBar. |
| H |
The height of the mIRC SwitchBar. |
|
$xdock().text |
| Returns an hwnd title text. |
| Syntax: |
$xdock(HWND).text |
| Example: |
$xdock($dialog(dcx).hwnd).text |
|
$xdock().toolBarPos |
| Returns the mIRC ToolBar position. |
| Syntax: |
$xdock(mIRC).toolBarPos |
| Example: |
$xdock(mIRC).toolBarPos |
| Parameters: |
| POSITION |
Return values. |
| none |
The ToolBar is not shown in mIRC. |
| top |
The ToolBar is in the top position. |
| bottom |
The ToolBar is in the bottom position. |
| left |
The ToolBar is in the left position. |
| right |
The ToolBar is in the right position. |
|
$xdock().toolBarSize |
| Returns the mIRC ToolBar size. |
| Syntax: |
$xdock(mIRC).toolBarSize |
| Example: |
$xdock(mIRC).toolBarSize |
| Parameters: |
| DIMENSIONS |
Return values. |
| W |
The width of the mIRC ToolBar. |
| H |
The height of the mIRC ToolBar. |
|
$xdock().treeBarPos |
| Returns the mIRC TreeBar position. |
| Syntax: |
$xdock(mIRC).treeBarPos |
| Example: |
$xdock(mIRC).treeBarPos |
| Parameters: |
| POSITION |
Return values. |
| none |
The TreeBar is not shown in mIRC. |
| top |
The TreeBar is in the top position. |
| bottom |
The TreeBar is in the bottom position. |
| left |
The TreeBar is in the left position. |
| right |
The TreeBar is in the right position. |
|
$xdock().treeBarSize |
| Returns the mIRC TreeBar size. |
| Syntax: |
$xdock(mIRC).treeBarSize |
| Example: |
$xdock(mIRC).treeBarSize |
| Parameters: |
| DIMENSIONS |
Return values. |
| W |
The width of the mIRC TreeBar. |
| H |
The height of the mIRC TreeBar. |
XDock Signals |
| Signals are sent to mIRC containing information about components which have resized. To activate signal messages for docked windows, refer to /dcx xSignal |
| Signal: |
DCX size WINDOW_TYPE HWND W H |
| Example: |
DCX size mIRC_Toolbar 345564 1024 32 |
| Parameters: |
| size |
The event signal identifier. |
| WINDOW_TYPE |
Information about which window type this information is describing. |
| mIRC |
The mIRC window has resized. |
| mIRC_Switchbar |
The mIRC SwitchBar has resized. |
| mIRC_Toolbar |
The mIRC ToolBar has resized. |
| mIRC_TreeList |
The mIRC TreeList has resized. |
| ListBox |
The channel ListBox has been resized. |
| Custom |
A custom window has been resized. |
| HWND |
The hwnd of the window which resized. |
| W |
The new width of the window. |
| H |
The new height of the window. |
| | | Note. For ListBox and Custom, the HWND will be the HWND of the window which triggered the event. For the other events, the HWND will be for the main mIRC window. |
|
|
