mi32/dbedit.h

Go to the documentation of this file.

/*****************************************************************************
 * \file mi32/dbedit.h
 * \brief DBEDIT class definitions.
 *
 * \if NODOC
 * $Id: dbedit.h_v 1.78 2012/09/25 19:23:28 mju Exp $
 *
 * $Log: dbedit.h_v $
 * Revision 1.78  2012/09/25 19:23:28  mju
 * Add getDisplayPath.
 *
 * Revision 1.77  2012/06/05 15:00:28  mju
 * Add getCreateFlags.
 *
 * Revision 1.76  2011/10/24 20:34:50  mju
 * Remove redundant hdrs.
 *
 * Revision 1.75  2011/09/06 21:26:52  mju
 * Rename macro.
 *
 * Revision 1.74  2010/08/19 17:39:38  mju
 * Use elemnum and unsignedset.
 *
 * Revision 1.73  2010/05/13 14:04:34  mju
 * Fix warning.
 *
 * Revision 1.72  2009/08/11 21:54:09  mju
 * Add isFormOpen.
 *
 * Revision 1.71  2009/05/12 16:29:46  mju
 * Rename flag to noSwitchTableView.
 *
 * Revision 1.70  2008/09/26 21:15:41  mju
 * Remove activeElemList, just use activeElemNum.
 *
 * Revision 1.69  2008/09/22 19:01:20  mju
 * Update for dbrecord viewers.
 *
 * Revision 1.68  2008/08/27 15:25:24  mju
 * Remove unneeded cdbeditfuncs decl.
 *
 * Revision 1.67  2008/07/15 21:57:48  mju
 * Add canMakeTableImplied.
 *
 * Revision 1.66  2008/01/04 22:12:02  scowan
 * Added tableCreateDefinition static method.
 *
 * Revision 1.65  2007/11/12 15:47:40  mju
 * Don't use mstatus hdr as nothing in this hdr uses any status stuff.
 *
 * Revision 1.63  2006/12/07 16:13:34  dwilliss
 * some changes for images in blobs
 *
 * Revision 1.43  2005/10/06 17:28:02  mju
 * Add default for openTreeView.
 *
 * Revision 1.41  2005/08/08 14:04:41  dwilliss
 * Changed the type of a parameter to satisfy gcc
 *
 * Revision 1.39  2005/07/13 15:49:59  dwilliss
 * Make it possible to eliminate write-lock-as-needed mode
 *
 * Revision 1.38  2005/03/31 16:57:10  fileserver!dwilliss
 * Rename one of our types to MIUNICODE because it conflicted with a Microsoft #define
 *
 * 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.32  2003/10/13 20:45:06  scowan
 * Replaced callback queue pointer with a simple array.
 * Removed unused members.
 *
 * Revision 1.29  2002/09/17 14:15:30  dwilliss
 * Added new SetStyleObject method that takes OBJITEM
 *
 * 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_LONGLIST_H
   #include <mi32/longlist.h>
#endif

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

#ifndef INC_MI32_MICALLBACKLIST_H
   #include <mi32/micallbacklist.h>
#endif

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

#ifndef INC_RVC_DBELEM_H
   #include <rvc/dbelem.h>
#endif


//=====================================================================================================================

#ifndef GENERATING_DOXYGEN_OUTPUT
// Forward declarations
class DBEDIT;
class DBEDIT_TDATA;        // Table data
class DBEDIT_TINSTANCE;    // Table instance
class DBEDIT_STYLEDIALOG;     // Style Data
struct DBEDIT_FIELDOPT;    // Field options

struct RECSTYLESAMPLE;
namespace RVC {
   class DBASE;
   class DBASE_ELEMENT;
   namespace UI {
      class DLG_DB_BASE;
      class FORM_DB_RECORD;
      }
   }
namespace MGUI {
   class LAYOUT_PANE_BASE;
   }
#endif   // GENERATING_DOXYGEN_OUTPUT

//=====================================================================================================================

struct DBEDIT_MSG : public MICALLBACKLIST::ANYCALLBACKSTRUCT {

   enum REASON {
      REASON_ALL              = 0x00000000,
      REASON_TableOpen        = 0x00000001,
      REASON_TableClose       = 0x00000002,
      REASON_FormOpen         = 0x00000004,
      REASON_FormClose        = 0x00000008,
      REASON_Destroy          = 0x80000000,     
      REASON_Modify           = 0x04000000,
      REASON_SelectElements   = 0x00000010,
      REASON_UnselectElements = 0x00000020,
      REASON_ToggleElements   = 0x00000040,
      REASON_SelectOnly       = 0x00000080,
      REASON_Elements         = 0x000000F0,     
      REASON_FormObjectCreate = 0x00000100,     
      REASON_FormObjectDestroy= 0x00000200,     
      REASON_AutoComplete     = 0x00000400
      };

   DBEDIT_MSG (
      DBEDIT* p_DBEdit,
      REASON r 
      ) :
      ANYCALLBACKSTRUCT(r),
      DBEdit(p_DBEdit),
      TableNum(0),
      ElemType(ELEMTYPE_Empty),
      Record(0)
      { }

   RVC::OBJITEM ObjItem;      
   DBEDIT* DBEdit;            
   ELEMTYPE ElemType;
   INT32 TableNum;            
   INT32 Record;
   SIMPLE_ARRAY<INT32> Records;
   };

#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(DBEDIT_MSG::REASON)
#endif

//=====================================================================================================================

class DBEDIT {
   public:
      
      #ifndef GENERATING_DOXYGEN_OUTPUT
      enum MODE {
         MODE_SingleRecord = 0,
         MODE_UserDefined,
         MODE_TabularView,
         MODE_NumModes
         };
      #endif

      enum VIEWFLAGS {
         VIEWFLAG_None =                  0,
         VIEWFLAG_ViewActive =            0x00000001, 
         VIEWFLAG_ViewSelected =          0x00000002, 
         VIEWFLAG_ViewAll =               0x00000004, 
         VIEWFLAG_NoChangeViewMode =      0x00000008, 
         VIEWFLAG_NoSwitchTableView =     0x00000010, 
         VIEWFLAG_NoRecordSelection =     0x00000020, 
         VIEWFLAG_NoAttachmentIndicator = 0x00000040, 
         VIEWFLAG_NoRowControls =         (VIEWFLAG_NoRecordSelection|VIEWFLAG_NoAttachmentIndicator),
         VIEWFLAG_NoNewRecord =           0x00000080, 
         VIEWFLAG_NoDropTable =           0x00000100, 
         VIEWFLAG_NoEditDefn =            0x00000200, 
         VIEWFLAG_TabularView =           0x00000400, 
         VIEWFLAG_NoElementSelection =    0x00000800, 
         VIEWFLAG_NoCreateIfNotExist =    0x00001000, 
         VIEWFLAG_SingleRecordView =      0x00002000  
         };

      enum LABELCOLOR {
         LABELCOLOR_Normal = 0,
         LABELCOLOR_Computed,
         LABELCOLOR_PK,
         LABELCOLOR_FK
         };

      enum CREATEFLAGS {
         CREATEFLAG_None =                   0x00,
         CREATEFLAG_NoEdit =                 0x01, 
         CREATEFLAG_AllowEditInTNTatlas =    0x20  
         };

      struct EVENT {
         EVENT();
         EVENT(const EVENT& rhs);
         INT32 reason;
         INT32 table;
         INT32 record;
         UINT32 subreason;
         };

      static RVC::UI::DLG_DB_BASE* DlgConstructTabularView (
         DBEDIT_TINSTANCE *idata
         );

      static void SML_Install (
         SML::CONTEXT *context
         );

      static ERRVALUE TableCreateDefinition (
         MDLGPARENT parent,
         RVC::OBJTYPE DBaseObjType,
         RVC::DBTABLE::MAKEPARMS& MakeParms,          
         RVC::DESCRIPTOR& Descriptor                  
         );

      DBEDIT ();

      ~DBEDIT();

      ERRVALUE CallbackAdd (
         void (*func)(const DBEDIT_MSG *, void *),
         void *data,
         DBEDIT_MSG::REASON reason
         );

      void CallbackRemove (
         void (*func)(const DBEDIT_MSG *, void *),
         void *data,
         DBEDIT_MSG::REASON reason
         );

      void CallCallbacks (
         DBEDIT_MSG& cbs
         );

      bool CanMakeTableImplied (
         ) const;

      int Close ();

      int Create (
         MDLGPARENT parent, 
         const RVC::OBJITEM& ParentObjItem,
         ELEMTYPE elemtype,      
         CREATEFLAGS flags = CREATEFLAG_None,
         const RVC::CREDENTIALS* Credentials = 0
         );

      void DBCallbackSuspend (
         bool ReallyIgnore,
         bool Totally = false             
         );

      void DBCallbackResume (
         bool ReallyIgnore,
         bool Totally = false             
         );

   #ifndef GENERATING_DOXYGEN_OUTPUT
      int FindRecords (
         int active
         );
   #endif

      int Flush ();        

      int FormClose (
         const RVC::OBJITEM& ObjItem
         );

      int FormDrop (
         MDLGPARENT dlgparent,               
         const RVC::OBJITEM& ObjItem
         );

      int FormNew (
         MDLGPARENT dlgparent,               
         VIEWFLAGS flags = VIEWFLAG_None,
         const RVC::CREDENTIALS* Credentials = 0
         );

      int FormOpen (
         const RVC::OBJITEM& ObjItem,
         VIEWFLAGS flags = VIEWFLAG_None,
         const RVC::CREDENTIALS* Credentials = 0
         );

      ERRVALUE GenViewCreate (
         MGUI::LAYOUT_PANE_BASE& ParentPane,       
         INT32 TableNum,                           
         RVC::UI::FORM_DB_RECORD **ppFormRet = 0,  
         DBEDIT::VIEWFLAGS flags = VIEWFLAG_None
         );

      INT32 GetActiveElement (
         ) const {
         return (m_ActiveElemNum);
         }

      INT32 GetBaseTableNum (
         ) const { return (m_BaseTable); }

      CREATEFLAGS GetCreateFlags () const
         { return (m_flags); }

      const RVC::CREDENTIALS* GetCredentials (
         ) const { return (m_Credentials); }

      RVC::DBASE_ELEMENT* GetDBase (
         ) const {
         return m_DBase;
         }
      
      RVC::DBASE::OBSERVER *GetDBRelateHandle() const {
         return (m_DBRelateHandle);
         }

      MISTRING GetDisplayPath () const;

      MDLGPARENT GetDlgParent (
         ) const { return (m_dlgparent); }

      const LONGLIST& GetElemList (
         ) const { return (m_ElemList); }

      ELEMTYPE GetElemType (
         ) const { return (m_ElemType); }

      void GetLabelColorFromFlags (
         RVC::DBTABLE::FIELDINFO::FLAGS fieldflags,
         COLOR& color
         );

      void GetLabelColor (
         LABELCOLOR colornum,
         COLOR& color
         );

      int GetNumOpen ();

      const RVC::OBJITEM& GetObjItem (
         ) const { return m_ObjItem; }

      const RVC::OBJITEM& GetParentObjItem (
         ) const { return m_ParentObjItem; }

      MDLGPARENT GetParent (
         ) const { 
         return m_dlgparent; 
         }

      bool GetStyleObject (
         RVC::STYLE& StyleObj
         );

      inline DBEDIT_TDATA * GetTableData (
         int table                        
         ) const {
         if (table == -2) table = -1;  // Cope with internal node table
         ++table;    // To account for table -1
         if (table < 0 || static_cast<UINT32>(table) >= m_TableData.GetNumItems()) return (NULL);
         return (m_TableData[table]);
         }  

      DBEDIT_TINSTANCE * GetTableInstanceHandle (
         INT32 TableNum,                  
         VIEWFLAGS flags                     
         );

      bool HasCallbacks (
         UINT32 reason
         ) const { return (m_CBList.HasCallbacks(reason)); }

      bool IsCreated (
         ) const {
         return (m_DBase != 0);
         }

      bool IsFormOpen (
         const RVC::OBJITEM& ObjItemForm
         );

      int IsMainLevel (
         ) const {
         return (m_DBase != 0 && m_DBase->GetElemType() == ELEMTYPE_Empty);
         }

      int IsPinMapping (
         ) const {
         return (m_pin_mapping);
         }

      int IsTableOpen (
         int TableNum                     
         );

      //-----------------------------------------------
      int ModalSingleRecordView (
         INT32 TableNum,                  
         INT32 RecordNum,                 
         RVC::DBTABLE::RECORD* InitVal,   
         MDLGPARENT dlgparent,            
         UINT32 flags = 0                 
         );

      int MultiSelectAddElement (
         INT32 ElemNum                    
         );

      int MultiSelectRemoveElement (
         INT32 ElemNum                    
         );

      ERRVALUE MultiSelectStart (
         int BaseTable = 0                
         );

      ERRVALUE MultiSelectEnd (
         bool UpdateDialogs = true
         );

      void OnEvent(const DBEDIT::EVENT& event, bool bDeferable = true);

   #ifdef X_NATIVE
      ERRVALUE OpenTreeView (
         UINT32 flags = 0     
         );
   #endif

      int RefreshActiveElementAttachments (
         bool UpdateDialogs = true
         );

      ERRVALUE SetActiveElement (
         ELEMNUM ElemNum,                 
         INT32 BaseTable = 0              
         ) { return (SetActiveElementLow(ElemNum,true,BaseTable)); }

      void SetBaseTable (
         int table                        
         );

      void SetDBRelateHandle (
         RVC::DBASE::OBSERVER* handle
         ) {
         m_DBRelateHandle = handle;
         }

      ERRVALUE SetElements (
         INT32 BaseTable,                 
         const UNSIGNEDSET& ElemSet,      
         ELEMNUM ActiveElemNum            
         );

      void SetParent (
         MDLGPARENT parent                
         ) {
         m_dlgparent = parent; 
         }

      int SetStyleNumber (
         int StyleNum,                    
         int RecNum                       
         );

      int SetStyleObject (
         const RVC::OBJITEM& StyleObjItem,            
         const RVC::OBJECTNAME& StyleTableName,       
         const void *dftstyle             
         );

      int StyleDialogOpen (
         MDLGPARENT parent                
         );

      int StyleDialogClose (
         );

      int TableCreate (
         MDLGPARENT parent,               
         const RVC::DBTABLE::MAKEPARMS& MakeParms,          
         const RVC::DESCRIPTOR* Descriptor = 0     
         );

      int TableCreate (
         MDLGPARENT parent             
         );

      int TableDrop (
         MDLGPARENT parent,               
         int TableNum                     
         );

      int TableEditDefinition (
         MDLGPARENT parent,               
         int TableNum                     
         );

      ERRVALUE TableEditACL (
         MDLGPARENT parent,               
         int TableNum                     
         );

      int TableOpen (
         INT32 TableNum,                  
         VIEWFLAGS flags = VIEWFLAG_None  
         );

      int TableClose (
         INT32 TableNum                   
         );

      int TableDestroy (
         int TableNum                     
         );

      int UpdateDialogs ();

      int UpdateResume (
         );

      void UpdateSuspend();

      #ifndef GENERATING_DOXYGEN_OUTPUT
      // This is sort of private.  It constructs a SPATMOD::IMAGE::SOURCE
      // from an image stored in a BLOB field.  The reason it's here instead
      // of somewhere public is that it has to keep track of a temp file which
      // it will delete when it can.
      // Eventually we'll have a SOURCE_JPEG and you won't need a special 
      // function anyway.
      #endif

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      class OBSERVER : public RVC::DBASE::OBSERVER {
         public:
            OBSERVER (
               DBEDIT* ddata
               ) : 
               RVC::DBASE::OBSERVER(*ddata->GetDBase()),
               m_ddata(ddata) {}

            virtual ~OBSERVER() {}

            virtual void OnDBListAdd(ELEMTYPE ElemType, INT32 ElemNum);
            virtual void OnDBListChanged(ELEMTYPE ElemType, INT32 ElemNum);
            virtual void OnStructChanged(INT32 TableNum, STRUCTCHANGE SubReason);
            virtual void OnTableAdd(INT32 TableNum);
            virtual void OnTableDropBegin(INT32 TableNum);
            virtual void OnTableDropEnd(INT32 TableNum);
            virtual void OnBulkModifyBegin();
            virtual void OnBulkModifyEnd();
         private:
            DBEDIT* m_ddata;
         };

      MDLGPARENT m_dlgparent;
      CREATEFLAGS m_flags;
      bool m_is_main_level;
      bool m_pin_mapping;
      bool m_multi_select;
      bool m_ReallyIgnoreCallback_DamnIt;
      bool m_NeedUpdate;

      RVC::OBJITEM m_ObjItem;
      RVC::OBJITEM m_ParentObjItem;
      RVC::DBASE_ELEMENT* m_DBase;

      INT32 m_ActiveElemNum;                    
      LONGLIST m_ElemList;
      ELEMTYPE m_ElemType;
      INT32 m_BaseTable;                  
      DBEDIT_TDATA **m_formtdata;
      DBEDIT_TDATA *m_OrphanInstances;    
      int m_numtdatas, m_numforms;
      int m_CreatingTable;                
      MICALLBACKLIST m_CBList;
      struct STYLE {
         RVC::OBJITEM m_StyleObjItem;     
         int m_table;                     
         bool m_bDefaultKnown;
         DBEDIT_STYLEDIALOG *m_dlg;       
         MULTISTYLE m_dft;
            
         STYLE (
            ) :
            m_table(0),
            m_bDefaultKnown(false),
            m_dlg(0)
            { }
         } m_Style;
      RVC::DBASE::OBSERVER *m_DBRelateHandle;
      int m_IgnoreCallback;
      void *m_ClassPrivData[MODE_NumModes];

      MILIST<EVENT> m_DBEventQueue;
      bool m_bDrainingQueue;
      int m_ReallyIgnoreCallbacks;        
      SIMPLE_ARRAY<DBEDIT_TDATA*> m_TableData;
      OBSERVER *m_Observer;
      RVC::CREDENTIALS *m_Credentials;

      DBEDIT_TINSTANCE *FindFormInstance (
         const RVC::OBJITEM& ObjItem
         );

      ERRVALUE ForEachTableInstance (
         int (DBEDIT_TINSTANCE::*Func)(void*),
         void *hookdata
         );

      ERRVALUE ForEachTableInstance (
         int (DBEDIT_TINSTANCE::*Func)(void)
         );

      void DrainQueue ();

      void UpdateDialogsInternal ();

      int EnqueueDBEvent (
         const EVENT& event
         );

      void DequeueDBEvent ();

      void Dispatch (
         const EVENT& event   // ??? should it be const?
         );

      int CreateDBEDIT_TDATA (
         int TableNum
         );

      ERRVALUE OpenDatabaseLow (
         const RVC::OBJITEM& ParentObjItem,
         ELEMTYPE elemtype,
         UINT32 mode,
         const RVC::CREDENTIALS* Credentials
         );

      ERRVALUE SetActiveElementLow (
         ELEMNUM ElemNum,                 
         bool UpdateDialogs,
         INT32 BaseTable = 0              
         );

      friend class DBEDIT_TDATA;
      friend class DBEDIT_TINSTANCE;
      friend class DBEDIT_STYLEDIALOG;
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(DBEDIT::VIEWFLAGS)
DEFINE_ENUM_OP_INCREMENT(DBEDIT::LABELCOLOR)
#endif

//=====================================================================================================================

class DBEDIT_SUSPENDCALLBACKS {
   public:

      DBEDIT_SUSPENDCALLBACKS (
         DBEDIT *ddata, 
         bool NoQueue = false       
         ):
         m_ddata(ddata),
         m_NoQueue(NoQueue)
         {
         if (m_ddata != 0) m_ddata->DBCallbackSuspend(m_NoQueue);
         }

      ~DBEDIT_SUSPENDCALLBACKS (
         ) {
         if (m_ddata != 0) m_ddata->DBCallbackResume(m_NoQueue);
         }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      DBEDIT *m_ddata;
      bool m_NoQueue;
      #endif // GENERATING_DOXYGEN_OUTPUT
   };
   
//=====================================================================================================================

#endif

---