C:/projects/songbird/components/playlistsource/public/sbIPlaylistsource.idl

Go to the documentation of this file.
00001 /*
00002 //
00003 // BEGIN SONGBIRD GPL
00004 // 
00005 // This file is part of the Songbird web player.
00006 //
00007 // Copyright© 2006 POTI, Inc.
00008 // http://songbirdnest.com
00009 // 
00010 // This file may be licensed under the terms of of the
00011 // GNU General Public License Version 2 (the “GPL”).
00012 // 
00013 // Software distributed under the License is distributed 
00014 // on an “AS IS” basis, WITHOUT WARRANTY OF ANY KIND, either 
00015 // express or implied. See the GPL for the specific language 
00016 // governing rights and limitations.
00017 //
00018 // You should have received a copy of the GPL along with this 
00019 // program. If not, go to http://www.gnu.org/licenses/gpl.html
00020 // or write to the Free Software Foundation, Inc., 
00021 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
00022 // 
00023 // END SONGBIRD GPL
00024 //
00025  */
00026 
00032 #include "nsISupports.idl"
00033 #include "nsIRDFDataSource.idl"
00034 
00035 interface nsIDOMNode;
00036 interface nsIDOMEvent;
00037 interface sbIDatabaseResult;
00038 
00069 [scriptable, uuid(A0C79C6C-BED5-4b13-8567-37D105FA12E1)]
00070 interface sbIPlaylistCommands : nsISupports 
00071 {
00082   void setPlaylist( in nsIDOMNode node );
00083 
00094   PRInt32 getNumCommands( );
00095 
00109   AString getCommandId( in PRInt32 index );
00110 
00121   AString getCommandText( in PRInt32 index );
00122 
00133   PRInt32 getCommandFlex( in PRInt32 index );
00134 
00146   AString getCommandToolTipText( in PRInt32 index );
00147 
00158   PRBool getCommandEnabled( in PRInt32 index );
00159 
00168   void onCommand( in nsIDOMEvent event );
00169 
00190   sbIPlaylistCommands duplicate( );
00191 };
00192 
00235 [scriptable, uuid(836D6EA5-CA63-418f-BFD8-27704509A6A3)]
00236 interface sbIPlaylistsource : nsIRDFDataSource
00237 {
00255   void feedPlaylist( in AString aRefName, in AString aContextGUID, in AString aTableName );
00256 
00262   void clearPlaylist( in AString aRefName );
00263 
00273   PRInt32 executeFeed( in AString aRefName );
00274   
00303   void setFilter( in AString aRefName, in PRInt32 aIndex, in AString aFilterString, in AString aFilterRefName, in AString aFilterColumn  );
00304   
00313   PRInt32 getNumFilters( in AString aRefName );
00314   
00324   void clearFilter( in AString aRefName, in PRInt32 aIndex);
00325   
00333   AString getFilter( in AString aRefName, in PRInt32 aIndex ); 
00334   
00342   AString getFilterRef( in AString aRefName, in PRInt32 aIndex );
00343 
00356   void setSearchString( in AString aRefName, in AString aSearchString );
00357   
00364   AString getSearchString( in AString aRefName );
00365 
00377   void setOrder( in AString aRefName, in AString aColumnName );
00378 
00385   AString getOrder( in AString aRefName );
00386 
00393   AString getRefGUID( in AString aRefName );
00394   
00401   AString getRefTable( in AString aRefName ); 
00402   
00409   PRInt32 getRefRowCount( in AString aRefName );
00410   
00417   PRInt32 getRefColumnCount( in AString aRefName );
00418   
00427   AString getRefRowCellByColumn( in AString aRefName, in PRInt32 aRow, in AString aColumn );
00428   
00437   PRInt32 getRefRowByColumnValue( in AString aRefName, in AString aColumn, in AString aValue );
00438   
00445   PRBool isQueryExecuting( in AString aRefName );
00446 
00453   PRInt32 waitForQueryCompletion( in AString aRefName );
00454 
00470   void forceGetTargets( in AString aRefName, in PRBool isPermanent );
00471 
00487   void incomingObserver( in AString aRefName, in nsIDOMNode aObject );
00488 
00506   void registerPlaylistCommands( in AString aContextGUID, in AString aTableName, in AString aPlaylistType, in sbIPlaylistCommands aCommandObj );
00507   
00525   sbIPlaylistCommands getPlaylistCommands( in AString aContextGUID, in AString aTableName, in AString aPlaylistType );
00526 };

Generated on Mon Aug 21 21:01:55 2006 for Songbird by  doxygen 1.4.7