sbDeviceXMLCapabilities Class Reference

#include <sbDeviceXMLCapabilities.h>

Public Member Functions

 sbDeviceXMLCapabilities (nsIDOMElement *aRootElement, sbIDevice *aDevice=nsnull)
 
 ~sbDeviceXMLCapabilities ()
 
nsresult Read (sbIDeviceCapabilities *aCapabilities)
 
PRBool HasCapabilities ()
 

Static Public Member Functions

static nsresult GetCapabilities (sbIDeviceCapabilities **aCapabilities, nsIDOMDocument *aDocument, sbIDevice *aDevice=nsnull)
 
static nsresult GetCapabilities (sbIDeviceCapabilities **aCapabilities, nsIDOMNode *aDeviceCapsRootNode, sbIDevice *aDevice=nsnull)
 
static nsresult AddCapabilities (sbIDeviceCapabilities *aCapabilities, const char *aXMLCapabilitiesSpec, PRBool *aAddedCapabilities=nsnull, sbIDevice *aDevice=nsnull)
 
static nsresult AddCapabilities (sbIDeviceCapabilities *aCapabilities, nsIDOMNode *aDeviceCapsRootNode, PRBool *aAddedCapabilities=nsnull, sbIDevice *aDevice=nsnull)
 

Detailed Description

This class reads an DOM document and adds capabilities based on the content of the document

Definition at line 46 of file sbDeviceXMLCapabilities.h.

Constructor & Destructor Documentation

sbDeviceXMLCapabilities::sbDeviceXMLCapabilities ( nsIDOMElement *  aRootElement,
sbIDevice aDevice = nsnull 
)

Initialize the XML capabilities

Definition at line 57 of file sbDeviceXMLCapabilities.cpp.

sbDeviceXMLCapabilities::~sbDeviceXMLCapabilities ( )

Cleanup

Definition at line 67 of file sbDeviceXMLCapabilities.cpp.

Member Function Documentation

nsresult sbDeviceXMLCapabilities::AddCapabilities ( sbIDeviceCapabilities aCapabilities,
const char *  aXMLCapabilitiesSpec,
PRBool *  aAddedCapabilities = nsnull,
sbIDevice aDevice = nsnull 
)
static

Read the capabilities matching the device specified by aDevice from the file with the URI spec specified by aXMLCapabilitiesSpec and add them to the device capabilities object specified by aCapabilities. If any capabilities were added, return true in aAddedCapabilities; if no capabilities were added (e.g., device didn't match), return false.

Parameters
aCapabilitiesThe capabilities object to which to add capabilities.
aXMLCapabilitiesSpecURI spec of capabilities file.
aAddedCapabilitiesReturned true if capabilities added.
aDeviceDevice to match against capabilities.

Definition at line 179 of file sbDeviceXMLCapabilities.cpp.

nsresult sbDeviceXMLCapabilities::AddCapabilities ( sbIDeviceCapabilities aCapabilities,
nsIDOMNode *  aDeviceCapsRootNode,
PRBool *  aAddedCapabilities = nsnull,
sbIDevice aDevice = nsnull 
)
static

Read the capabilities matching the device specified by aDevice from the root DOM node specified by aDeviceCapsRootNode and add them to the device capabilities object specified by aCapabilities. If any capabilities were added, return true in aAddedCapabilities; if no capabilities were added (e.g., device didn't match), return false.

Parameters
aCapabilitiesThe capabilities object to which to add capabilities.
aDeviceCapsRootNodeRoot DOM node from which to get capabilities.
aAddedCapabilitiesReturned true if capabilities added.
aDeviceDevice to match against capabilities.

Definition at line 240 of file sbDeviceXMLCapabilities.cpp.

nsresult sbDeviceXMLCapabilities::GetCapabilities ( sbIDeviceCapabilities **  aCapabilities,
nsIDOMDocument *  aDocument,
sbIDevice aDevice = nsnull 
)
static

Read the capabilities matching the device specified by aDevice from the document specified by aDocument and return them in aCapabilities. If no matching capabilities are present, return null in aCapabilities.

Parameters
aCapabilitiesReturned device capabilities.
aDocumentDocument from which to get capabilities.
aDeviceDevice to match against capabilities.

Definition at line 109 of file sbDeviceXMLCapabilities.cpp.

Here is the caller graph for this function:

nsresult sbDeviceXMLCapabilities::GetCapabilities ( sbIDeviceCapabilities **  aCapabilities,
nsIDOMNode *  aDeviceCapsRootNode,
sbIDevice aDevice = nsnull 
)
static

Read the capabilities matching the device specified by aDevice from the root DOM noded specified by aDeviceCapsRootNode and return them in aCapabilities. If no matching capabilities are present, return null in aCapabilities.

Parameters
aCapabilitiesReturned device capabilities.
aDeviceCapsRootNodeRoot DOM node from which to get capabilities.
aDeviceDevice to match against capabilities.

Definition at line 137 of file sbDeviceXMLCapabilities.cpp.

Here is the call graph for this function:

PRBool sbDeviceXMLCapabilities::HasCapabilities ( )
inline

Return true if DOM document contains device capabilities.

Returns
true if DOM document contains device capabilities.

Definition at line 67 of file sbDeviceXMLCapabilities.h.

Here is the caller graph for this function:

nsresult sbDeviceXMLCapabilities::Read ( sbIDeviceCapabilities aCapabilities)

Reads in the capabilities and sets them on aCapabilities

Parameters
aCapabilitiesThe capabilities object to update

Definition at line 94 of file sbDeviceXMLCapabilities.cpp.

Here is the caller graph for this function:


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