// Created: 9.96
// RCS-ID: $Id$
// Copyright: (c) 1996 Remstar International, Inc.
-// Licence: wxWidgets 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
-// wxWidgets-based application
-// 2) All enhancements and bug fixes are to be submitted back to the wxWidgets
-// user groups free of all charges for use with the wxWidgets 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 wxWidgets GUI development toolkit.
+// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
/*
#ifndef DBTABLE_DOT_H
#define DBTABLE_DOT_H
-#include "wx/version.h"
-
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
- #pragma interface "dbtable.h"
-#endif
+#include "wx/defs.h"
#include "wx/db.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
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
- SDWORD CbValue; // Internal use only!!!
+ SQLLEN CbValue; // Internal use only!!!
bool Null; // NOT FULLY IMPLEMENTED - Allows NULL values in Inserts and Updates
wxDbColDef();
wxString tablePath; // needed for dBase tables
wxString tableName; // Table name
wxString queryTableName; // Query Table Name
- UWORD noCols; // # of columns in the table
+ UWORD m_numCols; // # of columns in the table
bool queryOnly; // Query Only, no inserts, updates or deletes
// Column Definitions
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
- UWORD noCols; // # of columns in the table
+ UWORD m_numCols; // # of columns in the table
bool queryOnly; // Query Only, no inserts, updates or deletes
// Column Definitions
#endif
// Public member functions
wxDbTable(wxDb *pwxDb, const wxString &tblName, const UWORD numColumns,
- const wxString &qryTblName=wxEmptyString, bool qryOnly = !wxDB_QUERY_ONLY,
+ 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=wxEmptyString, bool qryOnly = !wxDB_QUERY_ONLY,
- const wxString &tblPath=wxEmptyString);
+#if WXWIN_COMPATIBILITY_2_4
+ wxDEPRECATED(
+ wxDbTable(wxDb *pwxDb, const wxString &tblName, const UWORD numColumns,
+ const wxChar *qryTblName, bool qryOnly,
+ const wxString &tblPath)
+ );
+#endif // WXWIN_COMPATIBILITY_2_4
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 DropIndex(const wxString &idxName);
+ bool CreateIndex(const wxString &indexName, bool unique, UWORD numIndexColumns,
+ wxDbIdxDef *pIndexDefs, bool attemptDrop=true);
+ bool DropIndex(const wxString &indexName);
// 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; }
const wxString &GetQueryTableName() { return queryTableName; }
const wxString &GetTablePath() { return tablePath; }
- UWORD GetNumberOfColumns() { return noCols; } // number of "defined" columns for this wxDbTable instance
+ UWORD GetNumberOfColumns() { return m_numCols; } // number of "defined" columns for this wxDbTable instance
const wxString &GetFromClause() { return from; }
const wxString &GetOrderByClause() { return orderBy; }
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)); }
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=wxEmptyString);
- void BuildUpdateStmt(wxChar *pSqlStmt, int typeOfUpd, const wxString &pWhereClause=wxEmptyString);
+ void BuildUpdateStmt(wxString &pSqlStmt, int typeOfUpdate, const wxString &pWhereClause=wxEmptyString);
+ void BuildUpdateStmt(wxChar *pSqlStmt, int typeOfUpdate, const wxString &pWhereClause=wxEmptyString);
- 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);
+ 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)
{ BuildSelectStmt(pSqlStmt,typeOfSelect,distinct); }
void GetDeleteStmt(char *pSqlStmt, int typeOfDel, const char *pWhereClause = NULL)
{ 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 GetUpdateStmt(char *pSqlStmt, int typeOfUpdate, const char *pWhereClause = NULL)
+ { BuildUpdateStmt(pSqlStmt,typeOfUpdate,pWhereClause); }
+ 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);
+#if wxODBC_BACKWARD_COMPATABILITY
+ bool CanUpdByROWID(void) { return CanUpdateByRowID(); };
+#endif
+ bool CanUpdateByROWID(void);
+ void ClearMemberVar(UWORD colNumber, 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,
+ bool 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 updateable = true,
+ bool insertAllowed = true, bool derivedColumn = 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=_T("*"));
int DB_STATUS(void) { return(pDb->DB_STATUS); }
- bool IsColNull(UWORD colNo) const;
- bool SetColNull(UWORD colNo, bool set=TRUE);
- bool SetColNull(const wxString &colName, bool set=TRUE);
+ bool IsColNull(UWORD colNumber) const;
+ bool SetColNull(UWORD colNumber, 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 colNumber, bool set=true) { return (SetNull(colNumber,set)); }
+ bool SetNull(const char *colName, bool set=true) { return (SetNull(colName,set)); }
#endif
#ifdef __WXDEBUG__
ULONG GetTableID() { return tableID; }
//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);
+#if wxODBC_BACKWARD_COMPATABILITY
+ virtual wxVariant GetCol(const int colNumber) const { return GetColumn(colNumber); };
+ virtual void SetCol(const int colNumber, const wxVariant value) { return SetColumn(colNumber, value); };
+#endif
+ virtual wxVariant GetColumn(const int colNumber) const ;
+ virtual void SetColumn(const int colNumber, const wxVariant value);
virtual GenericKey GetKey(void);
virtual void SetKey(const GenericKey &key);
// typedef enum {unmodified=0, UpdatePending, InsertPending } recStatus;
// recStatus get_ModifiedStatus() { return m_recstatus; }
-
+
// void modify() {
// if (m_recstatus==unmodified)
// m_recstatus=UpdatePending;
// Change this to 0 to remove use of all deprecated functions
#if wxODBC_BACKWARD_COMPATABILITY
//#################################################################################
-//############### DEPRECATED functions for backward compatability #################
+//############### DEPRECATED functions for backward compatibility #################
//#################################################################################
// Backward compability. These will eventually go away
projects / wxWidgets.git / blobdiff