<?xml version="1.0" encoding="utf-8" standalone="yes"?>

<?xml-stylesheet href="./_c74_ref.xsl" type="text/xsl"?>

<!--This is an automatically generated file. DO NOT EDIT THIS FILE DIRECTLY. Rather, use the _ref.xml files found in the 'edits' folder.-->
<c74object name="dialog" module="max" category="Interaction">
	<digest>
		Open a dialog box
	</digest>
	<description>
		Displays a dialog box with a selection of appearance modes. In Default mode, the <o>dialog</o> object permits entry of a symbol (as text) and sends it out the outlet when you click on the &quot;OK&quot; button in the dialog box. In the other modes, the <o>dialog</o> object displays text, but doesn't permit data entry.
	</description>
	<!--METADATA-->
	<metadatalist>
		<metadata name="author">
			Cycling '74
		</metadata>
		<metadata name="tag">
			Max
		</metadata>
		<metadata name="tag">
			Interaction
		</metadata>
	</metadatalist>
	<!--INLETS-->
	<inletlist>
		<inlet id="0" type="INLET_TYPE">
			<digest>
				Show Dialog
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
		<inlet id="1" type="INLET_TYPE">
			<digest>
				0 Sets Output as Symbol, 1 as List/Message
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
	</inletlist>
	<!--OUTLETS-->
	<outletlist>
		<outlet id="0" type="OUTLET_TYPE">
			<digest>
				Text Entered in Dialog / bang
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
		<outlet id="1" type="OUTLET_TYPE">
			<digest>
				bang When User Cancels
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
		<outlet id="2" type="OUTLET_TYPE">
			<digest>
				bang When User Clicks No in Extended mode
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
	</outletlist>
	<!--ARGUMENTS-->
	<objarglist>
		<objarg name="label" optional="1" type="symbol">
			<digest>
				The dialog window label
			</digest>
			<description>
				Sets the prompt which will appear above the text entry box in the dialog window. In Alert, Confirmation and Extended modes (<at>mode</at>= 1, 2, 3 or 4), the prompt is displayed as a title above the default text. See <at>label</at>.
			</description>
		</objarg>
	</objarglist>
	<!--MESSAGES-->
	<methodlist>
		<method name="bang">
			<arglist />
			<digest>
				Open dialog box with default text
			</digest>
			<description>
				In left inlet: Opens the dialog box with the previous text displayed as the default.
			</description>
		</method>
		<method name="int">
			<arglist>
				<arg name="text" optional="0" type="int" />
			</arglist>
			<digest>
				Open dialog box, using the value as default text
			</digest>
			<description>
				See the <m>symbol</m> entry.
			</description>
		</method>
		<method name="float">
			<arglist>
				<arg name="text" optional="0" type="float" />
			</arglist>
			<digest>
				Open dialog box, using the value as default text
			</digest>
			<description>
				In left inlet: Same as <m>symbol</m>.
			</description>
		</method>
		<method name="clearsymbol">
			<arglist />
			<digest>
				Clear the default text
			</digest>
			<description>
				In left inlet: Clears any previously set default text.
			</description>
		</method>
		<method name="in1">
			<arglist>
				<arg name="output-mode" optional="0" type="int" />
			</arglist>
			<digest>
				Set output mode
			</digest>
			<description>
				<i>Only applicable to Default display mode</i> ( <at>mode</at>= 0):
				<br />
				<br />
				In right inlet: The number <m>0</m> configures the <o>dialog</o> object to send out the text typed by the user into the dialog box as a symbol preceded by the word <m>symbol</m>. A non-zero number configures the <o>dialog</o> object to send out the typed-in text exactly as-is if it begins with a word, or preceded by the word <m>list</m> if it begins with a number. If no number is received, it is considered <m>0</m> by default.
			</description>
		</method>
		<method name="symbol">
			<arglist>
				<arg name="text" optional="0" type="symbol" />
			</arglist>
			<digest>
				Open dialog box, using the value as default text
			</digest>
			<description>
				In Default mode (<at>mode</at>= 0):
				<br />
				In left inlet: The word <m>symbol</m>, followed by any word, opens a dialog box prompting the user to enter text. The word following <m>symbol</m> is shown as the default text.
				<br />
				<br />
				In other modes:
				<br />
				In left inlet: the word <m>symbol</m>, followed by any word, opens a dialog box displaying that word.
				<br />
				<br />
				If you want more than one word to appear as the default text, you must enclose the words in double quotes.
			</description>
		</method>
	</methodlist>
	<!--ATTRIBUTES-->
	<attributelist>
		<attribute name="label" get="1" set="1" type="atom" size="1">
			<digest>
				Prompt/Title Text
			</digest>
			<description>
				Sets the prompt which will appear above the text entry box in the dialog window. In Alert, Confirmation and Extended modes (<at>mode</at>= 1, 2, 3 or 4), the prompt is displayed as a title above the default text.
			</description>
			<attributelist>
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Prompt/Title Text" />
				<attribute name="style" get="1" set="1" type="symbol" size="1" value="text_large" />
			</attributelist>
		</attribute>
		<attribute name="mask" get="1" set="1" type="int" size="1">
			<digest>
				Show input text as bullets (default: 1)
			</digest>
			<description>
				Mask input text with bullet characters. The text output from the <o>dialog</o> object's outlet remains human-readable.
			</description>
			<attributelist>
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Show Input Text As Bullets" />
				<attribute name="style" get="1" set="1" type="symbol" size="1" value="onoff" />
			</attributelist>
		</attribute>
		<attribute name="mode" get="1" set="1" type="int" size="1">
			<digest>
				Display mode (default: 0 [&quot;Default&quot; mode])
			</digest>
			<description>
				The dialog box has five different display modes, Default, Alert, Confirmation and two Extended modes. Text input is permitted in Default mode, while the other two modes are used for text display with limited user interaction.
			</description>
			<attributelist>
				<attribute name="enumvals" get="1" set="1" type="atom" size="5">
					<enumlist>
						<enum name="Default (OK/Cancel)">
							<digest>
								&quot;Default&quot; mode has a text entry field, and the buttons &quot;OK&quot; and &quot;Cancel&quot;.
							</digest>
							<description>
								TEXT_HERE
							</description>
						</enum>
						<enum name="Alert (OK)">
							<digest>
								&quot;Alert&quot; mode has no text entry field, and the button &quot;OK&quot; only.
							</digest>
							<description>
								TEXT_HERE
							</description>
						</enum>
						<enum name="Confirmation (OK/Cancel)">
							<digest>
								&quot;Confirmation&quot; mode has no text entry field, and the buttons &quot;OK&quot; and &quot;Cancel&quot;.
							</digest>
							<description>
								TEXT_HERE
							</description>
						</enum>
						<enum name="Extended (Yes/No/Cancel)">
							<digest>
								&quot;Extended&quot; mode has no text entry field, and the buttons &quot;Yes&quot;, &quot;No&quot; and &quot;Cancel&quot;.
							</digest>
							<description>
								TEXT_HERE
							</description>
						</enum>
						<enum name="Extended (Yes/No)">
							<digest>
								A second &quot;Extended&quot; mode without a text entry field, and the buttons &quot;Yes&quot; and &quot;No&quot; (but no &quot;Cancel&quot; option).
							</digest>
							<description>
								TEXT_HERE
							</description>
						</enum>
					</enumlist>
				</attribute>
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Display Mode" />
				<attribute name="style" get="1" set="1" type="symbol" size="1" value="enumindex" />
			</attributelist>
		</attribute>
	</attributelist>
	<!--EXAMPLE-->
	<examplelist>
		<example img="dialog.png" caption="Typed-in message is sent out when OK button is clicked other processes continue while dialog box is open A dialog box is opened by the dialog object" />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="message" />
		<seealso name="opendialog" />
		<seealso name="savedialog" />
		<seealso name="sprintf" />
	</seealsolist>
	<discussion>
		Note that the output of a dialog object is not directly &quot;caused&quot; by sending the object a message, so you can't count on it happening by a certain time.
	</discussion>
	<misc name="Output">
		<entry name="symbol">
			<description>
				<i>Only applicable to Default display mode</i> ( <at>mode</at>= 0):
				<br />
				<br />
				If the user clicks the &quot;OK&quot; button, the <o>dialog</o> object makes a symbol out of the entered text (even if it's a number or it's more than one word) and sends it out its outlet with the word <m>symbol</m> prepended. If a non-zero number has been received in the right inlet, the typed-in message is sent out as is (without being preceded by the word <m>symbol</m>). This message can be displayed by prepending the word <m>set</m> and sending it to a <o>message</o> box (as shown in the example). If the user clicks Cancel, nothing is sent out.
				<br />
				<br />
				In Alert, Confirmation and Extended modes (<at>mode</at>= 1, 2, 3 or 4) if the user clicks the &quot;OK&quot; (or &quot;Yes&quot; button in Extended mode), a <m>bang</m> message is sent out the left outlet.
				<br />
				<br />
				Since your patch continues to run while waiting for the user to type text into your dialog box, you can't count on getting the typed-in symbol immediately after sending the message that opens the dialog box.
			</description>
		</entry>
		<entry name="bang">
			<description>
				In Alert, Confirmation and Extended modes (<at>mode</at>= 1, 2, 3 or 4) if the user clicks the &quot;OK&quot; (or &quot;Yes&quot; button in Extended mode), a <m>bang</m> message is sent out the left outlet.
				<br />
				<br />
				If the dialog box is cancelled by the user, a <m>bang</m> message is sent out the middle outlet.
				<br />
				<br />
				In Extended modes (<at>mode</at>= 2 or 3), if the &quot;No&quot; button is clicked, a <m>bang</m> message is sent out the rightmost outlet.
			</description>
		</entry>
	</misc>
</c74object>
