DCX XTreebar - Dialog Control Xtension DLL v3.1 by ClickHeRe, twig* & Ook

Home | Download | Forum | Bug Tracker

v3.1

XTreebar

XTreebar is a command implemented to control the mIRC Treebar.
Root control: TreeView

/xtreebar Commands

The /xtreebar command is used to control the mIRC Treebar and change various properties.

/xtreebar -c
This command changes the mIRC Treebar colors.
Syntax:	/xtreebar -c [+COLORFLAGS] [COLOUR]
Example:	/xtreebar -c +b 255
Parameters:
+COLORFLAGS	Color flags.
b	Background color.
e	Event color.
E	Event background color.
i	Insert mark color.
l	Line color.
s	Selected text color.
S	Selected background color.
t	Text color.
m	Message color.
M	Message background color.
COLOR	The color in $rgb() format.

Note. This requires /xtreebar -T to be activated.

/xtreebar -f
This command allows you to change the mIRC Treebar font.
Syntax:	/xtreebar -f [+FONTFLAGS] [CHARSET] [SIZE] [FONTNAME]
Example:	/xtreebar -f +i default 20 Verdana
Parameters:
+FONTFLAGS	Font style flags.
a	Font is anti-aliased.
b	Font is bold.
d	Default font.
i	Font is italic.
s	Font is strikedout.
u	Font is underlined.
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, ...

/xtreebar -s
This command allows you to change the mIRC Treebar styles.
Syntax:	/xtreebar -s [STYLES]
Example:	/xtreebar -s tooltips scroll singleexpand
Parameters:
fullrowselect	Enables fullrowselection.
nofullrowselect	Disables fullrowselection.
haslines	Enables haslines.
nohaslines	Disables haslines.
trackselect	Enables hot-tracking.
notrackselect	Disables hot-tracking.
tooltips	Enables tooltips on items
notooltips	Disables tooltip on items.
balloon	Enables balloon styled tooltips. See note for further information.
noballoon	Disables balloon styled tooltips.
infotip	Enables modification of the tooltip text within the $xtreebar_callback. See note for further information.
noinfotip	Disables modification of the tooltip text.
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 mIRC Treebar.
noscroll	Disables horizontal and vertical scrolling in the mIRC Treebar.
showsel	Selections will be shown when mIRC Treebar loses focus.
noshowsel	Selections will not be shown when mIRC Treebar loses focus.
autohscroll	Remove the horizontal scrollbar and auto-scroll depending on mouse position. (Vista)
noautohscroll	Enables the horizontal scrollbar and auto-scroll depending on mouse position. (Vista)
doublebuffer	Specifies how the background is erased or filled. (Vista)
nodoublebuffer	Specifies how the background is erased or filled. (Vista)
fadebuttons	Fade expand buttons in or out when the mouse moves away or into a state of hovering over the control. (Vista)
nofadebuttons	Does not fade expand buttons in or out when the mouse moves away or into a state of hovering over the control. (Vista)
indent	Indents the tree view for the expand buttons. (Vista)
noindent	Does not indent the tree view for the expand buttons. (Vista)
richtooltip	Allow rich tooltips in the tree view (custom drawn with icon and text). (Vista)
norichtooltip	Disables rich tooltips in the tree view (custom drawn with icon and text). (Vista)

Note. Using noscroll while the scrollbar is visible may lead to graphical glitches. When using infotip, the alias $xtreeview_callback(gettooltip, [TYPE], [TEXT]) is called. Use return NEW_TIP_TEXT to change the tooltip text, and return nothing to prevent the tip from being displayed. balloon can only be used AFTER tooltips has been enabled, in a seperate /xtreebar command.

/xtreebar -w
This command allows you to change the mIRC Treebar images.
Syntax:	/xtreebar -w [POS] [+FLAGS] [INDEX] [FILE]
Example:	/xtreebar -w 0 + 1 icons.icl /xtreebar -w clear /xtreebar -w default
Parameters:
clear	Clears the icon list.
default	Reverts the icon list to the default icons.
POS	The position to add the new icon. Use 0 to add to the end.
+FLAGS	Icon flags
a	Uses the icon associated with the given file (as shown in Windows Explorer). Note: File must exist.
f	Uses the icon associated with the given filetype. Note: Filename is the extension (eg. BMP, PNG, AVI, etc).
g	Convert to grayscale icon.
P	If GDI+ is enabled, this will use GDI+ to extract the icon.

Note. This requires /xtreebar -T to be activated.

/xtreebar -T
This command allows you to enable or disable DCX controlled drawing of the mIRC TreeBar.
Syntax:	/xtreebar -T [0\|1]
Example:	/xtreebar -T 1

Note. When enabled, the script function $xtreebar_callback(geticons, [TYPE], [TEXT]) will be called for each item. This will allow you to configure the appearance of each item in the TreeBar. The same alias is called when an item is added to the TreeBar. This will allow you to configure the appearance of the new item. The $xtreebar_callback alias should return 3 image indexes, IMAGE SELECTEDIMAGE EXPANDEDIMAGE. (eg. return 2 5 6)

$xtreebar Properties

The $xtreebar identifier is used to retrieve information about the mIRC TreeBar.

$xtreebar().icons
Returns the current icons being used by the mIRC TreeBar item.
Syntax:	$xtreebar(N).icons
Example:	$xtreebar(3).icons
Parameters:
N	The index of the item.

Note. If N is 0, this property retrieves the last item in the mIRC Treebar.

$xtreebar().item
Returns the text of the mIRC TreeBar item.
Syntax:	$xtreebar(N).item
Example:	$xtreebar(3).item
Parameters:
N	The index of the item.

Note. If N is 0, this property retrieves the total number of items in the mIRC Treebar. Returns $null if unsuccessful.

$xtreebar().wid
Returns the window ID of the current item.
Syntax:	$xtreebar(N).wid
Example:	$xtreebar(3).wid
Parameters:
N	The index of the item.

Note. If N is 0, this property retrieves the current item being proccessed by $xtreebar_callback. (This ONLY works within the $xtreebar_callback alias.) Returns 0 if unsuccessful.

$xtreebar_callback events

The $xtreebar_callback identifier is used to react to changes on the to the treebars contents.

$xtreebar_callback(geticons)
Get the icons to use with this item.
Syntax:	$xtreebar_callback(geticons,[TYPE],[TEXT])
Example:	$xtreebar_callback(geticons,channel,#genscripts)
Parameters:
TYPE	Item type.
channelfolder	Channel group
windowfolder	Windows group
notifyfolder	Notify group
transfersfolder	DCC group
channel	Channel window.
custom	Custom window.
query	Query window.
send	DCC Send window.
get	DCC Get window.
chat	DCC Chat window.
TEXT	The items text.
Return	NORMAL SELECTED EXPANDED eg - return 1 3 6 NORMAL The icon index to display when the item is not selected or expanded (also the default if no other index supplied). SELECTED The icon index to display when the item is selected. EXPANDED The icon index to display when the item is expanded.

Note. This requires /xtreebar -T to be activated.

$xtreebar_callback(gettooltip)
Get the items tooltip.
Syntax:	$xtreebar_callback(gettooltip,[TYPE],[TEXT])
Example:	$xtreebar_callback(gettooltip,channel,#genscripts)
Parameters:
TYPE	Item type.
channelfolder	Channel group
windowfolder	Windows group
notifyfolder	Notify group
transfersfolder	DCC group
channel	Channel window.
custom	Custom window.
query	Query window.
send	DCC Send window.
get	DCC Get window.
chat	DCC Chat window.
TEXT	The items text.
Return	The tooltip text to display.

$xtreebar_callback(setitem)
This command allows you to change the mIRC Treebar styles.
Syntax:	$xtreebar_callback(setitem,[TYPE],[WID],[STATE])
Example:	$xtreebar_callback(setitem,channel,61,selected)
Parameters:
TYPE	Item type.
channelfolder	Channel group
windowfolder	Windows group
notifyfolder	Notify group
transfersfolder	DCC group
channel	Channel window.
custom	Custom window.
query	Query window.
send	DCC Send window.
get	DCC Get window.
chat	DCC Chat window.
WID	The items WID, not valid for group items.
STATE	Items state.
selected	Item has been selected.
deselected	Items has been deselected.
Return	No return value.

Note. Not all items will have a valid WID.

Last Updated: 18th February, 25