AgateLib.Drivers.AgateDriverInfo Class Reference

Class which describes a driver for use by AgateLib. A class inheriting from AgateDriverReporter should construct AgateDriverInfo instances for each driver in a plug-in assembly. More...

List of all members.

Public Member Functions
	AgateDriverInfo (DisplayTypeID typeID, Type driverType, string friendlyName, int priority)
	Constructs an AgateDriverInfo for a display driver.
	AgateDriverInfo (AudioTypeID typeID, Type driverType, string friendlyName, int priority)
	Constructs an AgateDriverInfo for an audio driver.
	AgateDriverInfo (InputTypeID typeID, Type driverType, string friendlyName, int priority)
	Constructs an AgateDriverInfo for an input driver.
	AgateDriverInfo (DesktopTypeID typeID, Type driverType, string friendlyName, int priority)
	Constructs an AgateDriverInfo for a desktop driver.
Properties
string	DriverTypeName [get]
	Gets the fully qualified type name of the type implementing the driver routines.
string	FriendlyName [get]
	Gets the friendly name that may be displayed to the user which identifies this driver.
DriverType	DriverType [get]
	Gets the type of driver.
int	DriverTypeID [get]
	Gets the type id of this driver. This value should be cast to DisplayTypeID, AudioTypeID, etc. depending on the value of DriverType.
int	Priority [get]
	Gets the priority of this driver when autoselecting which driver to use.
string	AssemblyName [get, set]
	Full name of the assembly.
string	AssemblyFile [get, set]
	Path to the assembly.

---

Detailed Description

Class which describes a driver for use by AgateLib. A class inheriting from AgateDriverReporter should construct AgateDriverInfo instances for each driver in a plug-in assembly.

---

Constructor & Destructor Documentation

AgateLib.Drivers.AgateDriverInfo.AgateDriverInfo	(	DisplayTypeID	typeID,
		Type	driverType,
		string	friendlyName,
		int	priority
	)

Constructs an AgateDriverInfo for a display driver.

Parameters:

	typeID	The DisplayTypeID member indicating what the driver uses.
	driverType	The System.Type object for the type inheriting from DisplayImpl.
	friendlyName	A friendly name to show the user when choosing a driver.
	priority	A integer indicating the priority of this driver over others which is used when autoselecting a driver.

AgateLib.Drivers.AgateDriverInfo.AgateDriverInfo	(	AudioTypeID	typeID,
		Type	driverType,
		string	friendlyName,
		int	priority
	)

Constructs an AgateDriverInfo for an audio driver.

Parameters:

	typeID	The AudioTypeID member indicating what the driver uses.
	driverType	The System.Type object for the type inheriting from AudioImpl.
	friendlyName	A friendly name to show the user when choosing a driver.
	priority	A integer indicating the priority of this driver over others which is used when autoselecting a driver.

AgateLib.Drivers.AgateDriverInfo.AgateDriverInfo	(	InputTypeID	typeID,
		Type	driverType,
		string	friendlyName,
		int	priority
	)

Constructs an AgateDriverInfo for an input driver.

Parameters:

	typeID	The InputTypeID member indicating what the driver uses.
	driverType	The System.Type object for the type inheriting from InputImpl.
	friendlyName	A friendly name to show the user when choosing a driver.
	priority	A integer indicating the priority of this driver over others which is used when autoselecting a driver.

AgateLib.Drivers.AgateDriverInfo.AgateDriverInfo	(	DesktopTypeID	typeID,
		Type	driverType,
		string	friendlyName,
		int	priority
	)

Constructs an AgateDriverInfo for a desktop driver.

Parameters:

	typeID	The DesktopTypeID member indicating what the driver uses.
	driverType	The System.Type object for the type implementing IDesktopDriver.
	friendlyName	A friendly name to show the user when choosing a driver.
	priority	A integer indicating the priority of this driver over others which is used when autoselecting a driver.

---

Property Documentation

string AgateLib.Drivers.AgateDriverInfo.AssemblyFile [get, set]

Path to the assembly.

string AgateLib.Drivers.AgateDriverInfo.AssemblyName [get, set]

Full name of the assembly.

DriverType AgateLib.Drivers.AgateDriverInfo.DriverType [get]

Gets the type of driver.

int AgateLib.Drivers.AgateDriverInfo.DriverTypeID [get]

Gets the type id of this driver. This value should be cast to DisplayTypeID, AudioTypeID, etc. depending on the value of DriverType.

string AgateLib.Drivers.AgateDriverInfo.DriverTypeName [get]

Gets the fully qualified type name of the type implementing the driver routines.

string AgateLib.Drivers.AgateDriverInfo.FriendlyName [get]

Gets the friendly name that may be displayed to the user which identifies this driver.

int AgateLib.Drivers.AgateDriverInfo.Priority [get]

Gets the priority of this driver when autoselecting which driver to use.

---

The documentation for this class was generated from the following file:

• Drivers/AgateDriverInfo.cs