<?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="hint" module="max" category="U/I">
	<digest>
		Display hint text
	</digest>
	<description>
		When you mouse over a <o>hint</o>, you'll see a message appear on the screen below the area defined by the <o>hint</o>. The <o>hint</o> object has a number of messages you can use to change its appearance.
	</description>
	<!--METADATA-->
	<metadatalist>
		<metadata name="author">
			Cycling '74
		</metadata>
		<metadata name="tag">
			Max
		</metadata>
		<metadata name="tag">
			U/I
		</metadata>
	</metadatalist>
	<!--INLETS-->
	<inletlist>
		<inlet id="0" type="INLET_TYPE">
			<digest>
				1 Enables Hint, 0 Disables
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
	</inletlist>
	<palette category="Interface" action="hint" pic="hint.svg" />
	<!--OUTLETS-->
	<!--ARGUMENTS-->
	<objarglist>
		<objarg id="0" name="OBJARG_NAME" type="OBJARG_TYPE" optional="0">
			<digest>
				TEXT_HERE
			</digest>
			<description>
				TEXT_HERE
			</description>
		</objarg>
	</objarglist>
	<!--MESSAGES-->
	<methodlist>
		<method name="int">
			<arglist>
				<arg name="enable" optional="0" type="int" />
			</arglist>
			<digest>
				Enable or disable text display
			</digest>
			<description>
				<m>0</m> will disable any hinting while a non-zero number will enable it.
			</description>
		</method>
		<method name="float">
			<arglist>
				<arg name="enable" optional="0" type="float" />
			</arglist>
			<digest>
				Enable or disable text display
			</digest>
			<description>
				Converted to <m>int</m>.
			</description>
		</method>
		<method name="(mouse)">
			<digest>
				Display hint text
			</digest>
			<description>
				When the cursor moves within the <o>hint</o> object's rectangle, its text message will appear in a colored area beneath the rectangle after the specified delay.
			</description>
			<attributelist>
				<attribute name="documentable" get="1" set="1" type="int" size="1" value="1" />
			</attributelist>
		</method>
		<method name="set">
			<arglist>
				<arg name="message" optional="0" type="symbol" />
			</arglist>
			<digest>
				Replace the hint text
			</digest>
			<description>
				The word <m>set</m>, followed by any message, will replace the message stored in <o>hint</o>. This message will be displayed when the mouse is positioned over the <o>hint</o> object after an interval of time specified by the <m>delay</m> message.
			</description>
		</method>
	</methodlist>
	<!--ATTRIBUTES-->
	<attributelist>
		<attribute name="delay" get="1" set="1" type="int" size="1">
			<digest>
				Display onset time
			</digest>
			<description>
				Sets the delay in milliseconds until the hint appears. A value of 0 sets a default delay time, usually about 500 ms.
			</description>
			<attributelist>
				<attribute name="basic" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="category" get="1" set="1" type="symbol" size="1" value="Hint" />
				<attribute name="default" get="1" set="1" type="int" size="1" value="0" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Delay Before Hint Appears" />
				<attribute name="save" get="1" set="1" type="int" size="1" value="1" />
			</attributelist>
		</attribute>
		<attribute name="enabled" get="1" set="1" type="int" size="1">
			<digest>
				Enable hint display
			</digest>
			<description>
				Toggles enabling display of hint text.
			</description>
			<attributelist>
				<attribute name="basic" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="category" get="1" set="1" type="symbol" size="1" value="Hint" />
				<attribute name="default" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Enabled" />
				<attribute name="save" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="style" get="1" set="1" type="symbol" size="1" value="onoff" />
			</attributelist>
		</attribute>
	</attributelist>
	<!--EXAMPLE-->
	<examplelist>
		<example img="hint.png" caption="Provide optional hints to UI objects" />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="comment" />
		<seealso name="umenu" />
	</seealsolist>
	<discussion>
		You can select a <o>hint</o> object and set its font and font size using the Font menu, or use its Get Info... dialog to apply other settings.
	</discussion>
	<misc name="Output">
		<entry name="message">
			<description>
				The message stored in the <o>hint</o> object.
			</description>
		</entry>
	</misc>
</c74object>
