prj/cam/src/ui/buttpanl.h

   1 /*
   2 @Copyright Looking Glass Studios, Inc.
   3 1996,1997,1998,1999,2000 Unpublished Work.
   4 */
   5
   6 // $Header: r:/t2repos/thief2/src/ui/buttpanl.h,v 1.5 1998/10/30 02:03:02 mahk Exp $
   7 #pragma once
   8 #ifndef __BUTTPANL_H
   9 #define __BUTTPANL_H
  10 #include <comtools.h>
  11 #include <loopapi.h>
  12 #include <panlmode.h>
  13 #include <gadblist.h>
  14 #include <dynarray.h>
  15 #include <cursors.h>
  16 #include <imgsrc.h>
  17
  18 ////////////////////////////////////////////////////////////
  19 // SIMPLE BUTTON PANEL MODE CLASS
  20 //
  21 // This simple class uses panelmode to implement
  22 // a modal, full-screen button panel.
  23 //
  24 // It's not terribly abstract, but it gets the job done.
  25 //
  26
  27 typedef cCTUnaggregated<ILoopClient, &IID_ILoopClient, kCTU_Default> cBaseLoopClient;
  28
  29 typedef cDynArray<Rect> cRectArray;
  30 typedef cDynArray<DrawElement> cElemArray;
  31
  32 class cModalButtonPanel
  33 {
  34 protected:
  35
  36    //------------------------------------------------------------
  37    //  VIRTUAL FUNCTIONS FOR DESCRIBING YOUR BUTTON PANEL
  38    //
  39
  40    // Init/Term UI (optional, but way recommended)
  41    virtual void InitUI() { };
  42    virtual void TermUI() { };
  43
  44    // These will only get called inside init/term ui, we promise
  45
  46    // How many buttons do I have?
  47    virtual int NumButtons() = 0;
  48    // my button rectangles
  49    virtual cRectArray& Rects() = 0;
  50    // my draw elements
  51    virtual cElemArray& Elems() = 0;
  52
  53    // My cursor
  54    virtual IImageSource* CursorImage() = 0;
  55    // Its palette
  56    virtual IDataSource*  CursorPalette() { return NULL; };
  57
  58    // Handle UI events
  59    virtual void OnButtonList(ushort action, int button) = 0;
  60
  61    // Handle loop events (optional)
  62    // Can get called outside init/term ui
  63    virtual void OnLoopMsg(eLoopMessage, tLoopMessageData ) {} ;
  64
  65
  66
  67 public:
  68
  69    //------------------------------------------------------------
  70    // CLIENT API
  71    //
  72
  73    //
  74    // Constructor.  The descriptors specify *default* values.
  75    // The button panel will override them when necessary
  76    //
  77    cModalButtonPanel(sPanelModeDesc* pmdesc, sLoopClientDesc* lcdesc);
  78    ~cModalButtonPanel();
  79
  80    //
  81    // Spit out a panel mode, so that the client can call switch or whatever
  82    //
  83
  84    IPanelMode* GetPanelMode() { mpPanelMode->AddRef(); return mpPanelMode; };
  85
  86    //
  87    // Get the button list
  88    //
  89
  90    LGadButtonList& GetButtons() { return mpClient->mButtonList; };
  91
  92    //------------------------------------------------------------
  93    // THE GRITTY DETAILS
  94    //
  95
  96 protected:
  97    IPanelMode* mpPanelMode;
  98    ulong mFactoryHandle;
  99
 100    //
 101    // LOOP CLIENT, ACTUALLY OWNS THE BUTTON LIST
 102    //
 103
 104    class cClient : public cBaseLoopClient
 105    {
 106    public:
 107       cClient(const sLoopClientDesc* desc, cModalButtonPanel* panel);
 108       ~cClient();
 109
 110       STDMETHOD_(short,GetVersion)() { return kVerLoopClient; };
 111       STDMETHOD_(const sLoopClientDesc*, GetDescription)() { return mpDesc; };
 112       STDMETHOD_(eLoopMessageResult, ReceiveMessage)(eLoopMessage, tLoopMessageData hData);
 113
 114       static bool BListCB(ushort action, int button, void* data, LGadBox* blist);
 115       void SetupUI();
 116       void CleanupUI();
 117       static ILoopClient* LGAPI FactoryFunc(const sLoopClientDesc*, tLoopClientData);
 118
 119       const sLoopClientDesc* mpDesc;
 120       cModalButtonPanel* mpPanel;
 121       LGadButtonList mButtonList;
 122       IImageSource* mpCursorImg;
 123       Cursor mCursor;
 124       int mPaletteIdx;
 125
 126       BOOL mActive;
 127    };
 128
 129    friend class cClient;
 130
 131    cClient* mpClient;
 132
 133
 134 };
 135
 136 #endif // __BUTTPANL_H
 137
 138
 139
 140