applied Greg's refinment of hist treectrl patch

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

diff --git a/include/wx/db.h b/include/wx/db.h
index 86fa70404ca19c141535ee5956d0cbba474484c3..57ec4345f7015779c15317f61a13bb2b43bc9f90 100644 (file)
--- a/include/wx/db.h
+++ b/include/wx/db.h
@@ -54,6 +54,9 @@
 
 #include "wx/setup.h"
 
+#include "wx/defs.h"
+#include "wx/string.h"
+
 extern "C" {
 #ifdef __VISUALC__
 // If you use the wxDbCreateDataSource() function with MSW/VC6,
@@ -624,6 +627,14 @@ public:
                                  const wxChar *userID=NULL, const wxChar *schema=NULL, 
                                  const wxString &path=wxEmptyString);
 
+    // These two functions return the table name or column name in a form ready
+    // for use in SQL statements.  For example, if the datasource allows spaces
+    // in the table name or column name, the returned string will have the
+    // correct enclosing marks around the name to allow it to be properly 
+    // included in a SQL statement
+    const wxString  SQLTableName(const wxChar *tableName);
+    const wxString  SQLColumnName(const wxChar *colName);
+
     void         LogError(const wxString &errMsg, const wxString &SQLState = wxEmptyString) 
                         { logError(errMsg, SQLState); }
     void         SetDebugErrorMessages(bool state) { silent = !state; }
@@ -683,12 +694,11 @@ void  WXDLLEXPORT  wxDbCloseConnections(void);
 int   WXDLLEXPORT  wxDbConnectionsInUse(void);
 
 
-//TODO: document
 // Writes a message to the wxLog window (stdout usually) when an internal error
 // situation occurs.  This function only works in DEBUG builds
 const wxChar WXDLLEXPORT *wxDbLogExtendedErrorMsg(const wxChar *userText, wxDb *pDb,
-                                                  char *ErrFile, int ErrLine);
-//TODO: end document
+                                                  wxChar *ErrFile, int ErrLine);
+
 
 // This function sets the sql log state for all open wxDb objects
 bool  WXDLLEXPORT  wxDbSqlLog(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME);