Songbird / Development / Songbird Add-Ons API Documentation

sbILocalDatabaseSmartMediaList Interface Reference

[USER CODE SHOULD NOT REFERENCE THIS CLASS] More...

import "sbILocalDatabaseSmartMediaList.idl";

Inheritance diagram for sbILocalDatabaseSmartMediaList:

sbIMediaList sbIMediaItem sbILibraryResource List of all members.

Public Member Functions

sbILocalDatabaseSmartMediaListCondition appendCondition (in AString aPropertyID, in sbIPropertyOperator aOperator, in AString aLeftValue, in AString aRightValue, in AString aDisplayUnit)
 Add a condition or limiting condition.
void removeConditionAt (in unsigned long aConditionIndex)
 Remove a condition.
sbILocalDatabaseSmartMediaListCondition getConditionAt (in unsigned long aConditionIndex)
 Get the condition at the specified index. Indexes start at 0. The last item is at conditionCount - 1.
void clearConditions ()
 Clear all conditions.
void rebuild ()
 Rebuild the smart media list contents from the conditions specificied. You should call this after you add/modify/remove any conditions.

Public Attributes

const unsigned long MATCH_TYPE_ANY = 0
const unsigned long MATCH_TYPE_ALL = 1
const unsigned long MATCH_TYPE_NONE = 2
const unsigned long LIMIT_TYPE_NONE = 0
const unsigned long LIMIT_TYPE_ITEMS = 1
const unsigned long LIMIT_TYPE_USECS = 2
const unsigned long LIMIT_TYPE_BYTES = 3
const unsigned long NOTEXISTS_ASZERO = 0
const unsigned long NOTEXISTS_ASNULL = 1
attribute unsigned long matchType
 Match any or all conditions.
readonly attribute unsigned
long 
conditionCount
 The number of conditions added to this smart playlist.
attribute unsigned long limitType
 Type of limit to use.
attribute unsigned long long limit
 Value to apply to the limit type.
attribute AString selectPropertyID
 Property to select limited results by.
attribute boolean selectDirection
 Direction to sort the selection property, true for ascending, false for descending.
attribute boolean randomSelection
 Randomly select the items out of the entire result set.
attribute boolean autoUpdate
 Whether this smart media list updates automatically upon changes to its source library.
attribute unsigned long notExistsMode
 How to handle non-existent properties:.
attribute AString sourceLibraryGuid
 The guid of the source library (by default, the main library). Change this to select a different source library.

Detailed Description

[USER CODE SHOULD NOT REFERENCE THIS CLASS]

Methods and attributes that are specific to the smart media list are implemented here.

See also:
sbIMediaList

Definition at line 98 of file sbILocalDatabaseSmartMediaList.idl.


Member Data Documentation

attribute unsigned long sbILocalDatabaseSmartMediaList::notExistsMode

How to handle non-existent properties:.

NOTEXISTS_ASZERO : Properties that do not exist will equal 0 for numeric fields, "" for text fields, FALSE for booleans, and 'infinitely far in the past' for dates (default). NOTEXISTS_ASNULL : Properties that do not exist will not match any numeric, text, boolean or date rule.

Definition at line 163 of file sbILocalDatabaseSmartMediaList.idl.


The documentation for this interface was generated from the following file:
Generated on Tue Mar 10 14:28:59 2009 for Songbird by  doxygen 1.5.2