headers/private/print/FolderWatcher.h

   1 /*****************************************************************************/
   2 // FolderWatcher
   3 //
   4 // Author
   5 //   Michael Pfeiffer
   6 //
   7 // This application and all source files used in its construction, except
   8 // where noted, are licensed under the MIT License, and have been written
   9 // and are:
  10 //
  11 // Copyright (c) 2002 OpenBeOS Project
  12 //
  13 // Permission is hereby granted, free of charge, to any person obtaining a
  14 // copy of this software and associated documentation files (the "Software"),
  15 // to deal in the Software without restriction, including without limitation
  16 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
  17 // and/or sell copies of the Software, and to permit persons to whom the
  18 // Software is furnished to do so, subject to the following conditions:
  19 //
  20 // The above copyright notice and this permission notice shall be included
  21 // in all copies or substantial portions of the Software.
  22 //
  23 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  24 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  25 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  26 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  27 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  28 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  29 // DEALINGS IN THE SOFTWARE.
  30 /*****************************************************************************/
  31
  32 #ifndef _FOLDER_WATCHER_H
  33 #define _FOLDER_WATCHER_H
  34
  35 #include <Directory.h>
  36 #include <Entry.h>
  37 #include <Handler.h>
  38 #include <Looper.h>
  39 #include <String.h>
  40 #include <StorageDefs.h>
  41
  42
  43 class FolderListener {
  44 public:
  45         virtual ~FolderListener() {};
  46                 // entry created or moved into folder
  47         virtual void EntryCreated(node_ref* node, entry_ref* entry) {};
  48                 // entry removed from folder (or moved to another folder)
  49         virtual void EntryRemoved(node_ref* node) {};
  50                 // attribute of an entry has changed
  51         virtual void AttributeChanged(node_ref* node) {};
  52 };
  53
  54
  55 // The class FolderWatcher watches creation, deletion of files in a directory
  56 // and optionally watches attribute changes of files in the directory.
  57 class FolderWatcher : public BHandler {
  58         typedef BHandler inherited;
  59
  60 private:
  61         BDirectory fFolder;
  62         FolderListener* fListener;
  63         bool fWatchAttrChanges;
  64
  65         bool BuildEntryRef(BMessage* msg, const char* dirName, entry_ref* entry);
  66         bool BuildNodeRef(BMessage* msg, node_ref* node);
  67
  68         void HandleCreatedEntry(BMessage* msg, const char* dirName);
  69         void HandleRemovedEntry(BMessage* msg);
  70         void HandleChangedAttr(BMessage* msg);
  71
  72 public:
  73                 // start node watching (optionally watch attribute changes)
  74         FolderWatcher(BLooper* looper, const BDirectory& folder, bool watchAttrChanges = false);
  75                 // stop node watching
  76         virtual ~FolderWatcher();
  77
  78         void MessageReceived(BMessage* msg);
  79
  80                 // the directory
  81         BDirectory* Folder() { return &fFolder; }
  82
  83                 // set listener that is notified of changes in the directory
  84         void SetListener(FolderListener* listener);
  85
  86                 // start/stop watching of attribute changes
  87         status_t StartAttrWatching(node_ref* node);
  88         status_t StopAttrWatching(node_ref* node);
  89 };
  90
  91 #endif