Songbird / Development / Songbird Add-Ons API Documentation

components/library/base/public/sbILibraryManager.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(c) 2005-2008 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 
00033 #include "nsISupports.idl"
00034 
00035 interface nsIRDFDataSource;
00036 interface nsISimpleEnumerator;
00037 interface sbILibrary;
00038 interface sbILibraryFactory;
00039 interface sbILibraryManagerListener;
00040 
00046 [scriptable, uuid(c299b8fc-7aab-4247-a2f8-0ef88b06958f)]
00047 interface sbILibraryManager : nsISupports
00048 {
00052   readonly attribute sbILibrary mainLibrary;
00053 
00058   readonly attribute nsIRDFDataSource dataSource;
00059 
00065   sbILibrary getLibrary(in AString aGuid);
00066 
00070   nsISimpleEnumerator getLibraries();
00071 
00075   nsISimpleEnumerator getStartupLibraries();
00076 
00084   void registerLibrary(in sbILibrary aLibrary,
00085                        in boolean aLoadAtStartup);
00086 
00091   void unregisterLibrary(in sbILibrary aLibrary);
00092 
00096   void setLibraryLoadsAtStartup(in sbILibrary aLibrary,
00097                                 in boolean aLoadAtStartup);
00098 
00102   boolean getLibraryLoadsAtStartup(in sbILibrary aLibrary);
00103 
00107   boolean hasLibrary(in sbILibrary aLibrary);
00108 
00112   void addListener(in sbILibraryManagerListener aListener);
00113 
00117   void removeListener(in sbILibraryManagerListener aListener);
00118 };
00119 
00120 %{C++
00121 
00122 // The Library Manager will use this topic to notify interested components that
00123 // its startup libraries have all been registered.
00124 #define SB_LIBRARY_MANAGER_READY_TOPIC "songbird-library-manager-ready"
00125 
00126 // This notification is sent when shutdown has begun but before the individual
00127 // libraries are notified of shutdown
00128 #define SB_LIBRARY_MANAGER_BEFORE_SHUTDOWN_TOPIC "songbird-library-manager-before-shutdown"
00129 
00130 // This notification is sent when shutdown has begun and notifies individual
00131 // libraries to immediately shutdown
00132 #define SB_LIBRARY_MANAGER_SHUTDOWN_TOPIC "songbird-library-manager-shutdown"
00133 
00134 // This notification is sent when shutdown has begun and after the individual
00135 // libraries are notified of shutdown
00136 #define SB_LIBRARY_MANAGER_AFTER_SHUTDOWN_TOPIC "songbird-library-manager-after-shutdown"
00137 
00138 %}

Generated on Tue Mar 10 14:28:55 2009 for Songbird by  doxygen 1.5.2