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

Home | Download | Forum | Bug Tracker

v3.1

ComboEx

This control enables you to create a comboex control, which is a combo box extended to support icons.
Root control: ComboBoxEx

Control Styles

These control styles are available when creating a ComboEx control. Remember that the general styles disabled, group, hidden, notheme, tabstop and transparent apply to all DCX controls except the embedded Dialog and Window controls.

dropdown	Simple dropdown combo.
dropedit	Dropdown combo with an editbox.
endellipsis	Place ellipsis at the end of text if it extends past the edge of the control.
hscroll	Enables the horizontal scroll bar in the listbox part.
noeditimage	No icon is show in edit control with dropedit style
noeditindent	The icon in the edit control isn`t indented.
nosizelimit	No limit on how small the control can be (can ofcourse lead to display oddness)
simple	Combo that is a list with an edit box
sort	Sort the contents of the listbox part. (untested)

Note. When creating a ComboEx control, it is important to remember that the height of the control includes the dropdown list portion.

/xdid flags

Control commands are input to the control with the /xdid command.

/xdid -a
This command lets you add an item to the comboex.
Syntax:	/xdid -a [DNAME] [ID] [N] [INDENT] [#ICON] [#SELECTED] [#OVERLAY] [Item Text] or [N] [+FLAGS] [INDENT] [#ICON] [#SELECTED] [#OVERLAY] [DATA]
Example:	/xdid -a dcx 4 3 0 1 2 0 Visit scriptsdb.org /xdid -a dcx 4 3 +T 0 1 2 0 44 these,are,some,tokens /xdid -a dcx 4 3 +F 0 1 2 0 44 1 -1 file.txt
Parameters:
N	Position where the comboex item will be added.
INDENT	Number of indent widths from the left border.
#ICON	Icon displayed when item is not selected.
#SELECTED	Icon displayed when item is selected.
#OVERLAY	Overlay icon of the item (Note: Not functional yet)
+FLAGS	item flags.
T	DATA is [C] [Item text][C][Item Text]...
F	DATA is [START] [END] [FILENAME]
DATA	The contents of this depend on the flags used.

Note. You can use 0 for the N value to insert the item at the end of the comboex. You can use -1 for the N value to change the contents of the editbox. When attempting to set the editbox contents in a dropdown style control which has NO editbox, the supplied text MUST match one of the items in the list & works the same as doing /xdid -c for the matching item, and clearing the editbox contents is the same as doing /xdid -u. Every unit of INDENT is a 10 pixel indent. Use 0 for #ICON or #SELECTED if you wish to use no icon. Use -1 for N to set the text for the editable part of the comboex (can't be used with dropdown style). C is a chr number as used with mIRC's token commands. START and END are line numbers. START Must be 1+ and END Must be >= START or -1 for end of file.

/xdid -c
This command lets you select the Nth comboex item.
Syntax:	/xdid -c [DNAME] [ID] [N]
Example:	/xdid -c dcx 4 5

/xdid -d
This command lets you delete the Nth comboex item.
Syntax:	/xdid -d [DNAME] [ID] [N](,[N2],[N3]-N4],...) or [N] [+FLAGS] [MATCH]
Example:	/xdid -d dcx 4 6 /xdid -d dcx 4 6 +w pattern
Parameters:
N	Item to delete or to start the search at.
+FLAGS	Pattern flags.
e	Exact match between MATCH and item text. (default)
w	Wildcard match between MATCH and item text.
r	Regex match between MATCH and item text.
MATCH	The pattern to match for deleting.

/xdid -l
This command lets you set the controls read only state.
Syntax:	/xdid -l [DNAME] [ID] [0\|1]
Example:	/xdid -l dcx 4 1

/xdid -r
This command lets you clear all the comboex items.
Syntax:	/xdid -r [DNAME] [ID] (0)
Example:	/xdid -r dcx 4 /xdid -r dcx 4

Note. Supplying the zero arg allows you to clear the editbox only.

/xdid -u
This command makes the currently selected comboex item unselected.
Syntax:	/xdid -u [DNAME] [ID]
Example:	/xdid -u dcx 4

/xdid -w
This command lets you add an icon to the image list.
Syntax:	/xdid -w [DNAME] [ID] [+FLAGS] [N,N2,N3-N4...] [FILENAME]
Example:	/xdid -w dcx 4 +g 113 shell32.dll
Parameters:
+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.
N	Icon index in icon archive
FILENAME	Icon archive filename

Note. Use 0 for N if the file is a single icon file. Use -1 for N to load all icons in the file.

/xdid -y
This command lets you clear the comboex image list.
Syntax:	/xdid -y [DNAME] [ID]
Example:	/xdid -y dcx 4

/xdid -A
This command lets you add custom info to items.
Syntax:	/xdid -A [DNAME] [ID] [ROW] [+FLAGS] [INFO]
Example:	/xdid -A dcx 4 13 +M Yetis are real
Parameters:
ROW	row
+FLAGS	M - Mark info
INFO	Info

Note. Only +M flag is supported atm.

$xdid() Properties

The $xdid identifier is a given mIRC alias that communicates with the DCX DLL to extract information in DCX controls.

$xdid().find
This property lets you retreive the comboex item index of the Nth found comboex item matching the input search patern.
Syntax:	$xdid(dialog, ID, [TAB][MATCHTEXT][TAB], TYPE, N).find
Example:	$xdid(dcx, 4, $chr(9) Item $chr(9), W, 3).find
Parameters:
MATCHTEXT	String composed of wildcards or regex paterns used for the search.
TYPE	Value indicating if the search is using a regex patern or wildcard string.
W	MATCHTEXT is a wildcard string.
R	MATCHTEXT is a regex patern.
N	Parameter indicating to return the Nth match.

Note. The [TAB] characters surrounding the matchtext are mandatory or else it won't work. If N is 0, returns the total number of matching items found.

$xdid().num
This property lets you retreive the total number of comboex items.
Syntax:	$xdid(dialog, ID).num
Example:	$xdid(dcx, 4).num

$xdid().sel
This property lets you retreive the comboex selected item number.
Syntax:	$xdid(dialog, ID).sel
Example:	$xdid(dcx, 4).sel

Note. Returns a value of 0 when no item selected.

$xdid().seltext
This property lets you retreive selected comboex item text.
Syntax:	$xdid(dialog, ID).seltext
Example:	$xdid(dcx, 4).seltext

Note. Returns a value of $null when no item selected.

$xdid().text
This property lets you retreive the Nth comboex item text.
Syntax:	$xdid(dialog, ID, [N]).text
Example:	$xdid(dcx, 4, 1).text

Note. You can use a value of 0 for N to retrieve the text of the editbox.

ComboEx Events

These events are fired when activity occurs in the ComboEx control.

dclick
When an item is double-clicked in a simple comboex.
Syntax:	/cb_alias DNAME dclick ID ITEM
Example:	/cb_alias dcx dclick 4 6
Parameters:
ITEM	Item number where the event was triggered.

dragbegin
Triggers when one or more files are dropped onto the control.
Syntax:	/cb_alias DNAME dragbegin ID COUNT
Example:	/cb_alias dcx dragbegin 4 3
Parameters:
COUNT	Total number of files dragged into the control.
Return	cancel to stop the drag drop events from occuring.

dragfile
The filename of the file that has
Syntax:	/cb_alias DNAME dragfile ID FILENAME
Example:	/cb_alias dcx dragfile 4 C:/mIRC/blah.txt

dragfinish
Event triggered when processing of drag drop is complete.
Syntax:	/cb_alias DNAME dragfinish ID
Example:	/cb_alias dcx dragfinish 4

edit
When the text is edited in a comboex with editbox.
Syntax:	/cb_alias DNAME edit ID
Example:	/cb_alias dcx edit 4

help
Launched when you click on a control using the ? contexthelp button.
Syntax:	/cb_alias DNAME help ID
Example:	/cb_alias dcx help 4

return
When the Enter key is pressed in the editbox of a comboex.
Syntax:	/cb_alias DNAME return ID
Example:	/cb_alias dcx return 4

sclick
When an item is selected in the comboex.
Syntax:	/cb_alias DNAME sclick ID ITEM
Example:	/cb_alias dcx sclick 4 6
Parameters:
ITEM	Item number where the event was triggered.