<?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="live.map" module="m4l" category="Live API Objects">
	<digest>
		Simplify the process of selecting Live interface elements for use with the Live API.
	</digest>
	<description>
		The <o>live.map</o> object encapsulates the process of using the mouse to select Live user interface elements to determine their LOM paths and IDs.
	</description>
	<!--METADATA-->
	<metadatalist>
		<metadata name="author">
			Cycling '74
		</metadata>
		<metadata name="tag">
			Live
		</metadata>
		<metadata name="tag">
			Live API Objects
		</metadata>
	</metadatalist>
	<!--INLETS-->
	<inletlist>
		<inlet id="0" type="INLET_TYPE">
			<digest>
				bang, int, messages in
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
		<inlet id="1" type="INLET_TYPE">
			<digest>
				bang, int, messages in
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
	</inletlist>
	<!--OUTLETS-->
	<outletlist>
		<outlet id="0" type="OUTLET_TYPE">
			<digest>
				path
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
		<outlet id="1" type="OUTLET_TYPE">
			<digest>
				id
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
		<outlet id="2" type="OUTLET_TYPE">
			<digest>
				name
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
		<outlet id="3" type="OUTLET_TYPE">
			<digest>
				mapping 1/0
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
		<outlet id="4" type="OUTLET_TYPE">
			<digest>
				dumpout
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
	</outletlist>
	<!--ARGUMENTS-->
	<objarglist />
	<!--MESSAGES-->
	<methodlist>
		<method name="bang">
			<arglist />
			<digest>
				Start mapping
			</digest>
			<description>
				Begin the process of listening for mouse clicks for Live user interface element selection. Selecting a Live user interface element will automatically stop mapping after outputting the path and ID of the selected element.
			</description>
		</method>
		<method name="int">
			<arglist>
				<arg name="enable" type="int" optional="0" />
			</arglist>
			<digest>
				Start or stop mapping
			</digest>
			<description>
				<m>1</m> in the left inlet of the object will begin the process of listening for mouse clicks for Live user interface element selection. Selecting a Live user interface element will automatically stop mapping after outputting the path and ID of the selected element. A <m>0</m> will manually stop mapping, whether or not a Live user interface element was selected.
			</description>
		</method>
		<method name="cancel">
			<arglist />
			<digest>
				Cancel mapping
			</digest>
			<description>
				Stop mapping if it was started.
			</description>
		</method>
		<method name="getdefault">
			<arglist />
			<digest>
				Retrieve the default value of the mapped element.
			</digest>
			<description>
				Output the default value of the mapped Live user interface element, preceded by the word <m>default</m>, from the rightmost outlet of the object.
			</description>
		</method>
		<method name="getrange">
			<arglist />
			<digest>
				Retrieve the range of the mapped element.
			</digest>
			<description>
				Output the range of the mapped Live user interface element, preceded by the word <m>range</m>, from the rightmost outlet of the object.
			</description>
		</method>
		<method name="unmap">
			<arglist />
			<digest>
				Clear the mapped element.
			</digest>
			<description>
				If an element was previously mapped, clear the internal state of the <m>live.map</m> object, as well as any information about default value, range, etc.
			</description>
		</method>
	</methodlist>
	<!--ATTRIBUTES-->
	<attributelist>
		<attribute name="mapping" get="1" set="1" type="int" size="1">
			<digest>
				Mapping Mode Enabled (listening)
			</digest>
			<description>
				When enabled (<m>1</m>), the <m>live.map</m> object is listening for mouse selection of Live user interface elements. When disabled (<m>0</m>), the object is not listening.
			</description>
			<attributelist>
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Mapping Mode Enabled (listening)" />
				<attribute name="style" get="1" set="1" type="symbol" size="1" value="onoff" />
			</attributelist>
		</attribute>
		<attribute name="strict" get="1" set="1" type="int" size="1">
			<digest>
				Disallow Mapping to This Device
			</digest>
			<description>
				When enabled (<m>1</m>), the <o>live.map</o> object will ignore mouse clicks on Live user interface elements inside the same device as the <m>live.map</m> object.
			</description>
			<attributelist>
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Disallow Mapping to This Device" />
				<attribute name="style" get="1" set="1" type="symbol" size="1" value="onoff" />
			</attributelist>
		</attribute>
	</attributelist>
	<!--EXAMPLE-->
	<examplelist>
		<example caption="" img="" />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="bogus">
			TEXT_HERE
		</seealso>
	</seealsolist>
	<misc name="Output">
		<entry name="Outlets">
			<description>
				The <m>live.map</m> object's outlets send, from right to left:
				<ul>
					<li>
						<m>dumpout</m>: outputs the response to the <m>getdefault</m> and <m>getrange</m> methods, as well as any attribute value queries
					</li>
					<li>
						<m>mapping</m>: outputs the current mapping state (<m>0</m> or <m>1</m>)
					</li>
					<li>
						<m>name</m>: output the element name when mapped (when unmapped, the name <m>&lt;none&gt;</m> will be output)
					</li>
					<li>
						<m>id</m>: output the element LOM ID when mapped (when unmapped, the ID <m>0</m> will be output)
					</li>
					<li>
						<m>path</m>: output the element LOM path when mapped (when unmapped, the path <m>&lt;none&gt;</m> will be output)
					</li>
				</ul>
			</description>
		</entry>
	</misc>
</c74object>
