sbImmutablePropertyInfo Class Reference

#include <sbImmutablePropertyInfo.h>

Inheritance diagram for sbImmutablePropertyInfo:
Collaboration diagram for sbImmutablePropertyInfo:

Public Member Functions

sbImmutablePropertyInfo ()
virtual ~sbImmutablePropertyInfo ()
NS_IMETHOD SetUnitConverter (sbIPropertyUnitConverter *aUnitConverter)
- 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 Init ()
- Protected Member Functions inherited from sbSupportsWeakReference
 ~sbSupportsWeakReference ()
void ClearWeakReferences ()
PRBool HasWeakReferences () const

Protected Attributes

PRUint32 mNullSort
nsCOMPtr< sbIPropertyArraymSecondarySort
nsString mID
nsString mType
nsString mDisplayName
nsString mLocalizationKey
PRBool mUserViewable
PRBool mUserEditable
PRBool mRemoteReadable
PRBool mRemoteWritable
PRBool mUsedInIdentity
nsCOMPtr< nsIStringBundle > mBundle
PRLock * mOperatorsLock
nsCOMArray< sbIPropertyOperatormOperators
< sbIPropertyUnitConverter

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...

Detailed Description

Definition at line 42 of file sbImmutablePropertyInfo.h.

Constructor & Destructor Documentation

sbImmutablePropertyInfo::sbImmutablePropertyInfo ( )

Definition at line 40 of file sbImmutablePropertyInfo.cpp.

sbImmutablePropertyInfo::~sbImmutablePropertyInfo ( )

Definition at line 58 of file sbImmutablePropertyInfo.cpp.

Member Function Documentation

nsresult sbImmutablePropertyInfo::Init ( )

Definition at line 65 of file sbImmutablePropertyInfo.cpp.

Here is the caller graph for this function:

NS_IMETHODIMP sbImmutablePropertyInfo::SetUnitConverter ( sbIPropertyUnitConverter aUnitConverter)

Definition at line 432 of file sbImmutablePropertyInfo.cpp.

Member Data Documentation

nsCOMPtr<nsIStringBundle> sbImmutablePropertyInfo::mBundle

Definition at line 69 of file sbImmutablePropertyInfo.h.

nsString sbImmutablePropertyInfo::mDisplayName

Definition at line 62 of file sbImmutablePropertyInfo.h.

nsString sbImmutablePropertyInfo::mID

Definition at line 60 of file sbImmutablePropertyInfo.h.

nsString sbImmutablePropertyInfo::mLocalizationKey

Definition at line 63 of file sbImmutablePropertyInfo.h.

PRUint32 sbImmutablePropertyInfo::mNullSort

Definition at line 58 of file sbImmutablePropertyInfo.h.

nsCOMArray<sbIPropertyOperator> sbImmutablePropertyInfo::mOperators

Definition at line 71 of file sbImmutablePropertyInfo.h.

PRLock* sbImmutablePropertyInfo::mOperatorsLock

Definition at line 70 of file sbImmutablePropertyInfo.h.

PRBool sbImmutablePropertyInfo::mRemoteReadable

Definition at line 66 of file sbImmutablePropertyInfo.h.

PRBool sbImmutablePropertyInfo::mRemoteWritable

Definition at line 67 of file sbImmutablePropertyInfo.h.

nsCOMPtr<sbIPropertyArray> sbImmutablePropertyInfo::mSecondarySort

Definition at line 59 of file sbImmutablePropertyInfo.h.

nsString sbImmutablePropertyInfo::mType

Definition at line 61 of file sbImmutablePropertyInfo.h.

nsCOMPtr<sbIPropertyUnitConverter> sbImmutablePropertyInfo::mUnitConverter

Definition at line 73 of file sbImmutablePropertyInfo.h.

PRBool sbImmutablePropertyInfo::mUsedInIdentity

Definition at line 68 of file sbImmutablePropertyInfo.h.

PRBool sbImmutablePropertyInfo::mUserEditable

Definition at line 65 of file sbImmutablePropertyInfo.h.

PRBool sbImmutablePropertyInfo::mUserViewable

Definition at line 64 of file sbImmutablePropertyInfo.h.

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