#include <sbTextPropertyInfo.h>

Inheritance diagram for sbTextPropertyInfo:

Collaboration diagram for sbTextPropertyInfo:

Public Member Functions
NS_DECL_ISUPPORTS_INHERITED NS_IMETHOD	GetOPERATOR_EQUALS (nsAString &aOPERATOR_EQUALS)

NS_IMETHOD	GetOPERATOR_NOTEQUALS (nsAString &aOPERATOR_NOTEQUALS)

NS_IMETHOD	GetOPERATOR_GREATER (nsAString &aOPERATOR_GREATER)

NS_IMETHOD	GetOPERATOR_GREATEREQUAL (nsAString &aOPERATOR_GREATEREQUAL)

NS_IMETHOD	GetOPERATOR_LESS (nsAString &aOPERATOR_LESS)

NS_IMETHOD	GetOPERATOR_LESSEQUAL (nsAString &aOPERATOR_LESSEQUAL)

NS_IMETHOD	GetOPERATOR_CONTAINS (nsAString &aOPERATOR_CONTAINS)

NS_IMETHOD	GetOPERATOR_NOTCONTAINS (nsAString &aOPERATOR_NOTCONTAINS)

NS_IMETHOD	GetOPERATOR_BEGINSWITH (nsAString &aOPERATOR_BEGINSWITH)

NS_IMETHOD	GetOPERATOR_NOTBEGINSWITH (nsAString &aOPERATOR_NOTBEGINSWITH)

NS_IMETHOD	GetOPERATOR_ENDSWITH (nsAString &aOPERATOR_ENDSWITH)

NS_IMETHOD	GetOPERATOR_NOTENDSWITH (nsAString &aOPERATOR_NOTENDSWITH)

NS_IMETHOD	GetOPERATOR_BETWEEN (nsAString &aOPERATOR_BETWEEN)

NS_IMETHOD	GetOPERATOR_ISSET (nsAString &aOPERATOR_ISSET)

NS_IMETHOD	GetOPERATOR_ISNOTSET (nsAString &aOPERATOR_ISNOTSET)

NS_IMETHOD	GetNullSort (PRUint32 *aNullSort)

NS_IMETHOD	SetNullSort (PRUint32 aNullSort)

NS_IMETHOD	GetSecondarySort (sbIPropertyArray **aSecondarySort)

NS_IMETHOD	SetSecondarySort (sbIPropertyArray *aSecondarySort)

NS_IMETHOD	GetId (nsAString &aID)

NS_IMETHOD	SetId (const nsAString &aID)

NS_IMETHOD	GetType (nsAString &aType)

NS_IMETHOD	SetType (const nsAString &aType)

NS_IMETHOD	GetDisplayName (nsAString &aDisplayName)

NS_IMETHOD	SetDisplayName (const nsAString &aDisplayName)

NS_IMETHOD	GetLocalizationKey (nsAString &aLocalizationKey)

NS_IMETHOD	SetLocalizationKey (const nsAString &aLocalizationKey)

NS_IMETHOD	GetUserViewable (PRBool *aUserViewable)

NS_IMETHOD	SetUserViewable (PRBool aUserViewable)

NS_IMETHOD	GetUserEditable (PRBool *aUserEditable)

NS_IMETHOD	SetUserEditable (PRBool aUserEditable)

NS_IMETHOD	GetRemoteReadable (PRBool *aRemoteReadable)

NS_IMETHOD	SetRemoteReadable (PRBool aRemoteReadable)

NS_IMETHOD	GetRemoteWritable (PRBool *aRemoteWritable)

NS_IMETHOD	SetRemoteWritable (PRBool aRemoteWritable)

NS_IMETHOD	GetOperators (nsISimpleEnumerator **aOperators)

NS_IMETHOD	SetOperators (nsISimpleEnumerator *aOperators)

NS_IMETHOD	GetOperator (const nsAString &aOperator, sbIPropertyOperator **_retval)

NS_IMETHOD	SetUnitConverter (sbIPropertyUnitConverter *aUnitConverter)

NS_IMETHOD	GetUnitConverter (sbIPropertyUnitConverter **retVal)

NS_IMETHOD	GetUsedInIdentity (PRBool *aUsedInIdentity)

NS_IMETHOD	SetUsedInIdentity (PRBool aUsedInIdentity)

NS_DECL_SBITEXTPROPERTYINFO	sbTextPropertyInfo ()

virtual	~sbTextPropertyInfo ()

nsresult	Init ()

NS_IMETHOD	Validate (const nsAString &aValue, PRBool *_retval)

NS_IMETHOD	Sanitize (const nsAString &aValue, nsAString &_retval)

NS_IMETHOD	Format (const nsAString &aValue, nsAString &_retval)

NS_IMETHOD	MakeSortable (const nsAString &aValue, nsAString &_retval)

NS_IMETHOD	MakeSearchable (const nsAString &aValue, nsAString &_retval)

Public Member Functions inherited from sbPropertyInfo
NS_DECL_ISUPPORTS NS_DECL_SBIPROPERTYINFO	sbPropertyInfo ()

virtual	~sbPropertyInfo ()

NS_IMETHOD	SetUnitConverter (sbIPropertyUnitConverter *aUnitConverter)

nsresult	Init ()

Public Member Functions inherited from sbIPropertyInfo
sbIPropertyOperator	getOperator (in AString aOperator)
	Get the sbIPropertyOperator for the given operator string. More...

boolean	validate (in AString aValue)
	Validates the string for this property type. More...

AString	sanitize (in AString aValue)
	Sanitize a value so that it passes validation. More...

AString	format (in AString aValue)
	Formats the value for display. More...

AString	makeSortable (in AString aValue)
	Transforms the string into its sortable collation data equivalent. More...

AString	makeSearchable (in AString aValue)
	Formats the value to enable proper search. More...

Public Member Functions inherited from sbSupportsWeakReference
	sbSupportsWeakReference ()

Protected Member Functions
nsresult	InitializeOperators ()

Protected Member Functions inherited from sbSupportsWeakReference
	~sbSupportsWeakReference ()

void	ClearWeakReferences ()

PRBool	HasWeakReferences () const

Protected Attributes
PRLock *	mMinMaxLock

PRUint32	mMinLen

PRUint32	mMaxLen

PRLock *	mEnforceLowercaseLock

PRBool	mEnforceLowercase

PRLock *	mNoCompressWhitespaceLock

PRBool	mNoCompressWhitespace

Protected Attributes inherited from sbPropertyInfo
PRUint32	mNullSort

PRLock *	mSecondarySortLock

nsCOMPtr< sbIPropertyArray >	mSecondarySort

PRLock *	mIDLock

nsString	mID

PRLock *	mTypeLock

nsString	mType

PRLock *	mDisplayNameLock

nsString	mDisplayName

PRLock *	mLocalizationKeyLock

nsString	mLocalizationKey

PRLock *	mUserViewableLock

PRBool	mUserViewable

PRLock *	mUserEditableLock

PRBool	mUserEditable

PRLock *	mOperatorsLock

nsCOMArray< sbIPropertyOperator >	mOperators

PRLock *	mRemoteReadableLock

PRBool	mRemoteReadable

PRLock *	mRemoteWritableLock

PRBool	mRemoteWritable

PRLock *	mUnitConverterLock

nsCOMPtr < sbIPropertyUnitConverter >	mUnitConverter

PRLock *	mUsedInIdentityLock

PRBool	mUsedInIdentity

Additional Inherited Members
Public Attributes inherited from sbIPropertyInfo
readonly attribute AString	OPERATOR_EQUALS

readonly attribute AString	OPERATOR_NOTEQUALS

readonly attribute AString	OPERATOR_GREATER

readonly attribute AString	OPERATOR_GREATEREQUAL

readonly attribute AString	OPERATOR_LESS

readonly attribute AString	OPERATOR_LESSEQUAL

readonly attribute AString	OPERATOR_CONTAINS

readonly attribute AString	OPERATOR_NOTCONTAINS

readonly attribute AString	OPERATOR_BEGINSWITH

readonly attribute AString	OPERATOR_NOTBEGINSWITH

readonly attribute AString	OPERATOR_ENDSWITH

readonly attribute AString	OPERATOR_NOTENDSWITH

readonly attribute AString	OPERATOR_BETWEEN

readonly attribute AString	OPERATOR_ISSET

readonly attribute AString	OPERATOR_ISNOTSET

const unsigned long	SORT_NULL_SMALL = 0
	Causes null values to be infinitely small. This is the default. More...

const unsigned long	SORT_NULL_BIG = 1
	Causes null values to be infinitely large. More...

const unsigned long	SORT_NULL_FIRST = 2
	Null values always first. More...

const unsigned long	SORT_NULL_LAST = 3
	Null values always last. More...

attribute unsigned long	nullSort
	Set where NULL values get sorted to. More...

attribute sbIPropertyArray	secondarySort
	When sorting by this property, additionally sort by the following properties. More...

attribute AString	id
	Unique ID for this property. More...

attribute AString	type
	The type property. More...

attribute AString	displayName
	Localized display name of this property. More...

attribute AString	localizationKey
	Key used to find related localization strings. More...

attribute boolean	userViewable
	A user may view this property. This does not impede reading the value, it's merely meant as a guideline. More...

attribute boolean	userEditable
	A user may edit this property. This does not impede editing the value, it's merely meant as a guideline. More...

attribute boolean	remoteReadable
	A web site may read the value of this property. More...

attribute boolean	remoteWritable
	A web site may write the value of this property. More...

attribute boolean	usedInIdentity
	This attribute indicates that changing this property may change the computed hash for the item. If a property with usedInIdentity of true is changed, the identity is recalculated. More...

attribute nsISimpleEnumerator	operators
	True if this property has a selection list. More...

readonly attribute sbIPropertyUnitConverter	unitConverter
	A unit converter to convert to and from the units in which the property can be expressed. More...

Public Attributes inherited from sbITextPropertyInfo
attribute unsigned long	minLength
	Minimum length of string. More...

attribute unsigned long	maxLength
	Maximum length of string. More...

attribute boolean	enforceLowercase
	Must be lowercase (only valid for languages where this applies) More...

attribute boolean	noCompressWhitespace
	The property value should not be formatted. More...

Detailed Description

Definition at line 36 of file sbTextPropertyInfo.h.

Constructor & Destructor Documentation

NS_INTERFACE_TABLE_BEGIN NS_INTERFACE_TABLE_END sbTextPropertyInfo::sbTextPropertyInfo ( )

Definition at line 51 of file sbTextPropertyInfo.cpp.

sbTextPropertyInfo::~sbTextPropertyInfo ( )

virtual

Definition at line 75 of file sbTextPropertyInfo.cpp.

Member Function Documentation

NS_IMETHODIMP sbTextPropertyInfo::Format	(	const nsAString &	aValue,
		nsAString &	_retval
	)

Definition at line 195 of file sbTextPropertyInfo.cpp.

Here is the call graph for this function:

NS_IMETHOD sbTextPropertyInfo::GetDisplayName ( nsAString & aDisplayName )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetId ( nsAString & aID )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetLocalizationKey ( nsAString & aLocalizationKey )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetNullSort ( PRUint32 * aNullSort )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetOperator	(	const nsAString &	aOperator,
		sbIPropertyOperator **	_retval
	)

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetOPERATOR_BEGINSWITH ( nsAString & aOPERATOR_BEGINSWITH )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetOPERATOR_BETWEEN ( nsAString & aOPERATOR_BETWEEN )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetOPERATOR_CONTAINS ( nsAString & aOPERATOR_CONTAINS )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetOPERATOR_ENDSWITH ( nsAString & aOPERATOR_ENDSWITH )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_DECL_ISUPPORTS_INHERITED NS_IMETHOD sbTextPropertyInfo::GetOPERATOR_EQUALS ( nsAString & aOPERATOR_EQUALS )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetOPERATOR_GREATER ( nsAString & aOPERATOR_GREATER )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetOPERATOR_GREATEREQUAL ( nsAString & aOPERATOR_GREATEREQUAL )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetOPERATOR_ISNOTSET ( nsAString & aOPERATOR_ISNOTSET )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetOPERATOR_ISSET ( nsAString & aOPERATOR_ISSET )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetOPERATOR_LESS ( nsAString & aOPERATOR_LESS )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetOPERATOR_LESSEQUAL ( nsAString & aOPERATOR_LESSEQUAL )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetOPERATOR_NOTBEGINSWITH ( nsAString & aOPERATOR_NOTBEGINSWITH )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetOPERATOR_NOTCONTAINS ( nsAString & aOPERATOR_NOTCONTAINS )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetOPERATOR_NOTENDSWITH ( nsAString & aOPERATOR_NOTENDSWITH )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetOPERATOR_NOTEQUALS ( nsAString & aOPERATOR_NOTEQUALS )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetOperators ( nsISimpleEnumerator ** aOperators )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetRemoteReadable ( PRBool * aRemoteReadable )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetRemoteWritable ( PRBool * aRemoteWritable )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetSecondarySort ( sbIPropertyArray ** aSecondarySort )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetType ( nsAString & aType )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetUnitConverter ( sbIPropertyUnitConverter ** retVal )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetUsedInIdentity ( PRBool * aUsedInIdentity )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetUserEditable ( PRBool * aUserEditable )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::GetUserViewable ( PRBool * aUserViewable )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

nsresult sbTextPropertyInfo::Init ( )

Definition at line 91 of file sbTextPropertyInfo.cpp.

Here is the call graph for this function:

nsresult sbTextPropertyInfo::InitializeOperators ( )

protected

Definition at line 105 of file sbTextPropertyInfo.cpp.

Here is the caller graph for this function:

NS_IMETHODIMP sbTextPropertyInfo::MakeSearchable	(	const nsAString &	aValue,
		nsAString &	_retval
	)

Definition at line 298 of file sbTextPropertyInfo.cpp.

Here is the call graph for this function:

NS_IMETHODIMP sbTextPropertyInfo::MakeSortable	(	const nsAString &	aValue,
		nsAString &	_retval
	)

Definition at line 253 of file sbTextPropertyInfo.cpp.

Here is the call graph for this function:

NS_IMETHODIMP sbTextPropertyInfo::Sanitize	(	const nsAString &	aValue,
		nsAString &	_retval
	)

Definition at line 190 of file sbTextPropertyInfo.cpp.

NS_IMETHOD sbTextPropertyInfo::SetDisplayName ( const nsAString & aDisplayName )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::SetId ( const nsAString & aID )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::SetLocalizationKey ( const nsAString & aLocalizationKey )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::SetNullSort ( PRUint32 aNullSort )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::SetOperators ( nsISimpleEnumerator * aOperators )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::SetRemoteReadable ( PRBool aRemoteReadable )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::SetRemoteWritable ( PRBool aRemoteWritable )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::SetSecondarySort ( sbIPropertyArray * aSecondarySort )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::SetType ( const nsAString & aType )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::SetUnitConverter ( sbIPropertyUnitConverter * aUnitConverter )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::SetUsedInIdentity ( PRBool aUsedInIdentity )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::SetUserEditable ( PRBool aUserEditable )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHOD sbTextPropertyInfo::SetUserViewable ( PRBool aUserViewable )

inline

Definition at line 41 of file sbTextPropertyInfo.h.

NS_IMETHODIMP sbTextPropertyInfo::Validate	(	const nsAString &	aValue,
		PRBool *	_retval
	)

Definition at line 170 of file sbTextPropertyInfo.cpp.

Here is the caller graph for this function:

Member Data Documentation

PRBool sbTextPropertyInfo::mEnforceLowercase

protected

Definition at line 64 of file sbTextPropertyInfo.h.

PRLock* sbTextPropertyInfo::mEnforceLowercaseLock

protected

Definition at line 63 of file sbTextPropertyInfo.h.

PRUint32 sbTextPropertyInfo::mMaxLen

protected

Definition at line 61 of file sbTextPropertyInfo.h.

PRUint32 sbTextPropertyInfo::mMinLen

protected

Definition at line 60 of file sbTextPropertyInfo.h.

PRLock* sbTextPropertyInfo::mMinMaxLock

protected

Definition at line 58 of file sbTextPropertyInfo.h.

PRBool sbTextPropertyInfo::mNoCompressWhitespace

protected

Definition at line 67 of file sbTextPropertyInfo.h.

PRLock* sbTextPropertyInfo::mNoCompressWhitespaceLock

protected

Definition at line 66 of file sbTextPropertyInfo.h.

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

/home/martin/dev/nightingale-hacking/components/property/src/sbTextPropertyInfo.h
/home/martin/dev/nightingale-hacking/components/property/src/sbTextPropertyInfo.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation