Songbird / Development / Songbird Add-Ons API Documentation

sbIDeviceHelper Interface Reference

import "sbIDeviceHelper.idl";

List of all members.

Public Member Functions

boolean hasSpaceForWrite (in unsigned long long aSpaceNeeded, in sbIDeviceLibrary aLibrary,[optional] in sbIDevice aDevice,[optional] out unsigned long long aSpaceRemaining)
boolean queryUserSpaceExceeded (in nsIDOMWindow aParent, in sbIDevice aDevice, in boolean aSyncDeviceOperation, in unsigned long long aSpaceNeeded, in unsigned long long aSpaceAvailable)


Detailed Description

Note:
This interface is NOT expected to be threadsafe
Helper routines for device implementations

Definition at line 45 of file sbIDeviceHelper.idl.


Member Function Documentation

boolean sbIDeviceHelper::hasSpaceForWrite ( in unsigned long long  aSpaceNeeded,
in sbIDeviceLibrary  aLibrary,
[optional] in sbIDevice  aDevice,
[optional] out unsigned long long  aSpaceRemaining 
)

Check if a given device library has space for a write request Will prompt the user for a partial write if not enough

Parameters:
aSpaceNeeded the amount of space required, in bytes
aLibrary the device library to write to
aDevice the device to write to; if not supplied, will attempt to determine based on the library (slow)
aSpaceRemaining [optional] the amount of space available
Returns:
True if the write should proceed (even partially), false if not

boolean sbIDeviceHelper::queryUserSpaceExceeded ( in nsIDOMWindow  aParent,
in sbIDevice  aDevice,
in boolean  aSyncDeviceOperation,
in unsigned long long  aSpaceNeeded,
in unsigned long long  aSpaceAvailable 
)

Ask the user what action to take in response to an operation space exceeded event for the device specified by aDevice. Use the window specified by aParent as a dialog parent. If aSync is true, the operation is a sync device operation. The amount of space needed for the operation is specified by aSpaceNeeded and the amount available by aSpaceAvailable. Return true if user chooses to proceed with operation.

Parameters:
aParent the parent window for dialogs
aDevice target device of operation
aSync True if operation is a sync device operation
aSpaceNeeded Space needed by operation
aSpaceAvailable Space available to operation
Returns:
True if operation should proceed (even partially), false if not


The documentation for this interface was generated from the following file:
Generated on Tue Mar 10 14:28:58 2009 for Songbird by  doxygen 1.5.2