Develpers' detailed documentation for the Thunderbird Extension for synchronizing a bluetooth phone with Thunderbird/Lightning/Sunbird.
A part of blueZync.

BluezyncPreferences Class Reference

List of all members.

Detailed Description

status for the blueZync preferences window

Class holding the status for the blueZync preferences window


Public Member Functions
void	BluezyncPreferences ()
boolean	checkSettingChanges (string groupName)
	Check whether settings of the current group has changed.
void	disable (nsIElement element, boolean disable)
	disable or enable element and child elements
boolean	loadBluetoothLib ()
	load the bluetooth library
void	onAccept (event event)
	dialog is accepted
void	onAddGroup (event event)
	Called when "add group" button is pressed.
void	onCancel (event event)
	dialog is cancelled
void	onChange (event event)
	currently not used
void	onPluginMenuCommand (event event)
	a plugin is selected
void	onScan (event event)
	called when scan button is pressed
void	onSelect (event event)
	an item in the group list is pressed
void	saveGroup (string groupName)
	Save changes to group into OpenSync.
void	scanForBluetooth ()
	start scanning for bluetooth devices
void	showProgress (int value, string text)
	Show progress.
void	showSplash ()
	Show spash screen (if not already shown) and update version preference.
Public Attributes
string[]	aBookNames
nsIAbDirectory[]	aBooks
int	addressBookRG
IBZBluetooth	bzBluetooth
nsIFile	bzDir
IBZOpenSync	bzOpenSync
int	closeAfterDiscovery
string	currentGroup
int	groupToLoad
int	lastStatus
int	loadedItem
int	mustDiscover
int	pluginMenulist
int	pluginMenupopup
string	prefPrefix
int	progressLabel
int	progressMeter
int	settingsBox
int	settingsDetails
int	settingsDialogHeader
int	settingsGroupName
int	settingsListbox
int	settingsRemoteDevTextbox
int	statusBar
int	timeLeft
int	timeout
int	timeStep
int	topBox

Constructor & Destructor Documentation

void BluezyncPreferences::BluezyncPreferences ( )

Member Function Documentation

boolean BluezyncPreferences::checkSettingChanges ( string groupName )

Check whether settings of the current group has changed.

Check whether settings of the current group has changed

Parameters:

groupName

Returns:: true if settings have changed; false otherwise

void BluezyncPreferences::disable	(	nsIElement	element,
		boolean	disable
	)

disable or enable element and child elements

Disable or enable element and child elements

Parameters:

	element	the element to be disabled
	disable	true to disable; false to enable

boolean BluezyncPreferences::loadBluetoothLib ( )

load the bluetooth library

Load the bluetooth library

some specific error checking if library could not be loaded

Todo:: Improve error checking (what to do if call fails)

Returns:: true on success; false on failure

void BluezyncPreferences::onAccept ( event event )

dialog is accepted

Called when dialog is accepted

Parameters:

event

void BluezyncPreferences::onAddGroup ( event event )

Called when "add group" button is pressed.

Called when "add group" button is pressed

Parameters:

event

void BluezyncPreferences::onCancel ( event event )

dialog is cancelled

Called when dialog is cancelled

Parameters:

event

void BluezyncPreferences::onChange ( event event )

currently not used

Load specified group into the settings box

Parameters:

event

void BluezyncPreferences::onPluginMenuCommand ( event event )

a plugin is selected

Called when a plugin is selected

Parameters:

event

void BluezyncPreferences::onScan ( event event )

called when scan button is pressed

Called when scan button is pressed

Parameters:

event

void BluezyncPreferences::onSelect ( event event )

an item in the group list is pressed

Called when an item in the group list is pressed

Parameters:

event

void BluezyncPreferences::saveGroup ( string groupName )

Save changes to group into OpenSync.

Save changes to group into OpenSync

Parameters:

groupName

void BluezyncPreferences::scanForBluetooth ( )

start scanning for bluetooth devices

Start scanning for bluetooth devices

adjust the window accordingly
set timeout values
"call" startBluetoothScan

void BluezyncPreferences::showProgress	(	int	value,
		string	text
	)

Show progress.

Show progress

Parameters:

	value	zero to 100 (in percent)
	text	the progress text to show

void BluezyncPreferences::showSplash ( )

Show spash screen (if not already shown) and update version preference.

Show spash screen (if not already shown) and update version preference

Returns:

Member Data Documentation

string [] BluezyncPreferences::aBookNames

List of Thunderbird address book names

nsIAbDirectory [] BluezyncPreferences::aBooks

List of Thunderbird address books

int BluezyncPreferences::addressBookRG

the list of groups

IBZBluetooth BluezyncPreferences::bzBluetooth

the main bluetooth object from the components library

nsIFile BluezyncPreferences::bzDir

our directory in the current profile - set by loadOpenSyncLib

IBZOpenSync BluezyncPreferences::bzOpenSync

the main OpenSync object from the components library

int BluezyncPreferences::closeAfterDiscovery

true if we want to close the window after discovery (on OK and Cancel)

string BluezyncPreferences::currentGroup

Name of currently selected group

int BluezyncPreferences::groupToLoad

Name of group we want to load after saving the current one

int BluezyncPreferences::lastStatus

last status returned by the xpcom scan thread

int BluezyncPreferences::loadedItem

item in listbox which is now loaded

int BluezyncPreferences::mustDiscover

true if current group is newly created, and thus must be discovered

int BluezyncPreferences::pluginMenulist

int BluezyncPreferences::pluginMenupopup

string BluezyncPreferences::prefPrefix

Prefix for all preferences defined by blueZync

int BluezyncPreferences::progressLabel

the progress meter

int BluezyncPreferences::progressMeter

the progress meter

int BluezyncPreferences::settingsBox

the box containing the settings

int BluezyncPreferences::settingsDetails

the box containing the details of the settings (excl header)

int BluezyncPreferences::settingsDialogHeader

header for settings

int BluezyncPreferences::settingsGroupName

name of group

int BluezyncPreferences::settingsListbox

the list of groups

int BluezyncPreferences::settingsRemoteDevTextbox

textbox for remote config XML

int BluezyncPreferences::statusBar

the statusbar

int BluezyncPreferences::timeLeft

number of milliseconds left until timeout for the current xpcom scan thread

int BluezyncPreferences::timeout

number of milliseconds to wait for the xpcom scan thread

int BluezyncPreferences::timeStep

number of milliseconds to wait between each time we check for the status of the xpcom scan thread

int BluezyncPreferences::topBox

the box containing the list and settings

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

settings_window.js

blueZync

Synchronize Bluetooth phone with Thunderbird

Users

Developers

Links

blueZync4thunderbird

BluezyncPreferences Class Reference

Detailed Description

Public Member Functions

Public Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation