]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/dbtable.h
wxCocoa: Added (mostly) stubs for wxGLCanvas and friends.
[wxWidgets.git] / include / wx / dbtable.h
index 5db2af00bb27c026bda43382724d88ebbe9dbf92..d59066b2151c1f1088c5cb7e8afe6057f2377343 100644 (file)
@@ -8,16 +8,7 @@
 // Created:     9.96
 // RCS-ID:      $Id$
 // Copyright:   (c) 1996 Remstar International, Inc.
-// Licence:     wxWindows licence, plus:
-// Notice:      This class library and its intellectual design are free of charge for use,
-//              modification, enhancement, debugging under the following conditions:
-//              1) These classes may only be used as part of the implementation of a
-//                 wxWindows-based application
-//              2) All enhancements and bug fixes are to be submitted back to the wxWindows
-//                 user groups free of all charges for use with the wxWindows library.
-//              3) These classes may not be distributed as part of any other class library,
-//                 DLL, text (written or electronic), other than a complete distribution of
-//                 the wxWindows GUI development toolkit.
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 /*
 #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"
 
-#if wxMAJOR_VERSION == 2
-    #ifdef __GNUG__
-        #pragma interface "dbtable.h"
-    #endif
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+  #pragma interface "dbtable.h"
 #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 bool  wxDB_QUERY_ONLY      = TRUE;
-const bool  wxDB_DISABLE_VIEW    = TRUE;
+const bool  wxDB_QUERY_ONLY      = true;
+const bool  wxDB_DISABLE_VIEW    = true;
 
 // Used to indicate end of a variable length list of
 // column numbers passed to member functions
@@ -62,7 +47,7 @@ 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.
-class WXDLLEXPORT wxDbColDef
+class WXDLLIMPEXP_ODBC wxDbColDef
 {
 public:
     wxChar  ColName[DB_MAX_COLUMN_NAME_LEN+1];  // Column Name
@@ -70,7 +55,7 @@ public:
     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.
+    bool    KeyField;                           // true if this column is part of the PRIMARY KEY to the table; Date fields should NOT be KeyFields.
     bool    Updateable;                         // Specifies whether this column is updateable
     bool    InsertAllowed;                      // Specifies whether this column should be included in an INSERT statement
     bool    DerivedCol;                         // Specifies whether this column is a derived value
@@ -83,7 +68,7 @@ public:
 };  // wxDbColDef
 
 
-class WXDLLEXPORT wxDbColDataPtr
+class WXDLLIMPEXP_ODBC wxDbColDataPtr
 {
 public:
     void    *PtrDataObj;
@@ -93,7 +78,7 @@ public:
 
 
 // This structure is used when creating secondary indexes.
-class WXDLLEXPORT wxDbIdxDef
+class WXDLLIMPEXP_ODBC wxDbIdxDef
 {
 public:
     wxChar  ColName[DB_MAX_COLUMN_NAME_LEN+1];
@@ -101,7 +86,7 @@ public:
 };  // wxDbIdxDef
 
 
-class WXDLLEXPORT wxDbTable
+class WXDLLIMPEXP_ODBC wxDbTable
 {
 private:
     ULONG       tableID;  // Used for debugging.  This can help to match up mismatched constructors/destructors
@@ -115,6 +100,7 @@ private:
                        const wxString &qryTblName, bool qryOnly, const wxString &tblPath);
     void        cleanup();
 
+    void        setCbValueForColumn(int columnIndex);
     bool        bindParams(bool forUpdate);  // called by the other 'bind' functions
     bool        bindInsertParams(void);
     bool        bindUpdateParams(void);
@@ -195,27 +181,27 @@ public:
 #endif
     // Public member functions
     wxDbTable(wxDb *pwxDb, const wxString &tblName, const UWORD numColumns,
-              const wxString &qryTblName="", bool qryOnly = !wxDB_QUERY_ONLY, 
-              const wxString &tblPath="");
+              const wxString &qryTblName=wxEmptyString, bool qryOnly = !wxDB_QUERY_ONLY,
+              const wxString &tblPath=wxEmptyString);
 
     // DEPRECATED
     wxDbTable(wxDb *pwxDb, const wxString &tblName, const UWORD numColumns,
-              const wxChar *qryTblName="", bool qryOnly = !wxDB_QUERY_ONLY, 
-              const wxString &tblPath="");
+              const wxChar *qryTblName=wxEmptyString, bool qryOnly = !wxDB_QUERY_ONLY,
+              const wxString &tblPath=wxEmptyString);
 
     virtual ~wxDbTable();
 
-    bool            Open(bool checkPrivileges=FALSE, bool checkTableExists=TRUE);
-    bool            CreateTable(bool attemptDrop=TRUE);
+    bool            Open(bool checkPrivileges=false, bool checkTableExists=true);
+    bool            CreateTable(bool attemptDrop=true);
     bool            DropTable(void);
-    bool            CreateIndex(const wxString &idxName, bool unique, UWORD noIdxCols, 
-                                wxDbIdxDef *pIdxDefs, bool attemptDrop=TRUE);
+    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
-    // set when the wxDbTable instance is created and 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; }
@@ -252,10 +238,10 @@ public:
     bool            Delete(void);
     bool            DeleteWhere(const wxString &pWhereClause);
     bool            DeleteMatching(void);
-    virtual bool    Query(bool forUpdate = FALSE, bool distinct = FALSE);
+    virtual bool    Query(bool forUpdate = false, bool distinct = false);
     bool            QueryBySqlStmt(const wxString &pSqlStmt);
-    bool            QueryMatching(bool forUpdate = FALSE, bool distinct = FALSE);
-    bool            QueryOnKeyFields(bool forUpdate = FALSE, bool distinct = FALSE);
+    bool            QueryMatching(bool forUpdate = false, bool distinct = false);
+    bool            QueryOnKeyFields(bool forUpdate = false, bool distinct = false);
     bool            Refresh(void);
     bool            GetNext(void)   { return(getRec(SQL_FETCH_NEXT));  }
     bool            operator++(int) { return(getRec(SQL_FETCH_NEXT));  }
@@ -273,14 +259,14 @@ public:
     void            BuildSelectStmt(wxString &pSqlStmt, int typeOfSelect, bool distinct);
     void            BuildSelectStmt(wxChar *pSqlStmt, int typeOfSelect, bool distinct);
 
-    void            BuildDeleteStmt(wxString &pSqlStmt, int typeOfDel, const wxString &pWhereClause="");
-    void            BuildDeleteStmt(wxChar *pSqlStmt, int typeOfDel, const wxString &pWhereClause="");
+    void            BuildDeleteStmt(wxString &pSqlStmt, int typeOfDel, const wxString &pWhereClause=wxEmptyString);
+    void            BuildDeleteStmt(wxChar *pSqlStmt, int typeOfDel, const wxString &pWhereClause=wxEmptyString);
 
-    void            BuildUpdateStmt(wxString &pSqlStmt, int typeOfUpd, const wxString &pWhereClause="");
-    void            BuildUpdateStmt(wxChar *pSqlStmt, int typeOfUpd, const wxString &pWhereClause="");
+    void            BuildUpdateStmt(wxString &pSqlStmt, int typeOfUpd, const wxString &pWhereClause=wxEmptyString);
+    void            BuildUpdateStmt(wxChar *pSqlStmt, int typeOfUpd, const wxString &pWhereClause=wxEmptyString);
 
-    void            BuildWhereClause(wxString &pWhereClause, int typeOfWhere, const wxString &qualTableName="", bool useLikeComparison=FALSE);
-    void            BuildWhereClause(wxChar *pWhereClause, int typeOfWhere, const wxString &qualTableName="", bool useLikeComparison=FALSE);
+    void            BuildWhereClause(wxString &pWhereClause, int typeOfWhere, const wxString &qualTableName=wxEmptyString, bool useLikeComparison=false);
+    void            BuildWhereClause(wxChar *pWhereClause, int typeOfWhere, const wxString &qualTableName=wxEmptyString, bool useLikeComparison=false);
 
 #if wxODBC_BACKWARD_COMPATABILITY
 // The following member functions are deprecated.  You should use the BuildXxxxxStmt functions (above)
@@ -290,48 +276,74 @@ public:
                            { BuildDeleteStmt(pSqlStmt,typeOfDel,pWhereClause); }
     void            GetUpdateStmt(char *pSqlStmt, int typeOfUpd, const char *pWhereClause = NULL)
                            { BuildUpdateStmt(pSqlStmt,typeOfUpd,pWhereClause); }
-    void            GetWhereClause(char *pWhereClause, int typeOfWhere, 
-                                   const char *qualTableName = NULL, bool useLikeComparison=FALSE)
+    void            GetWhereClause(char *pWhereClause, int typeOfWhere,
+                                   const char *qualTableName = NULL, bool useLikeComparison=false)
                            { BuildWhereClause(pWhereClause,typeOfWhere,qualTableName,useLikeComparison); }
 #endif
     bool            CanSelectForUpdate(void);
     bool            CanUpdByROWID(void);
-    void            ClearMemberVar(UWORD colNo, bool setToNull=FALSE);
-    void            ClearMemberVars(bool setToNull=FALSE);
+    void            ClearMemberVar(UWORD colNo, bool setToNull=false);
+    void            ClearMemberVars(bool setToNull=false);
     bool            SetQueryTimeout(UDWORD nSeconds);
 
     wxDbColDef     *GetColDefs() { return colDefs; }
-    void            SetColDefs(UWORD index, const wxString &fieldName, int dataType, 
+    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, UWORD numCols);
 
     bool            CloseCursor(HSTMT cursor);
     bool            DeleteCursor(HSTMT *hstmtDel);
     void            SetCursor(HSTMT *hstmtActivate = (void **) wxDB_DEFAULT_CURSOR);
     HSTMT           GetCursor(void) { return(hstmt); }
-    HSTMT          *GetNewCursor(bool setCursor = FALSE, bool bindColumns = TRUE);
+    HSTMT          *GetNewCursor(bool setCursor = false, bool bindColumns = true);
 #if wxODBC_BACKWARD_COMPATABILITY
 // The following member function is deprecated.  You should use the GetNewCursor
-    HSTMT          *NewCursor(bool setCursor = FALSE, bool bindColumns = TRUE) {  return GetNewCursor(setCursor,bindColumns); }
+    HSTMT          *NewCursor(bool setCursor = false, bool bindColumns = true) {  return GetNewCursor(setCursor,bindColumns); }
 #endif
 
-    ULONG           Count(const wxString &args="*");
+    ULONG           Count(const wxString &args=_T("*"));
     int             DB_STATUS(void) { return(pDb->DB_STATUS); }
 
-    bool            IsColNull(UWORD colNo);
-    bool            SetColNull(UWORD colNo, bool set=TRUE);
-    bool            SetColNull(const wxString &colName, 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            SetNull(int colNo, bool set=TRUE) { return (SetNull(colNo,set)); }
-    bool            SetNull(const char *colName, bool set=TRUE) { return (SetNull(colName,set)); }
+    bool            SetNull(int colNo, bool set=true) { return (SetNull(colNo,set)); }
+    bool            SetNull(const char *colName, bool set=true) { return (SetNull(colName,set)); }
 #endif
 #ifdef __WXDEBUG__
     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