sbINumberPropertyInfo Interface Reference

The property information specific to numeric fields. More...

import"sbIPropertyInfo.idl";

Inheritance diagram for sbINumberPropertyInfo:
[legend]
Collaboration diagram for sbINumberPropertyInfo:
[legend]

Public Attributes

const unsigned long RADIX_8 = 8
 Unsigned octal representation (eg. 16, or 14 decimal). More...
 
const unsigned long RADIX_10 = 10
 Signed decimal representation (eg. 14 decimal) More...
 
const unsigned long RADIX_16 = 16
 Unsigned hex representation (eg. 0x0E, or 14 decimal) More...
 
const unsigned long FLOAT = 0
 Signed floating point representation (eg. 14.89) More...
 
attribute long long minValue
 Minimum value allowed. More...
 
attribute long long maxValue
 Minimum value allowed. More...
 
attribute double minFloatValue
 Minimum floating point value allowed if number property is a float. More...
 
attribute double maxFloatValue
 Maximum float point value allowed if a number property is a float. More...
 
attribute unsigned long radix
 Radix (must be RADIX_8, RADIX_10, RADIX_16 or FLOAT). More...
 
- 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...
 

Additional Inherited Members

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

Detailed Description

The property information specific to numeric fields.

See Also
sbIPropertyInfo

Definition at line 260 of file sbIPropertyInfo.idl.

Member Data Documentation

const unsigned long sbINumberPropertyInfo::FLOAT = 0

Signed floating point representation (eg. 14.89)

Definition at line 280 of file sbIPropertyInfo.idl.

attribute double sbINumberPropertyInfo::maxFloatValue

Maximum float point value allowed if a number property is a float.

Definition at line 300 of file sbIPropertyInfo.idl.

attribute long long sbINumberPropertyInfo::maxValue

Minimum value allowed.

Definition at line 290 of file sbIPropertyInfo.idl.

attribute double sbINumberPropertyInfo::minFloatValue

Minimum floating point value allowed if number property is a float.

Definition at line 295 of file sbIPropertyInfo.idl.

attribute long long sbINumberPropertyInfo::minValue

Minimum value allowed.

Definition at line 285 of file sbIPropertyInfo.idl.

attribute unsigned long sbINumberPropertyInfo::radix

Radix (must be RADIX_8, RADIX_10, RADIX_16 or FLOAT).

Definition at line 305 of file sbIPropertyInfo.idl.

const unsigned long sbINumberPropertyInfo::RADIX_10 = 10

Signed decimal representation (eg. 14 decimal)

Definition at line 270 of file sbIPropertyInfo.idl.

const unsigned long sbINumberPropertyInfo::RADIX_16 = 16

Unsigned hex representation (eg. 0x0E, or 14 decimal)

Definition at line 275 of file sbIPropertyInfo.idl.

const unsigned long sbINumberPropertyInfo::RADIX_8 = 8

Unsigned octal representation (eg. 16, or 14 decimal).

Definition at line 265 of file sbIPropertyInfo.idl.


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