implement support for returning several elements at once from IEnumFORMATETC (part...

[wxWidgets.git] / include / wx / dbtable.h

diff --git a/include/wx/dbtable.h b/include/wx/dbtable.h
index 2e98f16b35ab7c3a646243db9c25dac31e9d34f3..ec15ded2d3472cdc7024288da3f43bd1dfbbd0c9 100644 (file)
--- a/include/wx/dbtable.h
+++ b/include/wx/dbtable.h
@@ -28,22 +28,16 @@
 #ifndef DBTABLE_DOT_H
 #define DBTABLE_DOT_H
 
 #ifndef DBTABLE_DOT_H
 #define DBTABLE_DOT_H
 

-// Use this line for wxWindows v1.x
-//#include "wx_ver.h"
-// Use this line for wxWindows v2.x

 #include "wx/version.h"
 
 #include "wx/version.h"
 

-#if wxMAJOR_VERSION == 2
-    #ifdef __GNUG__
-        #pragma interface "dbtable.h"
-    #endif
+#if defined(__GNUG__) && !defined(__APPLE__)
+  #pragma interface "dbtable.h"

 #endif
 
 #endif
 

-#if wxMAJOR_VERSION == 2
-    #include "wx/db.h"
-#else
-    #include "db.h"
-#endif
+#include "wx/db.h"
+
+#include "wx/variant.h"
+#include "wx/dbkeyg.h"

 
 const int   wxDB_ROWID_LEN       = 24;  // 18 is the max, 24 is in case it gets larger
 const int   wxDB_DEFAULT_CURSOR  = 0;
 
 const int   wxDB_ROWID_LEN       = 24;  // 18 is the max, 24 is in case it gets larger
 const int   wxDB_DEFAULT_CURSOR  = 0;


@@ -62,12 +56,12 @@ const int   wxDB_NO_MORE_COLUMN_NUMBERS = -1;
 // wxDbTable class which allows it to create a table in the data
 // source, exchange data between the data source and the C++
 // object, and so on.
 // wxDbTable class which allows it to create a table in the data
 // source, exchange data between the data source and the C++
 // object, and so on.

-class WXDLLEXPORT wxDbColDef
+class WXDLLIMPEXP_BASE wxDbColDef

 {
 public:
     wxChar  ColName[DB_MAX_COLUMN_NAME_LEN+1];  // Column Name
     int     DbDataType;                         // Logical Data Type; e.g. DB_DATA_TYPE_INTEGER
 {
 public:
     wxChar  ColName[DB_MAX_COLUMN_NAME_LEN+1];  // Column Name
     int     DbDataType;                         // Logical Data Type; e.g. DB_DATA_TYPE_INTEGER

-    int     SqlCtype;                           // C data type; e.g. SQL_C_LONG
+    SWORD   SqlCtype;                           // C data type; e.g. SQL_C_LONG

     void   *PtrDataObj;                         // Address of the data object
     int     SzDataObj;                          // Size, in bytes, of the data object
     bool    KeyField;                           // TRUE if this column is part of the PRIMARY KEY to the table; Date fields should NOT be KeyFields.
     void   *PtrDataObj;                         // Address of the data object
     int     SzDataObj;                          // Size, in bytes, of the data object
     bool    KeyField;                           // TRUE if this column is part of the PRIMARY KEY to the table; Date fields should NOT be KeyFields.


@@ -83,17 +77,17 @@ public:
 };  // wxDbColDef
 
 
 };  // wxDbColDef
 
 

-class WXDLLEXPORT wxDbColDataPtr
+class WXDLLIMPEXP_BASE wxDbColDataPtr

 {
 public:
     void    *PtrDataObj;
     int      SzDataObj;
 {
 public:
     void    *PtrDataObj;
     int      SzDataObj;

-    int      SqlCtype;
+    SWORD    SqlCtype;

 };  // wxDbColDataPtr
 
 
 // This structure is used when creating secondary indexes.
 };  // wxDbColDataPtr
 
 
 // This structure is used when creating secondary indexes.

-class WXDLLEXPORT wxDbIdxDef
+class WXDLLIMPEXP_BASE wxDbIdxDef

 {
 public:
     wxChar  ColName[DB_MAX_COLUMN_NAME_LEN+1];
 {
 public:
     wxChar  ColName[DB_MAX_COLUMN_NAME_LEN+1];


@@ -101,7 +95,7 @@ public:
 };  // wxDbIdxDef
 
 
 };  // wxDbIdxDef
 
 

-class WXDLLEXPORT wxDbTable
+class WXDLLIMPEXP_BASE wxDbTable

 {
 private:
     ULONG       tableID;  // Used for debugging.  This can help to match up mismatched constructors/destructors
 {
 private:
     ULONG       tableID;  // Used for debugging.  This can help to match up mismatched constructors/destructors


@@ -111,7 +105,7 @@ private:
     bool        insertable;
 
     // Private member functions
     bool        insertable;
 
     // Private member functions

-    bool        initialize(wxDb *pwxDb, const wxString &tblName, const int nCols,
+    bool        initialize(wxDb *pwxDb, const wxString &tblName, const UWORD numColumns,

                        const wxString &qryTblName, bool qryOnly, const wxString &tblPath);
     void        cleanup();
 
                        const wxString &qryTblName, bool qryOnly, const wxString &tblPath);
     void        cleanup();
 


@@ -153,7 +147,7 @@ private:
     wxString    tablePath;                                 // needed for dBase tables
     wxString    tableName;                                 // Table name
     wxString    queryTableName;                            // Query Table Name
     wxString    tablePath;                                 // needed for dBase tables
     wxString    tableName;                                 // Table name
     wxString    queryTableName;                            // Query Table Name

-    int         noCols;                                    // # of columns in the table
+    UWORD       noCols;                                    // # of columns in the table

     bool        queryOnly;                                 // Query Only, no inserts, updates or deletes
 
     // Column Definitions
     bool        queryOnly;                                 // Query Only, no inserts, updates or deletes
 
     // Column Definitions


@@ -187,43 +181,42 @@ public:
     char        tablePath[wxDB_PATH_MAX];                  // needed for dBase tables
     char        tableName[DB_MAX_TABLE_NAME_LEN+1];        // Table name
     char        queryTableName[DB_MAX_TABLE_NAME_LEN+1];   // Query Table Name
     char        tablePath[wxDB_PATH_MAX];                  // needed for dBase tables
     char        tableName[DB_MAX_TABLE_NAME_LEN+1];        // Table name
     char        queryTableName[DB_MAX_TABLE_NAME_LEN+1];   // Query Table Name

-    int         noCols;                                    // # of columns in the table
+    UWORD       noCols;                                    // # of columns in the table

     bool        queryOnly;                                 // Query Only, no inserts, updates or deletes
 
     // Column Definitions
     wxDbColDef *colDefs;         // Array of wxDbColDef structures
 #endif
     // Public member functions
     bool        queryOnly;                                 // Query Only, no inserts, updates or deletes
 
     // Column Definitions
     wxDbColDef *colDefs;         // Array of wxDbColDef structures
 #endif
     // Public member functions

-    wxDbTable(wxDb *pwxDb, const wxString &tblName, const int nCols,
+    wxDbTable(wxDb *pwxDb, const wxString &tblName, const UWORD numColumns,

               const wxString &qryTblName="", bool qryOnly = !wxDB_QUERY_ONLY, 
               const wxString &tblPath="");
 
     // DEPRECATED
               const wxString &qryTblName="", bool qryOnly = !wxDB_QUERY_ONLY, 
               const wxString &tblPath="");
 
     // DEPRECATED

-    wxDbTable(wxDb *pwxDb, const wxString &tblName, const int nCols,
+    wxDbTable(wxDb *pwxDb, const wxString &tblName, const UWORD numColumns,

               const wxChar *qryTblName="", bool qryOnly = !wxDB_QUERY_ONLY, 
               const wxString &tblPath="");
 
     virtual ~wxDbTable();
 
               const wxChar *qryTblName="", bool qryOnly = !wxDB_QUERY_ONLY, 
               const wxString &tblPath="");
 
     virtual ~wxDbTable();
 

-    bool            Open(bool checkPrivileges=FALSE);
+    bool            Open(bool checkPrivileges=FALSE, bool checkTableExists=TRUE);

     bool            CreateTable(bool attemptDrop=TRUE);
     bool            DropTable(void);
     bool            CreateTable(bool attemptDrop=TRUE);
     bool            DropTable(void);

-    bool            CreateIndex(const wxString &idxName, bool unique, int noIdxCols, 
+    bool            CreateIndex(const wxString &idxName, bool unique, UWORD noIdxCols, 

                                 wxDbIdxDef *pIdxDefs, bool attemptDrop=TRUE);
     bool            DropIndex(const wxString &idxName);
 
     // Accessors
 
     // The member variables returned by these accessors are all
                                 wxDbIdxDef *pIdxDefs, bool attemptDrop=TRUE);
     bool            DropIndex(const wxString &idxName);
 
     // Accessors
 
     // The member variables returned by these accessors are all

-    // set when the wxDbTable instance is createand cannot be 
+    // set when the wxDbTable instance is created and cannot be 

     // changed, hence there is no corresponding SetXxxx function
     wxDb           *GetDb()              { return pDb; }
     const wxString &GetTableName()       { return tableName; }
     const wxString &GetQueryTableName()  { return queryTableName; }
     const wxString &GetTablePath()       { return tablePath; }
 
     // changed, hence there is no corresponding SetXxxx function
     wxDb           *GetDb()              { return pDb; }
     const wxString &GetTableName()       { return tableName; }
     const wxString &GetQueryTableName()  { return queryTableName; }
     const wxString &GetTablePath()       { return tablePath; }
 

-    int             GetNumberOfColumns() { return noCols; }  // number of "defined" columns for this wxDbTable instance
-       
+    UWORD           GetNumberOfColumns() { return noCols; }  // number of "defined" columns for this wxDbTable instance

 
     const wxString &GetFromClause()      { return from; }
     const wxString &GetOrderByClause()   { return orderBy; }
 
     const wxString &GetFromClause()      { return from; }
     const wxString &GetOrderByClause()   { return orderBy; }


@@ -237,7 +230,7 @@ public:
 #else
     void            SetFromClause(const wxString &From) { from = From; }
     void            SetOrderByClause(const wxString &OrderBy) { orderBy = OrderBy; }
 #else
     void            SetFromClause(const wxString &From) { from = From; }
     void            SetOrderByClause(const wxString &OrderBy) { orderBy = OrderBy; }

-    bool            SetOrderByColNums(int first, ...);
+    bool            SetOrderByColNums(UWORD first, ...);

     void            SetWhereClause(const wxString &Where) { where = Where; }
     void            From(const wxString &From) { from = From; }
     void            OrderBy(const wxString &OrderBy) { orderBy = OrderBy; }
     void            SetWhereClause(const wxString &Where) { where = Where; }
     void            From(const wxString &From) { from = From; }
     void            OrderBy(const wxString &OrderBy) { orderBy = OrderBy; }


@@ -297,16 +290,16 @@ public:
 #endif
     bool            CanSelectForUpdate(void);
     bool            CanUpdByROWID(void);
 #endif
     bool            CanSelectForUpdate(void);
     bool            CanUpdByROWID(void);

-    void            ClearMemberVar(int colNo, bool setToNull=FALSE);
+    void            ClearMemberVar(UWORD colNo, bool setToNull=FALSE);

     void            ClearMemberVars(bool setToNull=FALSE);
     bool            SetQueryTimeout(UDWORD nSeconds);
 
     wxDbColDef     *GetColDefs() { return colDefs; }
     void            ClearMemberVars(bool setToNull=FALSE);
     bool            SetQueryTimeout(UDWORD nSeconds);
 
     wxDbColDef     *GetColDefs() { return colDefs; }

-    void            SetColDefs(int index, const wxString &fieldName, int dataType, 
-                               void *pData, int cType,
+    void            SetColDefs(UWORD index, const wxString &fieldName, int dataType, 
+                               void *pData, SWORD cType,

                                int size, bool keyField = FALSE, bool upd = TRUE,
                                bool insAllow = TRUE, bool derivedCol = FALSE);
                                int size, bool keyField = FALSE, bool upd = TRUE,
                                bool insAllow = TRUE, bool derivedCol = FALSE);

-    wxDbColDataPtr *SetColDefs(wxDbColInf *colInfs, ULONG numCols);
+    wxDbColDataPtr *SetColDefs(wxDbColInf *colInfs, UWORD numCols);

 
     bool            CloseCursor(HSTMT cursor);
     bool            DeleteCursor(HSTMT *hstmtDel);
 
     bool            CloseCursor(HSTMT cursor);
     bool            DeleteCursor(HSTMT *hstmtDel);


@@ -321,8 +314,8 @@ public:
     ULONG           Count(const wxString &args="*");
     int             DB_STATUS(void) { return(pDb->DB_STATUS); }
 
     ULONG           Count(const wxString &args="*");
     int             DB_STATUS(void) { return(pDb->DB_STATUS); }
 

-    bool            IsColNull(int colNo);
-    bool            SetColNull(int colNo, bool set=TRUE);
+    bool            IsColNull(UWORD colNo) const;
+    bool            SetColNull(UWORD colNo, bool set=TRUE);

     bool            SetColNull(const wxString &colName, bool set=TRUE);
 #if wxODBC_BACKWARD_COMPATABILITY
 // The following member functions are deprecated.  You should use the SetColNull()
     bool            SetColNull(const wxString &colName, bool set=TRUE);
 #if wxODBC_BACKWARD_COMPATABILITY
 // The following member functions are deprecated.  You should use the SetColNull()


@@ -333,6 +326,32 @@ public:
     ULONG           GetTableID() { return tableID; }
 #endif
 
     ULONG           GetTableID() { return tableID; }
 #endif
 

+//TODO: Need to Document
+    typedef     enum  { WX_ROW_MODE_QUERY , WX_ROW_MODE_INDIVIDUAL } rowmode_t;
+    virtual     void         SetRowMode(const rowmode_t rowmode);
+    virtual     wxVariant    GetCol(const int colNo) const ;
+    virtual     void         SetCol(const int colNo, const wxVariant value);
+    virtual     GenericKey   GetKey(void);
+    virtual     void         SetKey(const GenericKey &key);
+
+    private:
+        HSTMT      *m_hstmtGridQuery;
+        rowmode_t   m_rowmode;
+        size_t      m_keysize;
+
+//      typedef enum {unmodified=0, UpdatePending, InsertPending } recStatus;
+
+//      recStatus  get_ModifiedStatus() { return m_recstatus; }
+        
+//      void modify() {
+//          if (m_recstatus==unmodified)
+//              m_recstatus=UpdatePending;
+//      }
+//  protected:
+//      void insertify() {m_recstatus=InsertPending; }
+//      void unmodify() {m_recstatus=unmodified; }
+//      recStatus m_recstatus;
+//TODO: Need to Document

 };  // wxDbTable
 
 
 };  // wxDbTable