Songbird / Development / Songbird Add-Ons API Documentation

components/filesystemevents/base/public/sbIFileSystemListener.idl

00001 /*
00002 //
00003 // BEGIN SONGBIRD GPL
00004 //
00005 // This file is part of the Songbird web player.
00006 //
00007 // Copyright(c) 2005-2009 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 
00029 //
00030 // \brief Listener interface for objects that want to listen to file system
00031 //        events. Pass in an instance of this interface when creating a 
00032 //        |sbIFileSystemWatcher| instance.
00033 //
00034 [scriptable, uuid(9629A5A4-82E7-434F-9684-043A778695AF)]
00035 interface sbIFileSystemListener : nsISupports
00036 {
00037   //
00038   // \brief Callback when the |sbIFileSystemWatcher| has initialized and has
00039   //        started listening to events.
00040   //
00041   void onWatcherStarted();
00042 
00043   //
00044   // \brief Callback when the |sbIFileSystemWatcher| has stopped listening
00045   //        to file system events.
00046   //
00047   void onWatcherStopped();
00048 
00049   //
00050   // \brief Callback when the |sbIFileSystemWatcher| could not load a session.
00051   //        NOTE: If a listener receives this callback, the watcher should be
00052   //              re-initialized via |init()| in order to receive callbacks 
00053   //              about changes to the watched path.
00054   //
00055   void onSessionLoadError();
00056 
00057   //
00058   // \brief Callback when something has change in the filesystem.
00059   // \param aFilePath The event path of the file change.
00060   //
00061   void onFileSystemChanged(in AString aFilePath);
00062   
00063   //
00064   // \brief Callback when something was removed in the filesystem.
00065   // \param aFilePath The event path of the file removal.
00066   //
00067   void onFileSystemRemoved(in AString aFilePath);
00068   
00069   //
00070   // \brief Callback when something was added in the filesystem.
00071   // \param aFilePath The event path of the file addition.
00072   //
00073   void onFileSystemAdded(in AString aFilePath);
00074 };
00075 

Generated on Fri Feb 6 15:18:39 2009 for Songbird by  doxygen 1.5.2