dbedit.h

Go to the documentation of this file.

/*****************************************************************************
 * \file dbedit.h <mi32/dbedit.h>
 * \brief DBEDIT class definitions.
 *
 * \if NODOC
 * $Id: dbedit.h_v 1.36 2004/05/13 15:39:07 dwilliss Exp $
 *
 * $Log: dbedit.h_v $
 * Revision 1.36  2004/05/13 15:39:07  dwilliss
 * Table creation wizard done
 *
 * Revision 1.35  2004/05/10 20:57:31  dwilliss
 * Added a fieldinfo to TableCreate so you can create with initial fields
 *
 * Revision 1.34  2004/04/12 16:42:49  dwilliss
 * Changed style editing to use MGUI and RVC interface classes
 *
 * Revision 1.33  2004/03/08 15:38:24  mju
 * No old mgui hdr.
 *
 * Revision 1.32  2003/10/13 20:45:06  scowan
 * Replaced callback queue pointer with a simple array.
 * Removed unused members.
 *
 * Revision 1.31  2003/09/15 13:49:56  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.30  2003/05/28 15:13:58  dwilliss
 * *** empty log message ***
 *
 * Revision 1.29  2002/09/17 14:15:30  dwilliss
 * Added new SetStyleObject method that takes OBJITEM
 *
 * Revision 1.28  2002/05/07 20:46:10  dwilliss
 * Off by one error in GetTableData().
 *
 * Revision 1.27  2002/05/07 14:46:42  dwilliss
 * Changed the TableData array to be a SIMPLE_ARRAY
 *
 * Revision 1.26  2002/01/25 18:05:32  dwilliss
 * Fixed for new MGD
 *
 * Revision 1.25  2001/12/13 16:59:25  mju
 * MGUI unification.
 *
 * Revision 1.24  2001/12/12 20:15:20  dwilliss
 * Added method to get database inode
 *
 * Revision 1.23  2001/10/25 15:03:38  dwilliss
 * MFC version working now
 *
 * Revision 1.22  2001/09/07 15:02:08  mju
 * Add IsCreated() method.
 *
 * Revision 1.21  2001/07/30 17:12:36  mju
 * Change SetStyleObject to use const for dftstyle.
 *
 * Revision 1.20  2001/07/25 17:46:16  mju
 * Make DBVIEW_... flags an enum.
 *
 * Revision 1.19  2001/07/12 19:14:13  dwilliss
 * Added methods for table definition dialog and new table dialog
 *
 * Revision 1.17  2001/06/04 20:27:01  dwilliss
 * Moved style sample drawing code to TDATA
 *
 * Revision 1.16  2001/06/04 19:13:35  dwilliss
 * Constructor/Destructor now usable.
 *
 * Revision 1.15  2000/10/13 14:33:25  dwilliss
 * When declaring friends, must specify friend class NAME, not just friend NAME
 *
 * Revision 1.14  2000/08/08 19:47:00  scowan
 * Fixed stuff to be elemtype instead of int.
 *
 * Revision 1.11  1999/10/29 19:46:46  dwilliss
 * Added methods to get label colors as COLOR rather than Pixel
 *
 * Revision 1.10  1999/10/29 17:48:30  dwilliss
 * Added sanity check to GetTableData()
 *
 * Revision 1.9  1999/10/20 20:35:38  dwilliss
 * Some methods take const filenames now
 *
 * Revision 1.4  1999/07/02 21:09:31  dwilliss
 * Cleanup for WIN32_NATIVE
 *
 * Revision 1.1  1999/04/07  22:43:25  dwilliss
 * Initial revision
 *
 * \endif
 ****************************************************************************/

#ifndef INC_MI32_DBEDIT_H
#define INC_MI32_DBEDIT_H

#ifndef  INC_MI32_MXDBEDIT_H
   #include <mi32/mxdbedit.h>
#endif

#ifndef INC_MI32_MCB_H
   #include <mi32/mcb.h>
#endif

#ifndef INC_MI32_MSTATUS_H
   #include <mi32/mstatus.h>
#endif

#ifndef INC_MI32_LONGLIST_H
   #include <mi32/longlist.h>
#endif

#ifndef INC_MI32_RVCDBASE_H
   #include <mi32/rvcdbase.h>
#endif

#ifndef INC_MI32_SIMPLEAR_H
   #include <mi32/simplear.h>
#endif

#ifndef INC_MI32_ELEMSTYL_H
   #include <mi32/elemstyl.h>
#endif

#ifndef INC_RVC_STYLE_H
   #include <rvc/style.h>
#endif


#ifdef WIN32_MFC
#ifndef INC_MGUI_LAYOUT_H
#include <mgui/layout.h>
#endif
#endif

#if defined __cplusplus
//! The various classes and structs that are internal to the
//! implementation, but not this class.

//! Forward declarations

class DBEDIT;
class DBEDIT_TDATA;        //!< Table data
class DBEDIT_SDATA;        //!< Tabular view's implementation
class DBEDIT_TINSTANCE;    //!< Table instance
class DBEDIT_FDATA;        //!< Field data
class DBEDIT_SRV;          //!< Base class for all SingleRecordView derived classes
class DBEDIT_SINGLERECORDVIEW;   //!< Actual SingleRecordView
class DBEDIT_STYLEDIALOG;     //!< Style Data
class CDBEDITFUNCS;        //!< Instance factory

namespace MGD {
   class DEVICE;
   class CONTEXT;
   }

struct DBEDITFUNCS;
struct RECSTYLESAMPLE;     
struct DBEDIT_FIELDOPT;    //!< Field options


//!*****************************************************************************
//!                              DBEDIT
//!*****************************************************************************


class DBEDIT {
public:
   
   // CONSTRUCTION 

   //! Constructor.
   //! Note: Since a constructor can't return an error, it only initialized
   //! the class to blank settings.  You should call the Create method to
   //! actually set the thing up.
   DBEDIT();
                                                         
   ~DBEDIT();

   //========================================================================
   //! Enums

   enum MODE {
      MODE_SingleRecord = 0,
      MODE_Form,
      MODE_TabularView,
      MODE_GenView,
#ifdef WIN32_MFC
      MODE_ModalSingleRecord,
#endif
      MODE_NumModes
      };

   //! This should go in DBEDIT.
   enum LABELCOLOR {
      LABELCOLOR_Normal = 0,
      LABELCOLOR_Computed,
      LABELCOLOR_PK,
      LABELCOLOR_FK
      };

   //========================================================================
   // METHODS

   //! Add a callback.
   int CallbackAdd (
      void (*func)(MxdDatabaseEditorCallbackStruct *, void *),
      void *data,
      UINT32 reason
      );

   //! Remove a callback.
   void CallbackRemove (
      void (*func)(MxdDatabaseEditorCallbackStruct *, void *),
      void *data,
      UINT32 reason
      );

   //! Call callbacks.
   //!
   //! This should be private.  Only used by friend classes.
   void CallCallbacks (
      MxdDatabaseEditorCallbackStruct *cbs,
      UINT32 reason
      );

   //! Close everything, but don't destroy anything.
   int Close();

   //! Create.
   //!
   //! You should call this after constructing the DBEDIT and
   //! check for an error.  This is because a constructor can't
   //! return an error.
   int Create (
      MDLGPARENT parent, 
      const UNICODE *fname, 
      INT32 pinode,           //!< Inode of database object's parent (vector, raster, whatever)
      ELEMTYPE elemtype,      //!< Element type of the database to open (ELEMTYPE_Record if pinode is of an OTYPE_DBASE)
      UINT32 flags = 0
      );


   //! Suspend database callbacks.  
   //!
   //! Unless ReallyIgnore is set, callbacks which
   //! happen while suspended will be queued and processed when resumed.
   //! Suspend/Resumes are refcounted.
   void DBCallbackSuspend (
      bool ReallyIgnore,
      bool Totally = false             //!< If true, throw out everything - Use with caution
      );

   //! Resume database callback handling.  
   //!
   //! If any callbacks happened while
   //!   suspended (and we're not still suspended) they will be processed.
   void DBCallbackResume (
      bool ReallyIgnore,
      bool Totally = false             //!< If true, throw out everything - Use with caution
      );

   //! Find records.
   //!
   //! Shouldn't this be private?  Should only be called by friend classes.
   int FindRecords (
      int active
      );

   //! Force all unwritten records to be written.
   int Flush();         

   //! Close a form.
   int FormClose (
      INT32 inode                      //!< Inode of form to close
      );

   //! Deleta a form.
   int FormDrop (
      MDLGPARENT parent,               //!< Parent widget for "Are you sure" dialog
      INT32 inode                      //!< Inode of form do delete
      );

   //! Create a new, blank form.
   int FormNew (
      MDLGPARENT parent,               //!< Parent widget for dialogs
      INT32 * pinode,                  //!< Returned inode of the form created
      UINT32 flags
      );

   //! Open a form.
   int FormOpen (
      INT32 inode,                     //!< Inode of form to open
      UINT32 flags                     //!< flags XXX
      );

   //! Create a generic single record view form for a given table.
   //!
   //! This form doesn't do anything automatically.
   //! This is the X version of this function.
#ifdef X_NATIVE
   int GenViewCreate (
      DBEDIT_TINSTANCE **pinstance,    //!< instance returned
      INT32 TableNum,                  //!< Table number to create view for
      MDLGPARENT parent,               //!< Parent widget to create view in
      MDLGPARENT *pwidget,             //!< XmForm returned
      Arg *uarg,                       //!< Arguments to use when creating form
      int numuargs,
      UINT32 flags
      );
#endif
#ifdef WIN32_MFC
   //! Create a generic single record view form for a given table.
   //!
   //! This form doesn't do anything automatically.
   //! This is the MFC version of this function.
   int GenViewCreate (
      DBEDIT_TINSTANCE **pinstance,    //!< instance returned
      INT32 TableNum,                  //!< Table number to create view for
      MGUI::LAYOUT_PANE_BASE& ParentPane,
      UINT32 flags
      );
#endif

   //! Get the active element number.
   //!
   //! Returns MxdDATABASE_NoElement if none active.
   int GetActiveElement (
      ) const {
      return (m_Element);
      }

   //! Get the RVC object handle for this database.
   int GetDatabaseHandle (
      ) const {
      return (m_id); 
      }

   //! Get the RVC file handle for this database.
   int GetFileHandle (
      ) const {
      return (m_fid); 
      }

   //! Used by database relationships dialog to make sure there's only one instance of itself.
   void *GetDBRelateHandle() const {
      return (m_DBRelateHandle);
      }

   //! Get the ELEMTYPE_ for this database.
   ELEMTYPE GetElemType (
      ) const {
      return (m_ElemType); 
      }

   //! Get the inode of the database
   RVCINODENUM GetInode (
      ) const {
      return (m_info.objectinode);
      }

#ifdef WIN32_NATIVE

   //! Get the color to use for a label from the DBFIELDINFO.flags XXX. 
   //!
   //! These should return a COLORREF, but I don't know where
   //! that's defined.  I don't think I really want this to include
   //! it anyway.
   UINT32 GetLabelColorFromFlags (
      UINT32 flags                     //!< From DBFIELDINFO.flags
      );

   //! Get the color to use for a label given a DBEDIT::LABELCOLOR.
   UINT32 GetLabelColor (
      LABELCOLOR color
      );
#else
   //! Get the color to use for a label from the DBFIELDINFO.flags.
   Pixel GetLabelColorFromFlags (
      UINT32 flags                     //!< From DBFIELDINFO.flags
      );

   //! Get the color to use for a label given a DBEDIT::LABELCOLOR.
   Pixel GetLabelColor (
      LABELCOLOR color
      );
#endif
   //! Get the color to use for a label from the DBFIELDINFO.flags.
   void GetLabelColorFromFlags (
      UINT32 flags,
      COLOR& color
      );

   //! Get the color to use for a label given a DBEDIT::LABELCOLOR.
   void GetLabelColor (
      LABELCOLOR colornum,
      COLOR& color
      );

   //! Get the number of tables open.
   int GetNumOpen();

   //! Get the number of tables in the database.
   int GetNumTables (
      ) const {
      return (m_info.NumTables);
      }

   //! Get the OTYPE of the database object.
   int GetObjType (
      ) const {
      return (m_info.objtype);
      }

   //! Get the widget used as a parent for any dialogs we create.
   MDLGPARENT GetParent (
      ) const { 
      return m_toplevel; 
      }

   //! Get the DBEDIT_TDATA for a given table.
   //!
   //! Should this be private?
   inline DBEDIT_TDATA *GetTableData (
      int table                        //!< Get internal table data
      ) const {
      ++table;    //!< To account for table -1
      if (table < 0 || table >= m_TableData.GetNumItems()) return(NULL);
      return(m_TableData[table]);
      }  

   //! Returns the instance handle for a given table and open mode.
   //!
   //!   Will create one unless passed the flag DBVIEW_NoCreateIfNotExist.
   DBEDIT_TINSTANCE *GetTableInstanceHandle (
      INT32 TableNum,                  //!< Table number to look for
      UINT32 flags                     //!< DBVIEW_TabularView or 0
      );

   //! Determine if Create() has been done yet.
   bool IsCreated (
      ) const {
      return (m_id > 0);
      }

   //! Returns true if this database is not under a vector or anything.
   int IsMainLevel (
      ) const {
      return (m_is_main_level);
      }

   //! Returns true if the database is being used for pin-mapping.
   //!
   //! i.e., we've called SetRecord or SetElement with an ELEMTYPE
   //! of ELEMTYPE_Record.
   int IsPinMapping (
      ) const {
      return (m_pin_mapping);
      }

   //! Returns 1 if the requested table is open in some way.
   int IsTableOpen (
      int TableNum                     //!< Table to check for
      );

   //-----------------------------------------------
   //! Open a table in single record view as a modal dialog.
   //!
   //! @return Record number or error (May be EUserCancel).
   int ModalSingleRecordView (
      INT32 TableNum,                  //!< Table number to open
      INT32 Record,                    //!< Record to edit (or RECORD_New)
      void *initvals,                  //!< Buffer to initialize as (only for record==RECORD_New) 
      MDLGPARENT parent,               //!< Parent widget to use for dialog
      UINT32 flags                     //!< MxdDATABASE_AutoSave if you don't want a "Do you wish to save changes" question on OK
      );

   //! Add an element to the multi-Select list.
   int MultiSelectAddElement (
      INT32 element                    //!< Element number or MxdDATABASE_NoElement
      );

   //! Add an element to the multi-Select list.
   //!
   //! Don't use this version.  It's only here for backwards compatibility.
   //! It's used by the wrapper function MxdDatabaseEditorSetElement().
   int MultiSelectAddElementOld (
      INT32 element,                   //!< Element number or MxdDATABASE_NoElement
      ELEMTYPE elemtype                   //!< Why did we pass this for every element?
      );

   //! Remove an element from the multi-Select list.
   int MultiSelectRemoveElement (
      INT32 element                    //!< Element to remove from the selected element set
      );

   //! Start adding elements to the element list.
   //!
   //! SetElements() is the prefered method, but isn't well suited
   //! to CAD.  Call MultiSelectStart, MultiSelectAddElement as many
   //! times as you need, then MultiSelectEnd.  If you want to clear
   //! the list first, pass MxdDATABASE_Clear.
   int MultiSelectStart (
      UINT32 flags,                    //!< MxdDATABASE_Clear
      ELEMTYPE ElemType,                     //!< ELEMTYPE_Xxxx
      int BaseTable = 0                //!< Only needed if for ELEMTYPE_Record
      );

   //! Finish a multiple element selection.
   int MultiSelectEnd (
      UINT32 flags                     //!< Could pass MxdDATABASE_DontUpdateDialogs
      );


   //! Open the style object associated with a database.
   //!
   //!   This is for use by DBEDIT_TDATA only (?).
   bool GetStyleObject (
      RVC::STYLE& StyleObj
      );

   //! Notify the database editor that attachments to active element may have changed. 
   //!
   //! (Should be unnecessary now that we have
   //! database callbacks to deal with all this, but you can totally
   //! suspend the callbacks).
   int RefreshActiveElementAttachments (
      UINT32 flags                     //!< Can be MxdDATABASE_DontUpdateDialogs
      );

   //! Notify the database editor that attachments may have changed. 
   //!
   //! (Should be unnecessary now that we have
   //! database callbacks to deal with all this, but you can totally
   //! suspend the callbacks).
   int RefreshAttachments (
      UINT32 flags                     //!< Can be MxdDATABASE_DontUpdateDialogs
      );

   //! Set the "active" element.
   int SetActiveElement (
      INT32 element,                   //!< Element number of MxdDATABASE_NoElement
      ELEMTYPE elemtype,                     //!< ELEMTYPE_Xxxx
      UINT32 flags,                    //!< Can be MxdDATABASE_DontUpdateDialogs
      INT32 BaseTable = 0              //!< Table to use if this is ELEMTYPE_RECORD
      );

   //! Set the base table number for PinMapping.
   void SetBaseTable (
      int table                        //!< Table number to use
      );

   //! Used by database relationships dialog to make sure there's only one instance of itself.
   void SetDBRelateHandle (
      void *handle
      ) {
      m_DBRelateHandle = handle;
      }

   //! Set the list of selected elements using a bit array.
   int SetElements (
      ELEMTYPE ElemType,                     //!< ELEMTYPE_Xxxx
      INT32 BaseTable,                 //!< Base table number
      UINT8 *Bits,                     //!< Bit array with selected elements set
      INT32 NumElements,               //!< Number of bits in array
      INT32 ActiveElement,             //!< Active element number
      UINT32 flags                     //!< could pass MxdDATABASE_DontUpdateDialogs, but why?
      );

   //! Set widget to use as parent for all dialogs.
   void SetParent (
      MDLGPARENT parent                //!< Widget to use as a parent
      ) {
      m_toplevel = parent; 
      }

   //! Set the current record.
   //!
   //! This just Calls SetActiveElement.
   int SetRecord (
      int table,                       //!< Base table number
      INT32 record                     //!< Current record number
      );

   //! Set the style number to edit in the style editor dialog.
   //!
   //! Also remembers internally which record this was for.
   //! Returns without doing anything if style editor isn't open.
   int SetStyleNumber (
      int StyleNum,                    //!< Style number to edit
      int RecNum                       //!< Record number in Style Assignment Table
      );

   //! Set the style object to use for style samples.
   int SetStyleObject (
      const UNICODE *fname,            //!< Filename of style object
      INT32 inode,                     //!< inode of style object
      int table,                       //!< Style Assignment Table number
      const void *dftstyle             //!< Default style appropriate to the database type
      );

   //! Set the style object to use for style samples.
   int SetStyleObject (
      const RVC::OBJITEM& StyleObjItem,            //!< Style object to use
      const RVC::OBJECTNAME& StyleTableName,       //!< Name of style table
      const void *dftstyle             //!< Default style appropriate to the database type
      );

   //! Open the style editor dialog.
   int StyleDialogOpen (
      MDLGPARENT parent                //!< Parent widget for the dialog
      );

   //! Close the style dialog.
   //!
   //! Actually does nothing.
   int StyleDialogClose (
      );

   //! Popup a table creation dialog.
   //! This pops up the "New Table" dialog to let the user design a new table.
   //!
   //! If the optional tableinfo is supplied, it will be used for defaults and
   //! the the new table's info will be returned in it.
   int TableCreate (
      MDLGPARENT parent,               //!< Parent widget for dialogs
      RVCTABLEINFO* info,           //!< Defaults for new table (optional)
      DBFIELDINFO* finfo 
#ifndef TABLEDEF_C
      = 0         //!< Initial field info (optional)
#endif
      );

#ifdef TABLEDEF_C
   // After tonight's build, remove this and force finfo to have a default
   // value above.  Until then, we get link errors if we don't have a 2-parm
   // version of the function around. (10-May-04)
   int TableCreate (
      MDLGPARENT parent,               //!< Parent widget for dialogs
      RVCTABLEINFO* info            //!< Defaults for new table (optional)
      );

#endif

   //! Popup a table creation wizard.
   //! This uses a wizard to walk the user through the first few steps of
   //! creating a table.
   int TableCreate (
      MDLGPARENT parent             //!< Parent widget for dialogs
      );

   //! Drop (delete) a table.
   int TableDrop (
      MDLGPARENT parent,               //!< Parent for "Are you sure" dialog
      int TableNum                     //!< Table number to drop
      );

   //! popup a dialog to allow the user to edit the table's definition.
   int TableEditDefinition (
      MDLGPARENT parent,               //!< Parent for "Are you sure" dialog
      int TableNum                     //!< Table number to drop
      );

   //! Open a table window in DBVIEW_TabularView mode or (default) Single Record View.
   int TableOpen (
      INT32 TableNum,                  //!< Table number to open
      UINT32 flags                     //!< DBVIEW_flags (in xdefns.h)
      );

   //! Close all instances of a given table.
   int TableClose (
      INT32 TableNum                   //!< Table number to close (all instances)
      );

   //! Destroy table instance (just the dialog, not the underlying table).
   int TableDestroy (
      int TableNum                     //!< Table number to destroy
      );

   //! Force all open table windows to update.
   int UpdateDialogs ();

   //! Similar to DBCallbackResume, but if resuming (it's refcounted so may these can be nested), this will check to see if we think we need to update everything and do so.
   //! 
   //! In a perfect world, this should never
   //!   be the case.  CallbackResume will handle it all for us.  
   int UpdateResume (
      UINT32 flags                     //!< could pass MxdDATABASE_DontUpdateDialogs, but why?
      );

   //! Just calls DBCallbackSuspend().
   void UpdateSuspend();

private:
   #ifndef GENERATING_DOXYGEN_OUTPUT

   // MEMBERS

   MDLGPARENT m_main_widget;
   MDLGPARENT m_toplevel;
   RVCDBASEINFO m_info;
   INT32 m_flags;                      //!<  flags passed to CreateDatabaseWindow() 
   bool m_is_open;
   bool m_is_main_level;
   bool m_pos_known;
   bool m_need_resize;
   bool m_show_style_tables;
   bool m_pin_mapping;
   bool m_multi_select;
   bool m_use_tabular_view;
   bool m_ReallyIgnoreCallback_DamnIt;
   bool m_NeedUpdate;
   bool m_LabelColorsKnown;
   int m_fid, m_id;                    //!<  ID of open database 
   int m_type;                         //!<  line/node/poly/cad/main 
   INT32 m_Element;                    //!<  "active" Vector/CAD element number 
   LONGLIST m_ElemList;
   LONGLIST m_ActiveElemList;
   ELEMTYPE m_ElemType;
   INT32 m_BaseTable;                  //!<  For Pin-Mapping, record # is in Element 
#ifdef WIN32_NATIVE
   int m_x, m_y;
   int m_h, m_w;
   int m_maxfwidth, m_total_height;
   int m_maxwidth;
#else
   Position m_x, m_y;
   Dimension m_h, m_w;
   Dimension m_maxfwidth, m_total_height;
   Dimension m_maxwidth;
#endif
   DBEDIT_TDATA **m_formtdata;
   DBEDIT_TDATA *m_OrphanInstances;    //!<  Instances with out a table 
   int m_numtdatas, m_numforms;
   int m_CreatingTable;                //!<  Table being created by workproc 
   McbLIST m_CBList;
   struct STYLE {
      RVC::OBJITEM m_StyleObjItem;     //!<  Style object filename 
      int m_table;                     //!<  Table number of StyleAssignmentTable 
      bool m_bDefaultKnown;
      DBEDIT_STYLEDIALOG *m_dlg;       //!<  style editor dialog 
      MULTISTYLE m_dft;
         
      STYLE (
         ) :
         m_table(0),
         m_bDefaultKnown(false),
         m_dlg(0)
         {
         }
      } m_Style;
   DBEDITFUNCS **m_EditFuncs;
   void *m_DBRelateHandle;             //!<  Private data for MxdDatabaseEditorRelate() 
   int m_IgnoreCallback;
#ifdef WIN32_NATIVE
   //! XXX These should actually be COLORREFs
   UINT32 m_LabelColors[10];  
#else
   Pixel m_LabelColors[10];
#endif
   MGD::DEVICE *m_gdisp;               //!<  For showing style samples 
   MGD::CONTEXT *m_ggc;
   void *m_ClassPrivData[MODE_NumModes];

   SIMPLE_ARRAY<DBCALLBACKSTRUCT> m_DBCallbackQueue;
   int m_DrainingQueue;
   UINT32 m_DBCallbackMask;
   int m_ReallyIgnoreCallbacks;        //!<  # of times CallbackSuspend called with 1 for last parm 
   SIMPLE_ARRAY<DBEDIT_TDATA*> m_TableData;

   //---------------------------------------------------------------------
   // PRIVATE METHODS

   //! Find the table instance for a given form.
   //! 
   //! Returns NULL if none open.
   DBEDIT_TINSTANCE *FindFormInstance (
      INT32 inode                      //!< Inode of OTYPE_FORM object under this database
      );

   //! Iterate through all instances of a table, calling an instance member function.
   //!
   //! Should this be private?
   int ForEachTableInstance (
      int (DBEDIT_TINSTANCE::*Func)(void*),
      void *hookdata
      );

   //! Iterate through all instances of a table, calling an instance member function.
   //!
   //! Should this be private?
   int ForEachTableInstance (
      int (DBEDIT_TINSTANCE::*Func)(UINT32),
      UINT32 hookdata
      );

   //! Drain the queue.
   //!
   //! Make sure we don't try to drain the queue if we 
   //! got called by a callback while draining the queue.
   void DrainQueue();

   //! Read new records and update open tables.
   int UpdateDialogsInternal();

   //! Enqueue the database callback. 
   int EnqueueDBCallback (
      DBCALLBACKSTRUCT *cbs
      );

   //! Dequeue the database callback.
   void DequeueDBCallback ();

   //! It dispatches a Database Callback.
   //!
   //! When the database editor receives a database callback, it can do one of
   //! two things:
   //! (1) If callbacks are not suspended (via DBEDIT::DBCallbackSuspend()), at the
   //! time one is received, it is just dispatched immediately.
   //! (2) If callbacks are suspended it will enqueue the callback, consolidating callbacks
   //! if possible (i.e., if there's already a callback in the queue which would cause it to
   //! update open table windows, it doesn't bother to enqueue another one).  When
   //! callbacks are resumed, it will dispatch all the callbacks in the queue.
   void Dispatch (
      DBCALLBACKSTRUCT *cbs
      );

   //!   Allocate the DBEDIT_TDATA for a table.
   //!
   //! Called on initialization and when a new table is added.
   int CreateDBEDIT_TDATA (
      int TableNum
      );

   //! Callback for database change.
   static void CB_DBChange (
      DBCALLBACKSTRUCT *cbs,
      void *hookdata
      );

   //---------------------------------------------------------------------
   //! Classes which are used to implement various views of the database
   //! have to be friends of this class.
   friend class DBEDIT_TDATA;
   friend class DBEDIT_TINSTANCE;
   friend class DBEDIT_STYLEDIALOG;
   friend class DBEDIT_SRV;
   friend class DBEDIT_SINGLERECORDVIEW;
   friend class DBEDIT_SDATA;
   #endif // GENERATING_DOXYGEN_OUTPUT
   };

//!*********************************************************************************
//!                              DBEDIT_SUSPENDCALLBACKS
//!*********************************************************************************


//! A class to help insure that we never forget to resume callbacks.
//!
//! Just create an instance of one of these and callbacks will be
//! automatically resumed when it goes out of scope.
class DBEDIT_SUSPENDCALLBACKS {
public:

   // CONSTRUCTION / DESTRUCTION

   //! Constructor.
   DBEDIT_SUSPENDCALLBACKS (
      DBEDIT *ddata, 
      bool reallyInore = false
      ) {
      m_ddata = ddata;
      m_ReallyInore = reallyInore;
      m_ddata->DBCallbackSuspend(m_ReallyInore);
      }

   //! Destructor.
   ~DBEDIT_SUSPENDCALLBACKS() {
      m_ddata->DBCallbackResume(m_ReallyInore);
      }

private:
   #ifndef GENERATING_DOXYGEN_OUTPUT

   // MEMBERS

   DBEDIT *m_ddata;
   bool m_ReallyInore;
   #endif // GENERATING_DOXYGEN_OUTPUT
   };
   
#endif

typedef DBEDIT * DBEDITHANDLE;      

#endif

---