sbILocalDatabaseSimpleMediaList.idl
Go to the documentation of this file.
1 /*
2 //
3 // BEGIN SONGBIRD GPL
4 //
5 // This file is part of the Songbird web player.
6 //
7 // Copyright(c) 2005-2008 POTI, Inc.
8 // http://songbirdnest.com
9 //
10 // This file may be licensed under the terms of of the
11 // GNU General Public License Version 2 (the "GPL").
12 //
13 // Software distributed under the License is distributed
14 // on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
15 // express or implied. See the GPL for the specific language
16 // governing rights and limitations.
17 //
18 // You should have received a copy of the GPL along with this
19 // program. If not, go to http://www.gnu.org/licenses/gpl.html
20 // or write to the Free Software Foundation, Inc.,
21 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 //
23 // END SONGBIRD GPL
24 //
25 */
26 
33 #include "nsISupports.idl"
34 
35 interface sbILocalDatabaseLibrary;
36 interface sbIMediaItem;
37 interface sbIMediaList;
38 interface sbIPropertyArray;
39 
44 [scriptable, uuid(deee7fde-ddd4-4a23-9d13-ded73807b060)]
46 {
47  void onItemCopied(in sbIMediaItem aSourceItem,
48  in sbIMediaItem aDestItem);
49 };
50 
60 [scriptable, uuid(8243de6d-1c42-4b7b-8f05-ae291c9e9bf3)]
62 {
64 
70  unsigned long getIndexByOrdinal(in AString aOrdinal);
71 
78  void invalidate(in boolean aInvalidateLength);
79 
85  in unsigned long aIndex,
86  in sbIPropertyArray aProperties);
87 
93  in sbIMediaItem aItem,
94  in unsigned long aIndex);
95 
101  in sbIMediaItem aItem,
102  in unsigned long aIndex);
103 
109  in boolean aExcludeLists);
110 
115  in boolean aExcludeLists);
116 
121 
125  void notifyListenersBatchEnd(in sbIMediaList aList);
126 
131  void notifyContentChanged();
132 };
133 
void onItemCopied(in sbIMediaItem aSourceItem, in sbIMediaItem aDestItem)
void notifyListenersBatchEnd(in sbIMediaList aList)
Notify the simple media list's listeners that a batch has ended.
[USER CODE SHOULD NOT REFERENCE THIS CLASS]
unsigned long getIndexByOrdinal(in AString aOrdinal)
Get the index of an item in this list by its ordinal.
void notifyListenersBeforeItemRemoved(in sbIMediaList aList, in sbIMediaItem aItem, in unsigned long aIndex)
Notify this simple media list's listeners that an item is about to be removed.
void notifyListenersBatchBegin(in sbIMediaList aList)
Notify the simple media list's listeners that a batch has begun.
void notifyListenersListCleared(in sbIMediaList aList, in boolean aExcludeLists)
Notify the simple media list's listeners that it has been cleared.
var uuid
A brief description of the contents of this interface.
[USER CODE SHOULD NOT REFERENCE THIS CLASS]
attribute sbILocalDatabaseMediaListCopyListener copyListener
void notifyListenersAfterItemRemoved(in sbIMediaList aList, in sbIMediaItem aItem, in unsigned long aIndex)
Notify this simple media list's listeners that an item has been removed.
void invalidate(in boolean aInvalidateLength)
Tell the list that its underlying datasource has changed.
void notifyListenersItemUpdated(in sbIMediaItem aItem, in unsigned long aIndex, in sbIPropertyArray aProperties)
Notify this simple media list's listeners that an item has been updated.
Interface that defines a single item of media in the system.
void notifyListenersBeforeListCleared(in sbIMediaList aList, in boolean aExcludeLists)
Notify the simple media list's listeners that it has about to be cleared.
An interface to carry around arrays of nsIProperty instances. Users of this interface should only QI ...
void notifyContentChanged()
Notify the simple media list that its content was changed via an operation that bypassed listeners (i...
[USER CODE SHOULD NOT REFERENCE THIS CLASS]