sbPropertyInfo Class Reference

#include <sbPropertyInfo.h>

Inheritance diagram for sbPropertyInfo:
Collaboration diagram for sbPropertyInfo:

Public Member Functions

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 Attributes

PRUint32 mNullSort
PRLock * mSecondarySortLock
nsCOMPtr< sbIPropertyArraymSecondarySort
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< sbIPropertyOperatormOperators
PRLock * mRemoteReadableLock
PRBool mRemoteReadable
PRLock * mRemoteWritableLock
PRBool mRemoteWritable
PRLock * mUnitConverterLock
< sbIPropertyUnitConverter
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
 A unit converter to convert to and from the units in which the property can be expressed. More...
- Protected Member Functions inherited from sbSupportsWeakReference
 ~sbSupportsWeakReference ()
void ClearWeakReferences ()
PRBool HasWeakReferences () const

Detailed Description

Definition at line 98 of file sbPropertyInfo.h.

Constructor & Destructor Documentation

sbPropertyInfo::sbPropertyInfo ( )

Definition at line 92 of file sbPropertyInfo.cpp.

sbPropertyInfo::~sbPropertyInfo ( )

Definition at line 170 of file sbPropertyInfo.cpp.

Member Function Documentation

nsresult sbPropertyInfo::Init ( )

Definition at line 222 of file sbPropertyInfo.cpp.

Here is the caller graph for this function:

NS_IMETHODIMP sbPropertyInfo::SetUnitConverter ( sbIPropertyUnitConverter aUnitConverter)

Definition at line 645 of file sbPropertyInfo.cpp.

Member Data Documentation

nsString sbPropertyInfo::mDisplayName

Definition at line 126 of file sbPropertyInfo.h.

PRLock* sbPropertyInfo::mDisplayNameLock

Definition at line 125 of file sbPropertyInfo.h.

nsString sbPropertyInfo::mID

Definition at line 120 of file sbPropertyInfo.h.

PRLock* sbPropertyInfo::mIDLock

Definition at line 119 of file sbPropertyInfo.h.

nsString sbPropertyInfo::mLocalizationKey

Definition at line 129 of file sbPropertyInfo.h.

PRLock* sbPropertyInfo::mLocalizationKeyLock

Definition at line 128 of file sbPropertyInfo.h.

PRUint32 sbPropertyInfo::mNullSort

Definition at line 114 of file sbPropertyInfo.h.

nsCOMArray<sbIPropertyOperator> sbPropertyInfo::mOperators

Definition at line 138 of file sbPropertyInfo.h.

PRLock* sbPropertyInfo::mOperatorsLock

Definition at line 137 of file sbPropertyInfo.h.

PRBool sbPropertyInfo::mRemoteReadable

Definition at line 141 of file sbPropertyInfo.h.

PRLock* sbPropertyInfo::mRemoteReadableLock

Definition at line 140 of file sbPropertyInfo.h.

PRBool sbPropertyInfo::mRemoteWritable

Definition at line 144 of file sbPropertyInfo.h.

PRLock* sbPropertyInfo::mRemoteWritableLock

Definition at line 143 of file sbPropertyInfo.h.

nsCOMPtr<sbIPropertyArray> sbPropertyInfo::mSecondarySort

Definition at line 117 of file sbPropertyInfo.h.

PRLock* sbPropertyInfo::mSecondarySortLock

Definition at line 116 of file sbPropertyInfo.h.

nsString sbPropertyInfo::mType

Definition at line 123 of file sbPropertyInfo.h.

PRLock* sbPropertyInfo::mTypeLock

Definition at line 122 of file sbPropertyInfo.h.

nsCOMPtr<sbIPropertyUnitConverter> sbPropertyInfo::mUnitConverter

Definition at line 147 of file sbPropertyInfo.h.

PRLock* sbPropertyInfo::mUnitConverterLock

Definition at line 146 of file sbPropertyInfo.h.

PRBool sbPropertyInfo::mUsedInIdentity

Definition at line 150 of file sbPropertyInfo.h.

PRLock* sbPropertyInfo::mUsedInIdentityLock

Definition at line 149 of file sbPropertyInfo.h.

PRBool sbPropertyInfo::mUserEditable

Definition at line 135 of file sbPropertyInfo.h.

PRLock* sbPropertyInfo::mUserEditableLock

Definition at line 134 of file sbPropertyInfo.h.

PRBool sbPropertyInfo::mUserViewable

Definition at line 132 of file sbPropertyInfo.h.

PRLock* sbPropertyInfo::mUserViewableLock

Definition at line 131 of file sbPropertyInfo.h.

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