An interface used to describe a metadata property for use by the UI and other sbILibrary interfaces (smartplaylists, etc) More...
import"sbIPropertyInfo.idl";
Public Member Functions | |
| 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 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. 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... | |
An interface used to describe a metadata property for use by the UI and other sbILibrary interfaces (smartplaylists, etc)
Definition at line 39 of file sbIPropertyInfo.idl.
| AString sbIPropertyInfo::format | ( | in AString | aValue | ) |
Formats the value for display.
| aValue | Value to format |
| sbIPropertyOperator sbIPropertyInfo::getOperator | ( | in AString | aOperator | ) |
Get the sbIPropertyOperator for the given operator string.
| aOperator | Operator string, one of the OPERATOR_ constants |
| AString sbIPropertyInfo::makeSearchable | ( | in AString | aValue | ) |
Formats the value to enable proper search.
| 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::sanitize | ( | in AString | aValue | ) |
Sanitize a value so that it passes validation.
| boolean sbIPropertyInfo::validate | ( | in AString | aValue | ) |
Validates the string for this property type.
| aValue | Value to validate |
| attribute AString sbIPropertyInfo::displayName |
Localized display name of this property.
Definition at line 122 of file sbIPropertyInfo.idl.
| attribute AString sbIPropertyInfo::id |
Unique ID for this property.
Definition at line 112 of file sbIPropertyInfo.idl.
| attribute AString sbIPropertyInfo::localizationKey |
Key used to find related localization strings.
Definition at line 127 of file sbIPropertyInfo.idl.
| attribute unsigned long sbIPropertyInfo::nullSort |
Set where NULL values get sorted to.
Definition at line 84 of file sbIPropertyInfo.idl.
| readonly attribute AString sbIPropertyInfo::OPERATOR_BEGINSWITH |
Definition at line 49 of file sbIPropertyInfo.idl.
| readonly attribute AString sbIPropertyInfo::OPERATOR_BETWEEN |
Definition at line 53 of file sbIPropertyInfo.idl.
| readonly attribute AString sbIPropertyInfo::OPERATOR_CONTAINS |
Definition at line 47 of file sbIPropertyInfo.idl.
| readonly attribute AString sbIPropertyInfo::OPERATOR_ENDSWITH |
Definition at line 51 of file sbIPropertyInfo.idl.
| readonly attribute AString sbIPropertyInfo::OPERATOR_EQUALS |
Definition at line 41 of file sbIPropertyInfo.idl.
| readonly attribute AString sbIPropertyInfo::OPERATOR_GREATER |
Definition at line 43 of file sbIPropertyInfo.idl.
| readonly attribute AString sbIPropertyInfo::OPERATOR_GREATEREQUAL |
Definition at line 44 of file sbIPropertyInfo.idl.
| readonly attribute AString sbIPropertyInfo::OPERATOR_ISNOTSET |
Definition at line 55 of file sbIPropertyInfo.idl.
| readonly attribute AString sbIPropertyInfo::OPERATOR_ISSET |
Definition at line 54 of file sbIPropertyInfo.idl.
| readonly attribute AString sbIPropertyInfo::OPERATOR_LESS |
Definition at line 45 of file sbIPropertyInfo.idl.
| readonly attribute AString sbIPropertyInfo::OPERATOR_LESSEQUAL |
Definition at line 46 of file sbIPropertyInfo.idl.
| readonly attribute AString sbIPropertyInfo::OPERATOR_NOTBEGINSWITH |
Definition at line 50 of file sbIPropertyInfo.idl.
| readonly attribute AString sbIPropertyInfo::OPERATOR_NOTCONTAINS |
Definition at line 48 of file sbIPropertyInfo.idl.
| readonly attribute AString sbIPropertyInfo::OPERATOR_NOTENDSWITH |
Definition at line 52 of file sbIPropertyInfo.idl.
| readonly attribute AString sbIPropertyInfo::OPERATOR_NOTEQUALS |
Definition at line 42 of file sbIPropertyInfo.idl.
| attribute nsISimpleEnumerator sbIPropertyInfo::operators |
True if this property has a selection list.
An enumerator of selection list values Enumerator of sbIPropertyOperator objects
Definition at line 172 of file sbIPropertyInfo.idl.
| attribute boolean sbIPropertyInfo::remoteReadable |
A web site may read the value of this property.
Definition at line 144 of file sbIPropertyInfo.idl.
| attribute boolean sbIPropertyInfo::remoteWritable |
A web site may write the value of this property.
Definition at line 149 of file sbIPropertyInfo.idl.
| attribute sbIPropertyArray sbIPropertyInfo::secondarySort |
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 107 of file sbIPropertyInfo.idl.
| const unsigned long sbIPropertyInfo::SORT_NULL_BIG = 1 |
Causes null values to be infinitely large.
Definition at line 69 of file sbIPropertyInfo.idl.
| const unsigned long sbIPropertyInfo::SORT_NULL_FIRST = 2 |
Null values always first.
Definition at line 74 of file sbIPropertyInfo.idl.
| const unsigned long sbIPropertyInfo::SORT_NULL_LAST = 3 |
Null values always last.
Definition at line 79 of file sbIPropertyInfo.idl.
| const unsigned long sbIPropertyInfo::SORT_NULL_SMALL = 0 |
Causes null values to be infinitely small. This is the default.
Definition at line 64 of file sbIPropertyInfo.idl.
| attribute AString sbIPropertyInfo::type |
The type property.
Definition at line 117 of file sbIPropertyInfo.idl.
| readonly attribute sbIPropertyUnitConverter sbIPropertyInfo::unitConverter |
A unit converter to convert to and from the units in which the property can be expressed.
Definition at line 222 of file sbIPropertyInfo.idl.
| attribute boolean sbIPropertyInfo::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.
Definition at line 157 of file sbIPropertyInfo.idl.
| attribute boolean sbIPropertyInfo::userEditable |
A user may edit this property. This does not impede editing the value, it's merely meant as a guideline.
Definition at line 139 of file sbIPropertyInfo.idl.
| attribute boolean sbIPropertyInfo::userViewable |
A user may view this property. This does not impede reading the value, it's merely meant as a guideline.
Definition at line 133 of file sbIPropertyInfo.idl.
