/*===================================================================================================
AAX_AdditionalFeatures_PropertiesFile.doxygen

Copyright 2024 Avid Technology, Inc. 
All rights reserved.

This file is part of the Avid AAX SDK.

The AAX SDK is subject to commercial or open-source licensing.

By using the AAX SDK, you agree to the terms of both the Avid AAX SDK License
Agreement and Avid Privacy Policy.

AAX SDK License: https://developer.avid.com/aax
Privacy Policy: https://www.avid.com/legal/privacy-policy-statement

Or: You may also use this code under the terms of the GPL v3 (see
www.gnu.org/licenses).

THE AAX SDK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
DISCLAIMED.

===================================================================================================*/

/** @defgroup AdditionalFeatures_PropertiesFile Properties File
	@ingroup AdditionalFeatures
	
	@brief Properties for an %AAX plugin bundle
	
	<H3>About</H3>
	<DIV CLASS="section">

	An XML properties file can optionally be used in an %AAX plugin bundle to provide information to the host prior to loading the plugin binary.

	The file should be named AAXProperties.xml and should be placed in the bundle's Resources folder.

	</DIV>

	<H3>Collection Properties</H3>
	<DIV CLASS="section">

	<TT>AuthDialog</TT> (Optional)
	<UL>
		<LI>
			Required attribute: <TT>type_="bool"</TT>
		</LI>
		<LI>
			Value <TT>true</TT>: Declares that the plugin may show an authorization dialog when loaded.
		</LI>
		<LI>
			Value <TT>false</TT>: Declares that the plugin will never show an authorization dialog when loaded.
		</LI>
	</UL>

	</DIV>

	<H3>Schema</H3>	
	<DIV CLASS="section">

	\code{.xml}
	<?xml version="1.0"?>
	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">

	<xs:element name="AAXPropertiesFile">
		<xs:complexType>
			<xs:element name="Collection">
				<xs:complexType>
					<xs:element name="AuthDialog" minOccurs="0">
						<xs:complexType>
							<xs:simpleContent>
								<xs:extension base="xs:boolean">
									<xs:attribute name="type_" type="xs:string" minOccurs="1" maxOccurs="1" fixed="bool"/>
								</xs:extension>
							</xs:simpleContent>
						</xs:complexType>
					</xs:element>
				</xs:complexType>
			</xs:element>
		</xs:complexType>
	</xs:element>

	</xs:schema>
	\endcode

	</DIV>

	<H3>Example</H3>	
	<DIV CLASS="section">

	\code{.xml}
	<?xml version='1.0' encoding='UTF-8' standalone='yes'?>
	<AAXPropertiesFile>
		<Collection>
			<AuthDialog type_="bool">false</AuthDialog>
		</Collection>
	</AAXPropertiesFile>
	\endcode

	</DIV>


 */
