import "sbIPropertyManager.idl";
Inheritance diagram for sbIPropertyInfo:
Public Member Functions | |
sbIPropertyOperator | getOperator (in AString aOperator) |
Get the sbIPropertyOperator for the given operator string. | |
boolean | validate (in AString aValue) |
Validates the string for this property type. | |
AString | sanitize (in AString aValue) |
Sanitize a value so that it passes validation. | |
AString | format (in AString aValue) |
Formats the value for display. | |
AString | makeSortable (in AString aValue) |
Transforms the string into its sortable collation data equivalent. | |
AString | makeSearchable (in AString aValue) |
Formats the value to enable proper search. | |
Public Attributes | |
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. | |
const unsigned long | SORT_NULL_BIG = 1 |
Causes null values to be infinitely large. | |
const unsigned long | SORT_NULL_FIRST = 2 |
Null values always first. | |
const unsigned long | SORT_NULL_LAST = 3 |
Null values always last. | |
attribute unsigned long | nullSort |
Set where NULL values get sorted to. | |
attribute sbIPropertyArray | secondarySort |
When sorting by this property, additionally sort by the following properties. | |
attribute AString | id |
Unique ID for this property. | |
attribute AString | type |
The type property. | |
attribute AString | displayName |
Localized display name of this property. | |
attribute boolean | userViewable |
A user may view this property. This does not impede reading the value, it's merely meant as a guideline. | |
attribute boolean | userEditable |
A user may edit this property. This does not impede editing the value, it's merely meant as a guideline. | |
attribute boolean | remoteReadable |
A web site may read the value of this property. | |
attribute boolean | remoteWritable |
A web site may write the value of this property. | |
attribute nsISimpleEnumerator | operators |
True if this property has a selection list An enumerator of selection list values Enumerator of sbIPropertyOperator objects. | |
readonly attribute sbIPropertyUnitConverter | unitConverter |
A unit converter to convert to and from the units in which the property can be expressed. |
Definition at line 131 of file sbIPropertyManager.idl.
sbIPropertyOperator sbIPropertyInfo::getOperator | ( | in AString | aOperator | ) |
Get the sbIPropertyOperator for the given operator string.
aOperator | Operator string, one of the OPERATOR_ constants |
boolean sbIPropertyInfo::validate | ( | in AString | aValue | ) |
Validates the string for this property type.
aValue | Value to validate |
AString sbIPropertyInfo::sanitize | ( | in AString | aValue | ) |
Sanitize a value so that it passes validation.
AString sbIPropertyInfo::format | ( | in AString | aValue | ) |
Formats the value for display.
aValue | Value to format |
AString sbIPropertyInfo::makeSortable | ( | in AString | aValue | ) |
Transforms the string into its sortable collation data equivalent.
aValue | Value to transform. |
AString sbIPropertyInfo::makeSearchable | ( | in AString | aValue | ) |
Formats the value to enable proper search.
aValue | Value to format. |
When sorting by this property, additionally sort by the following properties.
A secondary list of columns to sort by for a particular property. For example, when sorting by artist, you typically want to sort by Artist, Album and Track No.
This attribute is provided as a hint and optimization only. If you want control over how a table of properties is sorted, specify it on the view.
NOTE: Setting this attribute after a property has already been registered with the manager may not work as expected. This is a shortcoming of the architecture and will be fixed with Bug 12677 – "[sorting] cached sortable values should invalidate when property implementations change" If you need to change the secondary sort for a property that may already be cached in the db, check out sbILocalDatabasePropertyCache.InvalidateSortData()
Definition at line 199 of file sbIPropertyManager.idl.