sbPropertyHelper Class Reference

#include <sbPropertyBagUtils.h>

Public Member Functions
	sbPropertyHelper (nsIPropertyBag *aPropertyBag, const nsAString &aKey, nsresult *aRV=nsnull)
	sbPropertyHelper (nsresult *aRV=nsnull)
template<class T >
	operator T () const
template<class T >
sbPropertyHelper &	operator= (T aValue)
sbPropertyHelper &	operator= (nsIVariant *aValue)
sbPropertyHelper	operator[] (const char *aKey)
nsresult	rv ()

Detailed Description

Definition at line 72 of file sbPropertyBagUtils.h.

Constructor & Destructor Documentation

sbPropertyHelper::sbPropertyHelper ( nsIPropertyBag *  aPropertyBag, const nsAString &  aKey, nsresult *  aRV = nsnull  )

inline

Construct a property helper object for the property with the key specified by aKey from the property bag specified by aPropertyBag. If aRV is specified, return all error results from all methods in aRV.

Parameters

aPropertyBag	Property bag containing property.
aKey	Property key.
aRV	Optional. Return value to use for all methods.

Definition at line 91 of file sbPropertyBagUtils.h.

Here is the caller graph for this function:

sbPropertyHelper::sbPropertyHelper ( nsresult *  aRV = nsnull )

inlineexplicit

Construct an empty property helper object. If aRV is specified, return all error results from all methods in aRV.

Parameters

aRV	Optional. Return value to use for all methods.

Definition at line 111 of file sbPropertyBagUtils.h.

Member Function Documentation

template<class T >

sbPropertyHelper::operator T ( ) const

inline

Return the property value.

Returns

Property value.

Definition at line 127 of file sbPropertyBagUtils.h.

template<class T >

sbPropertyHelper& sbPropertyHelper::operator= ( T  aValue )

inline

Set the property to the value specified by aValue.

Parameters

aValue

Value to which to set property.

Returns

Value.

Definition at line 150 of file sbPropertyBagUtils.h.

sbPropertyHelper& sbPropertyHelper::operator= ( nsIVariant *  aValue )

inline

Set the property value to the variant specified by aValue.

Parameters

aValue

Variant value to which to set property.

Returns

Variant value.

Definition at line 175 of file sbPropertyBagUtils.h.

sbPropertyHelper sbPropertyHelper::operator[] ( const char *  aKey )

inline

Assume that the property value is a property bag. Return the value of the property with the key specified by aKey from the property bag.

Parameters

aKey	Property key.

Returns

Property value.

Definition at line 201 of file sbPropertyBagUtils.h.

Here is the call graph for this function:

nsresult sbPropertyHelper::rv ( )

inline

Return the result of the last method called.

Returns

Reult of last method called.

Definition at line 227 of file sbPropertyBagUtils.h.

---

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

• /home/martin/dev/nightingale-hacking/components/moz/xpcom/src/sbPropertyBagUtils.h