AdiIRC

h1. Dialog Items

_See also [[/dialog]], [[$dialog]], [[on DIALOG]]._

*title <text>*

Sets the titlebar text of the dialog.

---

*size <x y w h>*

Sets the x/y position and the width/height of the dialog.

---

*option <pixels | dbu | notheme | disable>*

pixels - The dialog and All dialog items sizes are defined in pixels.

dbu - The dialog and All dialog items sizes are defined in Dialog Base Units.

notheme - Sets the dialog border style to fixed single and disables windows theme styling.

disable - Disables all controls for a second when the dialog is shown.

---

*icon <filename, [index]>*

Adds a icon to the dialog.

_The filename must have a valid image and be the first parameter, if there are additional parameters after the filename, there must be a comma first._

filename - Icon file, can be any type of picture or icon file, also a .exe or .dll.

[index] - Icon index in the .ico/.exe/.dll file to use.

---

*icon <id, x y w h, filename, [index], [noborder, top, left, bottom, right, small, large, actual, disable, hide, tab id, aleft, aright, atop, abottom, %variable]>*

Adds a picturebox to the dialog.

_The filename must have a valid image and be the first parameter, if there are additional parameters after the filename, there must be a comma first._

id - Id of the picturebox.

x y w h - The x y position, width and height to use for the picturebox.

filename - Icon file, can be any type of picture or icon file, also a .exe or .dll.

[index] - Icon index in the .ico/.exe/.dll file to use.

noborder - Removes the border added to regular images.

top - TODO

left - TODO

bottom - TODO

right - TODO

center - TODO

small - Use small icon.

large - Use large icon.

actual - Use the actual icon.

disable - Disables the picturebox.

hide - Hides the picturebox.

tabid/tab id - Indicates the picturebox should be shown on the tab with the specified id.

aleft - Anchors the picturebox to the left. (AdiIRC only)

aright - Anchors the picturebox to the right. (AdiIRC only)

atop - Anchors the picturebox to the top. (AdiIRC only)

abottom - Anchors the picturebox to the bottom. (AdiIRC only)

%variable - Fills the variable with the picturebox filename when the dialog closes.

---

*tab <text, id, x y w h>, [%variable]*

Adds a tabcontrol to the dialog.

text - The text of the tab.

id - Id of the tabcontrol.

x y w h - The x y position, width and height to use for the tabcontrol.

%variable - Fills the variable with the tab text when the dialog closes.

---

*tab <text, id, [%variable]*

Adds a new tab to the tabcontrol with the specified id.

%variable - Fills the variable with the tab text when the dialog closes.

---

*combo <id, x y w h, [sort, edit, drop, size, vsbar, hsbar, result, disable, tab id, aleft, aright, atop, abottom, %variable]>*

Adds a combobox to the dialog with the specified id at position x/y and the w/h width/height.

id - Id of the combobox.

x y w h - The x y position, width and height to use for the combobox.

sort - Enables sorting.

edit - Shows the editbox.

drop - Show as a dropdown list.

size - Sets the height of the dropdown area.

vsbar - Enables the vertical scrollbar.

hsbar - Enables the horizontal scrollbar.

result -Indicates the selected dropdown item/text should be returned when the dialog "OK/Accept button" is pressed.

disable - Disables the combobox.

tabid/tab id - Indicates the combobox should be shown on the tab with the specified id.

aleft - Anchors the combobox to the left. (AdiIRC only)

aright - Anchors the combobox to the right. (AdiIRC only)

atop - Anchors the combobox to the top. (AdiIRC only)

abottom - Anchors the combobox to the bottom. (AdiIRC only)

%variable - Fills the variable with the edit or dropdown text when the dialog closes.

---

*text <text, id, x y w h, [right, center, nowrap, result, disable, hide, tab id, aleft, aright, atop, abottom, %variable]>*

Adds a text label to the dialog.

text - The text to add.

id - Id of the text.

x y w h - The x y position, width and height to use for the text.

right - Aligns the text to the right.

center - Centers the text.

nowrap - Prevents the text from wrapping. Any text that does not fit will be cut off. 

result - Indicates the text should be returned when the dialog "OK/Accept button" is pressed.

disable - Disables the text.

hide - Hides the text.

tabid/tab id - Indicates the text should be shown on the tab with the specified id.

aleft - Anchors the text to the left. (AdiIRC only)

aright - Anchors the text to the right. (AdiIRC only)

atop - Anchors the text to the top. (AdiIRC only)

abottom - Anchors the text to the bottom. (AdiIRC only)

%variable - Fills the variable with the text when the dialog closes.

---

*link <text, id, x y w h, [right, center, result, disable, hide, tab id, aleft, aright, atop, abottom, %variable]>*

Adds a link label to the dialog.

text - Text of the link.

id - Id of the link.

x y w h - The x y position, width and height to use for the link.

right - Aligns the link to the right.

center - Centers the link.

result - Indicates the link text should be returned when the dialog "OK/Accept button" is pressed.

disable - Disables the link.

hide - Hides the link.

tabid/tab id - Indicates the link should be shown on the tab with the specified id.

aleft - Anchors the link to the left. (AdiIRC only)

aright - Anchors the link to the right. (AdiIRC only)

atop - Anchors the link to the top. (AdiIRC only)

abottom - Anchors the link to the bottom. (AdiIRC only)

%variable - Fills the variable with the link text when the dialog closes.

---

*button <text, id, x y w h, [default, ok, cancel, flat, multi, result, disable, hide, tab id, aleft, aright, atop, abottom, %variable]>*

Adds a button to the dialog.

text - Text of the button.

id - Id of the button.

x y w h - The x y position, width and height to use for the button.

default - Sets the button as the default/accept button of the dialog.

ok - Sets the button as the "ok" button of the dialog.

cancel - Sets the button as the "cencel" button of the dialog.

flat - Shows the button as a flat button.

multi - Split long text into multiple lines.

result - Indicates the button text should be returned when the dialog "OK/Accept button" is pressed.

disable - Disables the button.

hide - Hides the button.

tabid/tab id - Indicates the button should be shown on the tab with the specified id.

aleft - Anchors the button to the left. (AdiIRC only)

aright - Anchors the button to the right. (AdiIRC only)

atop - Anchors the button to the top. (AdiIRC only)

abottom - Anchors the button to the bottom. (AdiIRC only)

%variable - Fills the variable with the button text when the dialog closes.

---

*check <text, id, x y w h, [left, push, 3state, flat, result, disable, hide, tab id, aleft, aright, atop, abottom, %variable]>*

Adds a checkbox to the dialog.

text - Text of the checkbox.

id - Id of the checkbox.

x y w h - The x y position, width and height to use for the checkbox.

left - TODO

push - Shows the checkbox as a button.

3state - Enables the intermediate state, gives the checkbox 3 states it can be in.

flat - Shows the checkbox as a flat checkbox.

result - Indicates the checkbox text should be returned when the dialog "OK/Accept button" is pressed.

disable - Disables the checkbox.

hide - Hides the checkbox.

tabid/tab id - Indicates the checkbox should be shown on the tab with the specified id.

aleft - Anchors the checkbox to the left. (AdiIRC only)

aright - Anchors the checkbox to the right. (AdiIRC only)

atop - Anchors the checkbox to the top. (AdiIRC only)

abottom - Anchors the checkbox to the bottom. (AdiIRC only)

%variable - Fills the variable with the checkbox text when the dialog closes.

---

*edit <text, id, x y w h, [right, center, multi, pass, read, return, hsbar, vsbar, autohs, autovs, limit N, rich, result, disable, hide, tab id, aleft, aright, atop, abottom, %variable]>*

Adds a textbox to the dialog.

text - Text of the textbox.

id - Id of the textbox.

x y w h - The x y position, width and height to use for the textbox.

right - Aligns the text in the textbox to the right.

center - Aligns the text in the textbox to the center.

multi - Enables multi lines.

pass - Indicates the text in the textbox is a password and should be masked.

read - Enables read only mode.

return - Allow return key to add new lines.

hsbar - Enables horizontal scrollbar.

vsbar - Enables vertical scrollbar.

autohs - Disables word wrap in a multi line textbox .

autovs - Automatically scroll to bottom when adding lines in multi line textbox .

limit N - Limits the textbox to N characters.

rich - Enables richtextbox instead of regular textbox.

result - Indicates the textbox text should be returned when the dialog "OK/Accept button" is pressed.

disable - Disables the textbox.

hide - Hides the textbox.

tabid/tab id - Indicates the textbox should be shown on the tab with the specified id.

aleft - Anchors the textbox to the left. (AdiIRC only)

aright - Anchors the textbox to the right. (AdiIRC only)

atop - Anchors the textbox to the top. (AdiIRC only)

abottom - Anchors the textbox to the bottom. (AdiIRC only)

%variable - Fills the variable with the first line in the textbox when the dialog closes.

---

*list <id, x y w h, [sort, extsel, multse, size, vsbar, hsbar, check, radio, result, disable, hide, tab id, aleft, aright, atop, abottom]>*

Adds a listbox to the dialog.

id - Id of the listbox.

x y w h - The x y position, width and height to use for the listbox.

sort - Enables sorting.

extsel - Enabled extended selection mode.

multsel - Enabled multi selection mode.

size - TODO

vsbar - Shows the vertical scrollbar always.

hsbar - Shows the horizontal scrollbar always.

check - Shows checkboxes instead of text.

radio - TODO

result - Indicates the selected listbox text should be returned when the dialog "OK/Accept button" is pressed.

disable - Disables the listbox.

hide - Hides the listbox.

tabid/tab id - Indicates the listbox should be shown on the tab with the specified id.

aleft - Anchors the listbox to the left. (AdiIRC only)

aright - Anchors the listbox to the right. (AdiIRC only)

atop - Anchors the listbox to the top. (AdiIRC only)

abottom - Anchors the listbox to the bottom. (AdiIRC only)

---

*radio <text, id, x y w h, [left, push, flat, group, result, disable, hide, tab id, aleft, aright, atop, abottom, %variable]>*

Adds a radio button to the dialog.

text - Text of the radio button.

id - Id of the radio button.

x y w h - The x y position, width and height to use for the radio button.

left - TODO

push - Shows the radio button as an button.

flat - Shows the radio button as flat.

group - Creates a new radio group.

result - Indicates the radio button text should be returned when the dialog "OK/Accept button" is pressed.

disable - Disables the radio button.

hide - Hides the radio button.

tabid/tab id - Indicates the radio button should be shown on the tab with the specified id.

aleft - Anchors the radio button to the left. (AdiIRC only)

aright - Anchors the radio button to the right. (AdiIRC only)

atop - Anchors the radio button to the top. (AdiIRC only)

abottom - Anchors the radio button to the bottom. (AdiIRC only)

%variable - Fills the variable with the radio text when the dialog closes.

---

*box <text, id, x y w h, [result, disable, hide, tab id, aleft, aright, atop, abottom, %variable]>*

Adds a group box.

text - Text of the group box.

id - Id of the group box.

x y w h - The x y position, width and height to use for the group box.

result - Indicates the selected group box text should be returned when the dialog "OK/Accept button" is pressed.

disable - Disables the group box.

hide - Hides the group box.

tabid/tab id - Indicates the group box should be shown on the tab with the specified id.

aleft - Anchors the group box to the left. (AdiIRC only)

aright - Anchors the group box to the right. (AdiIRC only)

atop - Anchors the group box to the top. (AdiIRC only)

abottom - Anchors the group box to the bottom. (AdiIRC only)

%variable - Fills the variable with the box text when the dialog closes.

---

*scroll <text, id, x y w h, [top left bottom right horizontal range N N, disable, hide, tab id, aleft, aright, atop, abottom]>*

Adds a vertical scrollbar.

text - Text of the scrollbar?.

id - Id of the scrollbar.

x y w h - The x y position, width and height to use for the scrollbar.

top - todo

left - TODO

bottom - TODO

right - TODO

horizontal - Sets the scrollbar as a horizontal scrollbar.

range N N - Sets the range of the scrollbar, from N to N.

disable - Disables the scrollbar.

hide - Hides the scrollbar.

tabid/tab id - Indicates the scrollbar should be shown on the tab with the specified id.

aleft - Anchors the scrollbar to the left. (AdiIRC only)

aright - Anchors the scrollbar to the right. (AdiIRC only)

atop - Anchors the scrollbar to the top. (AdiIRC only)

abottom - Anchors the scrollbar to the bottom. (AdiIRC only)

---

*menu <text, menuid [, menuid]>*

Adds a new menu collection to the Menubar, if the second menuid is specified, the menuitem is added to that menu collection instead.

text - Text of the menu.

menuid - id of the menu.

menuid - id of the parent menu.

---

*item <text|break, id, [menuid, cancel, ok]>*

Adds a new menu item to a menu.

text|break - Text of the menu item, or break to add a menu separator.

id - Id of the menu item.

menuid - Parent menu to add the menu item to, else it's added to previously used menu.

cancel - Indicates this menu should trigger the cancel button.

ok - Indicates this menu should trigger the accept/ok button.