sbIURLFormatter Interface Reference

import"sbIURLFormatter.idl";

Inheritance diagram for sbIURLFormatter:

Collaboration diagram for sbIURLFormatter:

Public Member Functions
AString	formatURL (in AString aFormat, [optional] in nsIPropertyBag aMappings)
AString	formatURLPref (in AString aPref, [optional] in nsIPropertyBag aMappings)

Detailed Description

This interface is identical to the proposed changes to the mozilla nsIURLFormatter interface as detailed in the bmo bug 430235.

Implementors of this interface will replace all instances of the keys in the propertyBag for their associated keys in the string passed in, or the preference value it refers to. They may have a set of pre-defined default keys.

The sbURLFormatter object predefines these keys to match the impl defined in the nsURLFormatter class: LOCALE VENDOR NAME ID VERSION APPBUILDID PLATFORMVERSION PLATFORM_VERSION APP OS XPCOMABI

The sbURLFormatter object also defines these keys using the impl defined in the nsUpdateService class. DISTRIBUTION DISTRIBUTION_VERSION OS_VERSION PRODUCT BUILD_ID BUILD_TARGET CHANNEL

"@songbirdnest.com/moz/sburlformatter;1" Use get service with this component.

Definition at line 73 of file sbIURLFormatter.idl.

Member Function Documentation

AString sbIURLFormatter::formatURL	(	in AString	aFormat,
		[optional] in nsIPropertyBag	aMappings
	)

formatURL - Formats a string URL

Parameters

aFormat	string
aMappings	PropertyBag - additional key/value pairs to replace beyond the defaults.

AString sbIURLFormatter::formatURLPref	(	in AString	aPref,
		[optional] in nsIPropertyBag	aMappings
	)

formatURLPref - Formats a string URL stored in a pref

Parameters

aFormat	string
aMappings	PropertyBag - additional key/value pairs to replace beyond the defaults.

---

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

• /home/martin/dev/nightingale-hacking/components/moz/urlformatter/public/sbIURLFormatter.idl