Songbird / Development / Songbird Add-Ons API Documentation

components/displaypanes/public/sbIDisplayPanes.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 
00027 #include "nsISupports.idl"
00028 interface nsIDOMWindow;
00029 interface nsIDOMXULElement;
00030 interface nsISimpleEnumerator;
00031 
00051 [scriptable, uuid(4032b416-9bca-48b0-b95a-cd8a14c48ea0)]
00052 interface sbIDisplayPaneContentInfo : nsISupports
00053 {
00057   readonly attribute AString contentUrl;
00061   readonly attribute AString contentTitle;
00065   readonly attribute AString contentIcon;
00069   readonly attribute PRInt32 defaultWidth;
00073   readonly attribute PRInt32 defaultHeight;
00078   readonly attribute AString suggestedContentGroups; 
00079 };
00080 
00086 [scriptable, uuid(316ba9ab-5fda-4bc3-b4de-dbb8211a4785)]
00087 interface sbIDisplayPaneInstantiator : nsISupports
00088 {
00092   readonly attribute AString contentGroup;
00096   readonly attribute AString contentUrl;
00100   readonly attribute AString contentTitle;
00104   readonly attribute AString contentIcon; 
00108   readonly attribute nsIDOMWindow contentWindow;
00109 
00113   readonly attribute nsIDOMXULElement displayPane;
00114   
00118   void loadContent(in sbIDisplayPaneContentInfo aPane);
00122   void hide();
00126   attribute PRBool collapsed;
00127 };
00128 
00134 [scriptable, uuid(1028919e-de26-45ed-ac12-5343972498a6)]
00135 interface sbIDisplayPaneListener : nsISupports
00136 {
00137   void onRegisterContent(in sbIDisplayPaneContentInfo aPane);
00138   void onUnregisterContent(in sbIDisplayPaneContentInfo aPane);
00139   void onRegisterInstantiator(in sbIDisplayPaneInstantiator aInstantiator);
00140   void onUnregisterInstantiator(in sbIDisplayPaneInstantiator aInstantiator);
00141   void onPaneInfoChanged(in sbIDisplayPaneContentInfo aPane);
00142 };
00143 
00156 [scriptable, uuid(2b7dbb26-f429-4dff-b537-29c0e8a1d0a8)]
00157 interface sbIDisplayPaneManager : nsISupports
00158 {
00163   void registerInstantiator(in sbIDisplayPaneInstantiator aInstantiator);
00164   void unregisterInstantiator(in sbIDisplayPaneInstantiator aInstantiator);
00165 
00170   void registerContent(in AString aContentUrl,
00171                        in AString aContentTitle,
00172                        in AString aContentIcon,
00173                        in PRInt32 aDefaultWidth,
00174                        in PRInt32 aDefaultHeight,
00175                        in AString aSuggestedContentGroups,
00176                        in PRBool aAutoShow);
00177   
00182   void unregisterContent(in AString aContentUrl);
00183 
00187   void updateContentInfo(in AString aContentUrl,
00188                          in AString aNewContentTitle,
00189                          in AString aNewContentIcon);
00190 
00197   void showPane(in AString aContentUrl);
00198 
00203   readonly attribute nsISimpleEnumerator contentList;
00208   readonly attribute nsISimpleEnumerator instantiatorsList;
00209   
00213   sbIDisplayPaneContentInfo getPaneInfo(in AString aContentUrl);
00214   
00218   sbIDisplayPaneInstantiator getInstantiatorForWindow(in nsIDOMWindow aWindow);
00219   
00220   void addListener(in sbIDisplayPaneListener aListener);
00221   void removeListener(in sbIDisplayPaneListener aListener);
00222 
00227   readonly attribute sbIDisplayPaneContentInfo defaultPaneInfo;
00228 };
00229 
00230 

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