prj/cam/src/object/propman.h

   1 /*
   2 @Copyright Looking Glass Studios, Inc.
   3 1996,1997,1998,1999,2000 Unpublished Work.
   4 */
   5
   6 // $Header: r:/t2repos/thief2/src/object/propman.h,v 1.6 2000/01/29 13:24:38 adurant Exp $
   7 #pragma once
   8
   9 #ifndef __PROPMAN_H
  10 #define __PROPMAN_H
  11 #include <comtools.h>
  12 #include <osystype.h>
  13 #include <proptype.h>
  14
  15 ////////////////////////////////////////////////////////////
  16 // PROPERTY MANAGER
  17 //
  18
  19 F_DECLARE_INTERFACE(IPropertyManager);
  20 F_DECLARE_INTERFACE(IProperty);
  21
  22 struct sPropertyIter;
  23
  24 #undef INTERFACE
  25 #define INTERFACE IPropertyManager
  26
  27 DECLARE_INTERFACE_(IPropertyManager, IUnknown)
  28 {
  29    //
  30    // IUnknown methods
  31    //
  32    DECLARE_UNKNOWN_PURE();
  33
  34    //
  35    // Look up a property
  36    //
  37    STDMETHOD_(IProperty*,GetProperty)(THIS_ PropertyID) CONSTFUNC PURE;
  38    STDMETHOD_(IProperty*,GetPropertyNamed)(THIS_ const char* name) CONSTFUNC PURE;
  39
  40 #define IPropertyManager_GetProperty(p, a)         COMCall1(p, GetProperty, a)
  41 #define IPropertyManager_GetPropertyNamed(p, a)    COMCall1(p, GetPropertyNamed, a)
  42
  43    //
  44    // Notify the property system of an event
  45    //
  46    STDMETHOD(Notify)(THIS_ ePropertyNotifyMsg msg, PropNotifyData data) PURE;
  47
  48 #define IPropertyManager_Notify(p, a, b)           COMCall2(p, Notify, a, b)
  49
  50    //
  51    // Iterate over all properties
  52    //
  53    STDMETHOD(BeginIter)(THIS_ struct sPropertyIter* iter) PURE;
  54    STDMETHOD_(IProperty*,NextIter)(THIS_ struct sPropertyIter* iter) PURE;
  55
  56 #define IPropertyManager_BeginIter(p, a)           COMCall1(p, BeginIter, a)
  57 #define IPropertyManager_NextIter(p, a)            COMCall1(p, NextIter, a)
  58
  59    //
  60    // Add & remove properties.  These are typically done by the IProperty objects
  61    // themselves.  Most clients will have no need of these.
  62    //
  63
  64    STDMETHOD_(BOOL,AddProperty)(IProperty *prop, PropertyID *id) PURE;
  65
  66    // Remove a Property from the list being managed, return success
  67    STDMETHOD_(BOOL,DelProperty)(IProperty *prop) PURE;
  68 };
  69
  70 //
  71 // Factory Function
  72 //
  73
  74
  75 EXTERN tResult LGAPI PropertyManagerCreate(void);
  76
  77 //
  78 // Property Iter struct
  79 //
  80 typedef struct sPropertyIter
  81 {
  82    PropertyID id;
  83 } sPropertyIter;
  84
  85
  86 #endif // __PROPMAN_H
  87
  88
  89