added CentreOnScreen(), updated the docs to clear this mess a bit

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

diff --git a/include/wx/odbc.h b/include/wx/odbc.h
index 0f6756adcca9bf2382fa908d2e617010a0e3cb95..ca7e8fae8fe97f17dbcd6faa9f311aa30f14f954 100644 (file)
--- a/include/wx/odbc.h
+++ b/include/wx/odbc.h
@@ -6,21 +6,41 @@
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart and Markus Holzem
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart and Markus Holzem

-// Licence:    wxWindows licence
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #include "wx/setup.h"
 
 /////////////////////////////////////////////////////////////////////////////
 
 #include "wx/setup.h"
 

-#if USE_ODBC
+#if wxUSE_ODBC

 
 

-#ifndef __ODBCH__
-#define __ODBCH__
-
-#ifdef __WINDOWS__
-#include <windows.h>
+#ifdef __GNUG__
+#pragma interface "odbc.h"

 #endif
 
 #endif
 

-#include <sqlext.h>
+#ifndef _WX_ODBCH__
+#define _WX_ODBCH__
+
+//#ifdef __WXMSW__
+//#include <windows.h>
+//#endif
+
+
+#ifdef __UNIX__
+extern "C"
+{
+    #include "../../src/iodbc/isql.h"
+    #include "../../src/iodbc/isqlext.h"
+    #include "../../src/iodbc/odbc_funcs.h"
+    #include "../../src/iodbc/odbc_types.h"
+
+    typedef float   SFLOAT;
+    typedef double  SDOUBLE;
+
+    #define ULONG UDWORD
+}
+#else // !Unix
+    #include <sqlext.h>
+#endif // Unix/!Unix

 
 #include "wx/defs.h"
 #include "wx/list.h"
 
 #include "wx/defs.h"
 #include "wx/list.h"


@@ -43,13 +63,11 @@ class WXDLLEXPORT wxRecordSet;
 
 class WXDLLEXPORT wxDatabase: public wxObject
 {
 
 class WXDLLEXPORT wxDatabase: public wxObject
 {

-  // JACS

   DECLARE_DYNAMIC_CLASS(wxDatabase)
   DECLARE_DYNAMIC_CLASS(wxDatabase)

- private:

  protected:
   static HENV hEnv;
   static int refCount;
  protected:
   static HENV hEnv;
   static int refCount;

-  
+

   HDBC hDBC;
   char* username;
   char* password;
   HDBC hDBC;
   char* username;
   char* password;


@@ -68,17 +86,17 @@ class WXDLLEXPORT wxDatabase: public wxObject
   wxList recordSets; // Record sets: Added by JACS
 
  public:
   wxList recordSets; // Record sets: Added by JACS
 
  public:

-  wxDatabase(void);
-  ~wxDatabase(void);
-  
+  wxDatabase();
+  ~wxDatabase();
+

   bool Open(char *, bool exclusive =FALSE, bool readOnly =TRUE, char *username ="ODBC", char *password ="");
   bool Open(char *, bool exclusive =FALSE, bool readOnly =TRUE, char *username ="ODBC", char *password ="");

-  bool Close(void);
+  bool Close();

 
   // Cleanup operations, added by JACS
   void DeleteRecordSets(void); // Called when the database is deleted
   void ResetRecordSets(void); // Required if the database is closed
   inline wxList& GetRecordSets(void) { return recordSets; }
 
   // Cleanup operations, added by JACS
   void DeleteRecordSets(void); // Called when the database is deleted
   void ResetRecordSets(void); // Required if the database is closed
   inline wxList& GetRecordSets(void) { return recordSets; }

-  
+

   inline char *GetUsername(void) { return username; }
   inline char *GetPassword(void) { return password; }
   inline char *GetDataSource(void) { return datasource; }
   inline char *GetUsername(void) { return username; }
   inline char *GetPassword(void) { return password; }
   inline char *GetDataSource(void) { return datasource; }


@@ -86,31 +104,31 @@ class WXDLLEXPORT wxDatabase: public wxObject
   inline wxRETCODE GetErrorCode(void) { return retcode; }
   inline HDBC GetHDBC(void) { return hDBC; }
   inline HENV GetHENV(void) { return hEnv; }
   inline wxRETCODE GetErrorCode(void) { return retcode; }
   inline HDBC GetHDBC(void) { return hDBC; }
   inline HENV GetHENV(void) { return hEnv; }

-  
+

   void SetPassword(char *s);
   void SetUsername(char *s);
   void SetDataSource(char *s);
   void SetPassword(char *s);
   void SetUsername(char *s);
   void SetDataSource(char *s);

-  
+

   // Database attributes
   // Database attributes

-  char *GetDatabaseName(void);
-  bool CanUpdate(void);
-  bool CanTransact(void);
-  bool InWaitForDataSource(void);
+  char *GetDatabaseName();
+  bool CanUpdate();
+  bool CanTransact();
+  bool InWaitForDataSource();

   void SetLoginTimeout(long seconds);
   void SetQueryTimeout(long seconds);
   void SetSynchronousMode(bool synchronous);
 
   // Database operations
   void SetLoginTimeout(long seconds);
   void SetQueryTimeout(long seconds);
   void SetSynchronousMode(bool synchronous);
 
   // Database operations

-  bool BeginTrans(void);
-  bool CommitTrans(void);
-  bool RollbackTrans(void);
-  void Cancel(void);
+  bool BeginTrans();
+  bool CommitTrans();
+  bool RollbackTrans();
+  void Cancel();

 
   // Error handling
 
   // Error handling

-  bool ErrorOccured(void);
-  char* GetErrorMessage(void);
-  long  GetErrorNumber(void);
-  char* GetErrorClass(void);
+  bool ErrorOccured();
+  char* GetErrorMessage();
+  long  GetErrorNumber();
+  char* GetErrorClass();

   inline void ErrorSnapshot(HSTMT =SQL_NULL_HSTMT);
 
   // Overridables
   inline void ErrorSnapshot(HSTMT =SQL_NULL_HSTMT);
 
   // Overridables


@@ -137,23 +155,23 @@ class WXDLLEXPORT wxQueryField: public wxObject
   long size;
   bool dirty;
 
   long size;
   bool dirty;
 

-  bool AllocData(void);
+  bool AllocData();

 
   public:
 
   public:

-  wxQueryField(void);
-  ~wxQueryField(void);
-  
+  wxQueryField();
+  ~wxQueryField();
+

   bool SetData(void*, long);
   void SetDirty(bool =TRUE);
   bool SetData(void*, long);
   void SetDirty(bool =TRUE);

-  void ClearData(void);
+  void ClearData();

   void SetType(short);
   void SetSize(long);
   void SetType(short);
   void SetSize(long);

-  
-  void* GetData(void);
-  short GetType(void);
-  long GetSize(void);
-  
-  bool IsDirty(void);
+
+  void* GetData();
+  short GetType();
+  long GetSize();
+
+  bool IsDirty();

 };
 
 // Represents a column description
 };
 
 // Represents a column description


@@ -167,13 +185,13 @@ class WXDLLEXPORT wxQueryCol: public wxObject
   bool nullable;
   long varsize;
   void* var;
   bool nullable;
   long varsize;
   void* var;

-  
+

   public:
   wxList fields;
   public:
   wxList fields;

-  
-  wxQueryCol(void);
-  ~wxQueryCol(void);
-  
+
+  wxQueryCol();
+  ~wxQueryCol();
+

   void* BindVar(void*, long);
   void FillVar(int);
   void AppendField(void*, long);
   void* BindVar(void*, long);
   void FillVar(int);
   void AppendField(void*, long);


@@ -182,10 +200,10 @@ class WXDLLEXPORT wxQueryCol: public wxObject
   void SetNullable(bool);
   void SetFieldDirty(int, bool =TRUE);
   void SetType(short);
   void SetNullable(bool);
   void SetFieldDirty(int, bool =TRUE);
   void SetType(short);

-  
-  char* GetName(void);
-  short GetType(void);
-  bool IsNullable(void);
+
+  char* GetName();
+  short GetType();
+  bool IsNullable();

   void* GetData(int);
   long GetSize(int);
 
   void* GetData(int);
   long GetSize(int);
 


@@ -200,7 +218,7 @@ class WXDLLEXPORT wxRecordSet: public wxObject
   int cursor;
   int type;
   int options;
   int cursor;
   int type;
   int options;

-  
+

   protected:
   HSTMT hStmt;
   int nFields;
   protected:
   HSTMT hStmt;
   int nFields;


@@ -215,48 +233,50 @@ class WXDLLEXPORT wxRecordSet: public wxObject
   wxRETCODE retcode;
   wxList cols;
   wxList fetchbuf;
   wxRETCODE retcode;
   wxList cols;
   wxList fetchbuf;

-  
+

   void FillVars(int);
 
   public:
   // JACS gave parent a default value for benefit of IMPLEMENT_DYNAMIC_CLASS
   void FillVars(int);
 
   public:
   // JACS gave parent a default value for benefit of IMPLEMENT_DYNAMIC_CLASS

-  wxRecordSet(wxDatabase *parent = NULL, int =wxOPEN_TYPE_DYNASET, int =wxOPTION_DEFAULT);
-  ~wxRecordSet(void);
-  
+  wxRecordSet(wxDatabase *parent = NULL,
+              int = wxOPEN_TYPE_DYNASET,
+              int = wxOPTION_DEFAULT);
+  ~wxRecordSet();
+

   // My own, lower-level functions.
   bool BeginQuery(int openType, char *sql = NULL, int options = wxOPTION_DEFAULT);
   // My own, lower-level functions.
   bool BeginQuery(int openType, char *sql = NULL, int options = wxOPTION_DEFAULT);

-  bool EndQuery(void);
+  bool EndQuery();

   bool Query(char* columns, char* table =NULL, char *filter =NULL);
 
   // Attributes
   inline int GetNumberFields(void) { return nFields; }
   inline int GetNumberParams(void) { return nParams; }
   bool Query(char* columns, char* table =NULL, char *filter =NULL);
 
   // Attributes
   inline int GetNumberFields(void) { return nFields; }
   inline int GetNumberParams(void) { return nParams; }

-  long GetNumberRecords(void);
-  long GetNumberCols(void);
+  long GetNumberRecords();
+  long GetNumberCols();

   inline char *GetFilter(void) { return recordFilter; }
   inline char *GetSortString(void) { return sortString; }
   inline wxDatabase *GetDatabase(void) { return parentdb; }
   inline wxRETCODE GetErrorCode(void) { return retcode; }
   inline char *GetFilter(void) { return recordFilter; }
   inline char *GetSortString(void) { return sortString; }
   inline wxDatabase *GetDatabase(void) { return parentdb; }
   inline wxRETCODE GetErrorCode(void) { return retcode; }

-  bool CanAppend(void);
-  bool CanRestart(void);
-  bool CanScroll(void);
-  bool CanTransact(void);
-  bool CanUpdate(void);
-  long GetCurrentRecord(void);
-  bool RecordCountFinal(void);
-  bool GetResultSet(void);
+  bool CanAppend();
+  bool CanRestart();
+  bool CanScroll();
+  bool CanTransact();
+  bool CanUpdate();
+  long GetCurrentRecord();
+  bool RecordCountFinal();
+  bool GetResultSet();

   bool ExecuteSQL(char*);
   bool ExecuteSQL(char*);

-  bool GetTables(void);
+  bool GetTables();

   bool GetColumns(char* =NULL);
   bool GetPrimaryKeys(char* =NULL);
   bool GetForeignKeys(char* , char * );
   bool GetColumns(char* =NULL);
   bool GetPrimaryKeys(char* =NULL);
   bool GetForeignKeys(char* , char * );

-  char *GetTableName(void);
+  char *GetTableName();

   void SetTableName(char*);
   void SetTableName(char*);

-  char *GetSQL(void);
-  bool IsOpen(void);
-  bool IsBOF(void);
-  bool IsEOF(void);
-  bool IsDeleted(void);
+  char *GetSQL();
+  bool IsOpen();
+  bool IsBOF();
+  bool IsEOF();
+  bool IsDeleted();

 
   bool GetFieldData(int colPos, int dataType, void *dataPtr);
   bool GetFieldData(const char*, int dataType, void *dataPtr);
 
   bool GetFieldData(int colPos, int dataType, void *dataPtr);
   bool GetFieldData(const char*, int dataType, void *dataPtr);


@@ -269,54 +289,54 @@ class WXDLLEXPORT wxRecordSet: public wxObject
   void* BindVar(const char*, void*, long);
 
   void SetType(int);
   void* BindVar(const char*, void*, long);
 
   void SetType(int);

-  int GetType(void);
+  int GetType();

   void SetOptions(int);
   void SetOptions(int);

-  int GetOptions(void);
-    
+  int GetOptions();
+

   // Update operations
   // Update operations

-  void AddNew(void);
-  bool Delete(void);
-  void Edit(void);
-  bool Update(void);
+  void AddNew();
+  bool Delete();
+  void Edit();
+  bool Update();

 
   // Record navigation
   virtual bool Move(long rows);
 
   // Record navigation
   virtual bool Move(long rows);

-  virtual bool MoveFirst(void);
-  virtual bool MoveLast(void);
-  virtual bool MoveNext(void);
-  virtual bool MovePrev(void);
+  virtual bool MoveFirst();
+  virtual bool MoveLast();
+  virtual bool MoveNext();
+  virtual bool MovePrev();

   virtual bool GoTo(long);
 
   // Others
   virtual bool GoTo(long);
 
   // Others

-  bool GetDataSources(void);
+  bool GetDataSources();

 
   // Associate a column name/position with a data location
   //   bool BindColumn(int colPos, int dataType, void *dataPtr);
 
 
   // Associate a column name/position with a data location
   //   bool BindColumn(int colPos, int dataType, void *dataPtr);
 

-  void Cancel(void);
+  void Cancel();

   bool IsFieldDirty(int);
   bool IsFieldDirty(const char*);
   bool IsFieldNull(int);
   bool IsFieldNull(const char*);
   bool IsColNullable(int);
   bool IsColNullable(const char*);
   bool IsFieldDirty(int);
   bool IsFieldDirty(const char*);
   bool IsFieldNull(int);
   bool IsFieldNull(const char*);
   bool IsColNullable(int);
   bool IsColNullable(const char*);

-  virtual bool Requery(void);
+  virtual bool Requery();

   virtual void SetFieldDirty(int, bool dirty = TRUE);
   virtual void SetFieldDirty(const char*, bool dirty = TRUE);
   void SetFieldNull(void *p, bool isNull = TRUE);
 
   // Overridables
   virtual void SetFieldDirty(int, bool dirty = TRUE);
   virtual void SetFieldDirty(const char*, bool dirty = TRUE);
   void SetFieldNull(void *p, bool isNull = TRUE);
 
   // Overridables

-  virtual char *GetDefaultConnect(void);
-  virtual char *GetDefaultSQL(void);
-  
+  virtual char *GetDefaultConnect();
+  virtual char *GetDefaultSQL();
+

   // Internal
   // Internal

-  
+

   // Build SQL query from column specification
   // Build SQL query from column specification

-  bool ConstructDefaultSQL(void);
+  bool ConstructDefaultSQL();

   void SetDefaultSQL(char *s);
   bool ReleaseHandle(void); // Added JACS
 };
 
 #endif
 
   void SetDefaultSQL(char *s);
   bool ReleaseHandle(void); // Added JACS
 };
 
 #endif
 

-#endif  // USE_ODBC
+#endif  // wxUSE_ODBC