wxPg Namespace Reference

wxPostgres namespace. More...


Classes

class  Binding
 Abstract base class for data binding. More...
class  Grid_binding
 Binding wxGrid to display data from wxPg::Result_data_provider. More...
class  List_binding
 Binding containers to contain values from entire column in wxPg::Result_data_provider. More...
class  Row_binding
 Binding widgets to display values from wxPg::Data_row. More...
class  UI_manager
 A container class for updating UI by multiple UI_updaters at once. More...
class  UI_updater
 Abstract base class for changing user interface. More...
class  Cached_result
 Stores entire result of query locally. More...
class  Data_row
 Class, representing a single row of SQL query result. More...
class  Data_row_provider
 Interface, representing a single row of SQL query result. More...
class  Database
 Class for connecting to database and executing SQL statements. More...
class  DB_client
 Class for attaching to wxPg::Database. More...
class  Prepared_statement
 Prepared statement class. More...
class  Query
 Class for executing SQL queries, returning result. More...
class  Query_browser
 Class for executing SQL queries, that return large results. More...
class  Result_data
 Class, representing result of SQL query. More...
class  Result_data_provider
 Interface, representing result of SQL query. More...

Functions

wxPG_DECLSPEC void update_calendar_ctrl (wxWindow *calendar, const wxString &field, Data_row_provider *row)
 Set value of wxCalendarCtrl.
wxPG_DECLSPEC void update_combo_box (wxWindow *combo, const wxString &field, Data_row_provider *row)
 Set value of wxComboBox.
wxPG_DECLSPEC void update_combo_ctrl (wxWindow *combo, const wxString &field, Data_row_provider *row)
 Set value of wxComboCtrl.
wxPG_DECLSPEC void update_rich_text_ctrl (wxWindow *text_ctrl, const wxString &field, Data_row_provider *row)
 Set value of wxRichTextCtrl to value of field.
wxPG_DECLSPEC void update_text_ctrl (wxWindow *text_ctrl, const wxString &field, Data_row_provider *row)
 Set value of wxTextCtrl to value of field.
wxPG_DECLSPEC void update_spin_ctrl (wxWindow *spin, const wxString &field, Data_row_provider *row)
 Set value of wxSpinCtrl to value of field.
wxPG_DECLSPEC void update_static_text (wxWindow *static_text, const wxString &field, Data_row_provider *row)
 Set value of wxStaticText to value of field.
wxPG_DECLSPEC void update_hyperlink_ctrl (wxWindow *hyperlink, const wxString &field, Data_row_provider *row)
 Set value of wxHyperlinkCtrl to value of field.
wxPG_DECLSPEC void update_date_picker_ctrl (wxWindow *date_ctrl, const wxString &field, Data_row_provider *row)
 Set value of wxDatePickerCtrl to value of field.
wxPG_DECLSPEC void update_check_box (wxWindow *check_box, const wxString &field, Data_row_provider *row)
 Set value of wxCheckBox to value of field.
wxPG_DECLSPEC void update_gauge (wxWindow *gauge, const wxString &field, Data_row_provider *row)
 Set value of wxGauge to value of field.
wxPG_DECLSPEC void update_spin_button (wxWindow *spin, const wxString &field, Data_row_provider *row)
 Set value of wxSpinButton to value of field.
wxPG_DECLSPEC void update_item_container (wxWindow *container, const wxString &field, Data_row_provider *row)
 Set value of wxItemContainer to value of field.
wxPG_DECLSPEC void update_radio_box (wxWindow *box, const wxString &field, Data_row_provider *row)
 Set value of wxRadioBox to value of field.
wxPG_DECLSPEC void update_vlist_box (wxWindow *list, const wxString &field, Data_row_provider *row)
 Set value of wxVListBox to value of field.
wxPG_DECLSPEC void update_html_window (wxWindow *html, const wxString &field, Data_row_provider *row)
 Set value of wxHtmlWindow to value of field.
wxPG_DECLSPEC void bind_list_str (List_binding *binding, wxItemContainer *c, const wxString &field)
 Bind c to binding to contain values of column field.
wxPG_DECLSPEC int oid_to_type_simple (int oid)
 Converts OID to type descriptor.
wxPG_DECLSPEC const wxString escape_string (Database &db, const wxString &s, wxString *error=NULL)
 Escapes string.
wxPG_DECLSPEC void cache_result_data (Cached_result &dest, Result_data &src)
 Cache query result locally.
wxPG_DECLSPEC bool cstr_to_bool (char *str, int type)
 Convert C-string to bool.

Variables

const int TYPE_UNKNOWN = 0
 Unknown data type.
const int TYPE_INT = 1
 Represents int2 and int4 types.
const int TYPE_FLOAT = 2
 Represents float4 and float8 types.
const int TYPE_STRING = 3
 Represents char, name and varchar types.
const int TYPE_DATE = 4
 Represents date type.
const int TYPE_TIME = 5
 Represents time type.
const int TYPE_TIMESTAMP = 6
 Represents timestamp type.
const int TYPE_BOOL = 7
 Represents boolean type.


Detailed Description

wxPostgres namespace.


Function Documentation

wxPG_DECLSPEC void wxPg::bind_list_str ( List_binding *  binding,
wxItemContainer *  c,
const wxString &  field 
)

Bind c to binding to contain values of column field.

Parameters:
binding - List_binding to bind c.
c - container to bind.
field - field (database column), to bind to c.

wxPG_DECLSPEC void wxPg::cache_result_data ( Cached_result &  dest,
Result_data &  src 
)

Cache query result locally.

Parameters:
dest - destination, where to store data.
src - source to be stored.

wxPG_DECLSPEC bool wxPg::cstr_to_bool ( char *  str,
int  type 
)

Convert C-string to bool.

Used internally by library. See wxPg::Data_row_provider::get_bool() for details.

Parameters:
str - C-string to convert to bool.
type - one of type constants defined in type.h.
Returns:
str, converted to bool.

wxPG_DECLSPEC const wxString wxPg::escape_string ( Database &  db,
const wxString &  s,
wxString *  error = NULL 
)

Escapes string.

This function is a wrapper around PQescapeStringConn(), see PostgreSQL documentation for more info.

Parameters:
db - a database connection.
s - a string to be escaped.
error - a pointer to string to write error to, can be NULL.
Returns:
escaped string, that can be safely used in SQL statements.

wxPG_DECLSPEC int wxPg::oid_to_type_simple ( int  oid  ) 

Converts OID to type descriptor.

Returns:
one of type constants, defined in type.h.

wxPG_DECLSPEC void wxPg::update_calendar_ctrl ( wxWindow *  calendar,
const wxString &  field,
Data_row_provider *  row 
)

Set value of wxCalendarCtrl.

Parameters:
calendar - wxCalendarCtrl to update.
field - database field name.
row - source to obtain data.

wxPG_DECLSPEC void wxPg::update_check_box ( wxWindow *  check_box,
const wxString &  field,
Data_row_provider *  row 
)

Set value of wxCheckBox to value of field.

Parameters:
check_box - wxCheckBox to update.
field - database field name.
row - source to obtain data.

wxPG_DECLSPEC void wxPg::update_combo_box ( wxWindow *  combo,
const wxString &  field,
Data_row_provider *  row 
)

Set value of wxComboBox.

Parameters:
combo - wxComboBox to update.
field - database field name.
row - source to obtain data.

wxPG_DECLSPEC void wxPg::update_combo_ctrl ( wxWindow *  combo,
const wxString &  field,
Data_row_provider *  row 
)

Set value of wxComboCtrl.

Parameters:
combo - wxComboCtrl to update.
field - database field name.
row - source to obtain data.

wxPG_DECLSPEC void wxPg::update_date_picker_ctrl ( wxWindow *  date_ctrl,
const wxString &  field,
Data_row_provider *  row 
)

Set value of wxDatePickerCtrl to value of field.

Parameters:
date_ctrl - wxDatePickerCtrl to update.
field - database field name.
row - source to obtain data.

wxPG_DECLSPEC void wxPg::update_gauge ( wxWindow *  gauge,
const wxString &  field,
Data_row_provider *  row 
)

Set value of wxGauge to value of field.

Parameters:
gauge - wxGauge to update.
field - database field name.
row - source to obtain data.

wxPG_DECLSPEC void wxPg::update_html_window ( wxWindow *  html,
const wxString &  field,
Data_row_provider *  row 
)

Set value of wxHtmlWindow to value of field.

Parameters:
html - wxHtmlWindow to update.
field - database field name.
row - source to obtain data.

wxPG_DECLSPEC void wxPg::update_hyperlink_ctrl ( wxWindow *  hyperlink,
const wxString &  field,
Data_row_provider *  row 
)

Set value of wxHyperlinkCtrl to value of field.

Parameters:
hyperlink - wxHyperlinkCtrl to update.
field - database field name.
row - source to obtain data.

wxPG_DECLSPEC void wxPg::update_item_container ( wxWindow *  container,
const wxString &  field,
Data_row_provider *  row 
)

Set value of wxItemContainer to value of field.

Parameters:
container - wxItemContainer to update.
field - database field name.
row - source to obtain data.

wxPG_DECLSPEC void wxPg::update_radio_box ( wxWindow *  box,
const wxString &  field,
Data_row_provider *  row 
)

Set value of wxRadioBox to value of field.

Parameters:
box - wxRadioBox to update.
field - database field name.
row - source to obtain data.

wxPG_DECLSPEC void wxPg::update_rich_text_ctrl ( wxWindow *  text_ctrl,
const wxString &  field,
Data_row_provider *  row 
)

Set value of wxRichTextCtrl to value of field.

Parameters:
text_ctrl - wxRichTextCtrl to update.
field - database field name.
row - source to obtain data.

wxPG_DECLSPEC void wxPg::update_spin_button ( wxWindow *  spin,
const wxString &  field,
Data_row_provider *  row 
)

Set value of wxSpinButton to value of field.

Parameters:
spin - wxSpinButton to update.
field - database field name.
row - source to obtain data.

wxPG_DECLSPEC void wxPg::update_spin_ctrl ( wxWindow *  spin,
const wxString &  field,
Data_row_provider *  row 
)

Set value of wxSpinCtrl to value of field.

Parameters:
spin - wxSpinCtrl to update.
field - database field name.
row - source to obtain data.

wxPG_DECLSPEC void wxPg::update_static_text ( wxWindow *  static_text,
const wxString &  field,
Data_row_provider *  row 
)

Set value of wxStaticText to value of field.

Parameters:
static_text - wxStaticText to update.
field - database field name.
row - source to obtain data.

wxPG_DECLSPEC void wxPg::update_text_ctrl ( wxWindow *  text_ctrl,
const wxString &  field,
Data_row_provider *  row 
)

Set value of wxTextCtrl to value of field.

Parameters:
text_ctrl - wxTextCtrl to update.
field - database field name.
row - source to obtain data.

wxPG_DECLSPEC void wxPg::update_vlist_box ( wxWindow *  list,
const wxString &  field,
Data_row_provider *  row 
)

Set value of wxVListBox to value of field.

Parameters:
list - wxVListBox to update.
field - database field name.
row - source to obtain data.


Variable Documentation

const int wxPg::TYPE_BOOL = 7

Represents boolean type.

const int wxPg::TYPE_DATE = 4

Represents date type.

const int wxPg::TYPE_FLOAT = 2

Represents float4 and float8 types.

const int wxPg::TYPE_INT = 1

Represents int2 and int4 types.

const int wxPg::TYPE_STRING = 3

Represents char, name and varchar types.

const int wxPg::TYPE_TIME = 5

Represents time type.

const int wxPg::TYPE_TIMESTAMP = 6

Represents timestamp type.

const int wxPg::TYPE_UNKNOWN = 0

Unknown data type.


Generated on Thu May 7 22:51:16 2009 for wxPostgres by  doxygen 1.5.6