Databaseconnectionclasses  0.5.3
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
hk_dsdatavisible Class Reference

base class for visible widgets with data connection More...

#include <hk_dsdatavisible.h>

Inheritance diagram for hk_dsdatavisible:
Inheritance graph
[legend]
Collaboration diagram for hk_dsdatavisible:
Collaboration graph
[legend]

Public Member Functions

 hk_dsdatavisible (hk_presentation *p=NULL)
 
void set_columnname (const hk_string &c, bool registerchange=true)
 
void set_columnname (const hk_string &c, bool registerchange, int coloccurance)
 
hk_columncolumn (void)
 
hk_string columnname (void) const
 
virtual void set_datasource (hk_datasource *d)
 
hk_datasourcedatasource (void)
 
virtual void savedata (ostream &s)
 
virtual void loaddata (xmlNodePtr definition)
 
bool use_defaultvalue (void)
 
void set_defaultvalue (const hk_string &def, bool registerchange=true)
 
hk_string raw_defaultvalue (void)
 
hk_string defaultvalue (void)
 
void reset_default (bool registerchange=true)
 
void set_numberformat (bool use_numberseparator=false, int commadigits=-1, bool registerchange=true)
 
void set_numberformat (bool use_numberseparator, int commadigits, bool registerchange, bool force_setting)
 
bool use_numberseparator (void)
 
int commadigits (void)
 
int precision (void)
 
virtual hk_string value_at (unsigned long row)
 
virtual hk_string value (void)
 
virtual void set_value (const hk_string &)
 
unsigned int find (unsigned int from, unsigned int to, const hk_string &searchtext, bool wholephrase=false, bool casesensitive=false, bool backwards=false)
 
unsigned int find (const hk_string &searchtext, bool wholephrase=false, bool casesensitive=false, bool backwards=false)
 
void set_on_valuechanged_action (const hk_string &, bool registerchange=true, bool force_setting=true)
 
hk_string on_valuechanged_action (void)
 
virtual bool action_on_valuechanged (void)
 
virtual hk_string tag_value (int tagnumber, bool &ok)
 
bool set_filtervalue (const hk_string &)
 
hk_string filtervalue (bool withcolumnnames=false) const
 
virtual void update_filter (void)
 
- Public Member Functions inherited from hk_dsvisible
 hk_dsvisible (hk_presentation *presentation=NULL)
 
virtual bool set_presentationdatasource (long n, bool registerchange=true)
 
long presentationdatasource (void)
 
hk_datasourcedatasource (void)
 
virtual void savedata (ostream &s, bool savedatasource, bool saveall)
 
void set_readonly (bool readonly)
 
bool is_readonly (void) const
 
void set_before_row_change_action (const hk_string &, bool registerchange=true, bool force_setting=true)
 
hk_string before_row_change_action (void)
 
void set_after_row_change_action (const hk_string &, bool registerchange=true, bool force_setting=true)
 
hk_string after_row_change_action (void)
 
void set_before_update_action (const hk_string &, bool registerchange=true, bool force_setting=true)
 
hk_string before_update_action (void)
 
void set_after_update_action (const hk_string &, bool registerchange=true, bool force_setting=true)
 
hk_string after_update_action (void)
 
void set_before_delete_action (const hk_string &, bool registerchange=true, bool force_setting=true)
 
hk_string before_delete_action (void)
 
void set_after_delete_action (const hk_string &, bool registerchange=true, bool force_setting=true)
 
hk_string after_delete_action (void)
 
void set_before_insert_action (const hk_string &, bool registerchange=true, bool force_setting=true)
 
hk_string before_insert_action (void)
 
void set_after_insert_action (const hk_string &, bool registerchange=true, bool force_setting=true)
 
hk_string after_insert_action (void)
 
virtual void action_before_store_changed_data (void)
 
virtual void action_after_store_changed_data (void)
 
virtual void action_before_row_change (void)
 
virtual void action_after_row_change (void)
 
virtual void action_before_delete (void)
 
virtual void action_after_delete (void)
 
virtual void action_before_insert (void)
 
virtual void action_after_insert (void)
 
- Public Member Functions inherited from hk_visible
 hk_visible (hk_presentation *p=NULL)
 
void set_x (unsigned int px, bool registerchange=true)
 
void set_y (unsigned int py, bool registerchange=true)
 
void set_width (unsigned int w, bool registerchange=true)
 
void set_height (unsigned int h, bool registerchange=true)
 
unsigned int x (void) const
 
unsigned int y (void) const
 
unsigned int width (void) const
 
unsigned int height (void)
 
void set_size (unsigned int x, unsigned int y, unsigned int w, unsigned int h, bool registerchange=true)
 
void set_size (unsigned int x, unsigned int y, unsigned int w, unsigned int h, bool registerchange, bool force_setting)
 
void set_size (unsigned int width, unsigned int height, bool registerchange=true)
 
void set_position (unsigned int x, unsigned int y, bool registerchange=true)
 
void set_label (const hk_string &l, bool registerchange=true)
 
void set_label (const hk_string &l, bool registerchange, bool force_setting)
 
hk_string label (void)
 
bool set_identifier (const hk_string &, bool registerchange=true, enum_interaction=interactive)
 
hk_string identifier (void) const
 
enum_visibletype type (void)
 
void set_font (const hk_string &font, int size, bool registerchange=true)
 
void set_font (const hk_string &font, int size, bool registerchange, bool force_setting)
 
void set_font (const hk_font &font, bool registerchange=true)
 
void set_font (const hk_font &font, bool registerchange, bool force_setting)
 
virtual hk_font font (void)
 
void set_foregroundcolour (const hk_colour &colour, bool registerchange=true)
 
void set_foregroundcolour (const hk_colour &colour, bool registerchange, bool force_setting)
 
hk_colour foregroundcolour (void)
 
void set_backgroundcolour (const hk_colour &colour, bool registerchange=true)
 
void set_backgroundcolour (const hk_colour &colour, bool registerchange, bool force_setting)
 
hk_colour backgroundcolour (void)
 
void set_neverregisterchange (bool n)
 
void set_neverregisterchange (bool n, bool force_setting)
 
bool neverregisterchange (void)
 
long presentationnumber (void) const
 
void set_datetimeformat (const hk_string &datetime, const hk_string &date, const hk_string &time)
 
void set_datetimeformat (const hk_string &datetime, const hk_string &date, const hk_string &time, bool force_setting)
 
hk_string datetimeformat (void)
 
hk_string dateformat (void)
 
hk_string timeformat (void)
 
void set_counts_as (unsigned long int c)
 
virtual void set_counts_as (unsigned long int c, bool force_setting)
 
virtual unsigned long int counts_as (void)
 
virtual hk_string replace (const hk_string &where)
 
hk_presentationpresentation (void)
 
void set_load_presentationnumber (bool l)
 
void set_load_presentationnumber (bool l, bool force_setting)
 
bool load_presentationnumber (void)
 
void set_alignment (alignmenttype a, bool registerchange=true)
 
void set_alignment (alignmenttype a, bool registerchange, bool force_setting)
 
alignmenttype alignment (void)
 
void set_tooltip (const hk_string &, bool registerchange=true, bool force_setting=false)
 
hk_string tooltip (void)
 
virtual void show_widget (void)
 
virtual void hide_widget (void)
 
virtual bool close_widget (void)
 
virtual void lower_widget (bool registerchange=true)
 
virtual void raise_widget (bool registerchange=true)
 
void set_on_click_action (const hk_string &, bool registerchange=true, bool force_setting=true)
 
hk_string on_click_action (void)
 
void set_on_doubleclick_action (const hk_string &, bool registerchange=true, bool force_setting=true)
 
hk_string on_doubleclick_action (void)
 
void set_on_open_action (const hk_string &, bool registerchange=true, bool force_setting=true)
 
hk_string on_open_action (void)
 
void set_on_close_action (const hk_string &, bool registerchange=true, bool force_setting=true)
 
hk_string on_close_action (void)
 
void set_on_getfocus_action (const hk_string &, bool registerchange=true, bool force_setting=true)
 
hk_string on_getfocus_action (void)
 
void set_on_loosefocus_action (const hk_string &, bool registerchange=true, bool force_setting=true)
 
hk_string on_loosefocus_action (void)
 
void set_on_key_action (const hk_string &, bool registerchange=true, bool force_setting=true)
 
hk_string on_key_action (void)
 
void set_key (const hk_key &)
 
hk_keykey () const
 
void set_enabled (bool enabled, bool registerchange=true, bool force_setting=false)
 
bool is_enabled ()
 
virtual bool action_on_click (void)
 
virtual bool action_on_doubleclick (void)
 
virtual bool action_on_close (void)
 
virtual bool action_on_open (void)
 
virtual bool action_on_getfocus (void)
 
virtual bool action_on_loosefocus (void)
 
virtual bool action_on_key (void)
 
bool in_tabvisible (void) const
 
void set_buddylabel (long int labelid, bool registerchange=true, bool force_setting=false)
 
long int buddylabel (void) const
 
void set_movebuddylabel (bool)
 
bool move_buddylabel (void) const
 
int tag_number (const hk_string &)
 
virtual hk_string column_value (const hk_string &colname, bool &ok)
 
hk_string tag_value (const hk_string &, bool &ok)
 
int register_tag (const hk_string &)
 
- Public Member Functions inherited from hk_class
void hkclassname (const hk_string &n)
 
hk_string hkclassname (void) const
 
void hkdebug (const hk_string &d) const
 
void hkdebug (const hk_string &d, const hk_string &e) const
 
void hkdebug (const hk_string &d, int i) const
 
void hkdebug (const hk_string &d, double i) const
 
void wanna_debug (bool d)
 
bool wanna_debug (void) const
 
bool generaldebug (void)
 

Static Public Member Functions

static void set_defaultnumberformat (bool use_thousandsseparator, int precision)
 
static bool defaultuse_numberseparator (void)
 
static int defaultprecision (void)
 
static bool parsed_value (hk_string &v, hk_connection *c)
 
- Static Public Member Functions inherited from hk_visible
static void set_defaulttextalignment (alignmenttype a)
 
static alignmenttype defaulttextalignment (void)
 
static void set_defaultnumberalignment (alignmenttype a)
 
static alignmenttype defaultnumberalignment (void)
 
static void set_open_maximized_windows (bool m)
 
static bool open_maximized_windows (void)
 
- Static Public Member Functions inherited from hk_class
static void set_generaldebug (bool d)
 
static hk_string hk_translate (const hk_string &t)
 
static void show_warningmessage (const hk_string &m)
 
static void set_warningmessage (messagewindowtype *m)
 
static bool show_yesnodialog (const hk_string &m, bool default_value)
 
static void set_yesnodialog (yesno_dialogtype *d)
 
static hk_string show_stringvaluedialog (const hk_string &t)
 
static void set_stringvaluedialog (stringvalue_dialogtype *t)
 
static void set_translatefunction (translatefunctiontype *t)
 
static void set_filedialog (file_dialogtype *f)
 
static hk_string show_filedialog (const hk_string &f="", enum_operationmode m=file_open)
 
static void set_directorydialog (stringvalue_dialogtype *f)
 
static hk_string show_directorydialog (const hk_string &f="")
 
static void set_showpedantic (bool s)
 
static bool showpedantic (void)
 
static void set_measuresystem (enum_measuresystem)
 
static enum_measuresystem measuresystem (void)
 
static xmlNodePtr get_tagvalue (xmlNodePtr where, const hk_string &tag, hk_string &value, int position=1, enum_tagtype tagtype=normaltag)
 
static xmlNodePtr get_tagvalue (xmlNodePtr where, const hk_string &tag, unsigned long &value, int position=1)
 
static xmlNodePtr get_tagvalue (xmlNodePtr where, const hk_string &tag, unsigned int &value, int position=1)
 
static xmlNodePtr get_tagvalue (xmlNodePtr where, const hk_string &tag, long &value, int position=1)
 
static xmlNodePtr get_tagvalue (xmlNodePtr where, const hk_string &tag, int &value, int position=1)
 
static xmlNodePtr get_tagvalue (xmlNodePtr where, const hk_string &tag, bool &value, int position=1)
 
static xmlNodePtr get_tagvalue (xmlNodePtr &where, const hk_string &tag)
 
static void set_tagvalue (ostream &stream, const hk_string &tag, const hk_string &value)
 
static void set_tagvalue (ostream &stream, const hk_string &tag, unsigned long value)
 
static void set_tagvalue (ostream &stream, const hk_string &tag, unsigned int value)
 
static void set_tagvalue (ostream &stream, const hk_string &tag, long value)
 
static void set_tagvalue (ostream &stream, const hk_string &tag, int value)
 
static void set_tagvalue (ostream &stream, const hk_string &tag, bool value)
 
static void start_mastertag (ostream &stream, const hk_string &tag)
 
static void end_mastertag (ostream &stream, const hk_string &tag)
 
static void set_defaultdatetimeformat (const hk_string &timeformat, const hk_string &dateformat, const hk_string &datetimeformat)
 
static hk_string defaultdateformat (void)
 
static hk_string defaulttimeformat (void)
 
static hk_string defaultdatetimeformat (void)
 
static void save_preferences (void)
 
static bool runtime_only (void)
 
static void set_locale (const hk_string &locale)
 
static hk_string locale (void)
 
static void set_defaultdriver (const hk_string &d)
 
static hk_string defaultdriver (void)
 
static void set_default_automatic_data_update (bool)
 
static bool default_automatic_data_update (void)
 

Protected Member Functions

void set_data_has_changed (void)
 
virtual bool datasource_disable (void)
 
virtual bool datasource_enable (void)
 
virtual void datasource_delete (void)
 
virtual bool before_columns_deleted (void)
 
virtual void widget_specific_set_column (void)
 
virtual void widget_specific_numberformat (void)
 
virtual void widget_specific_set_defaultvalue (void)
 
virtual void columndata_has_changed (void)
 
virtual void before_insert_row (void)
 
virtual void new_column_pointer_created (void)
 
virtual bool presentationmode_changed (void)
 
- Protected Member Functions inherited from hk_dsvisible
void row_change (void)
 
void batch_next (void)
 
void batch_previous (void)
 
void insert_mode (void)
 
virtual void widget_specific_insert_mode (void)
 
virtual bool widget_specific_row_change (void)
 
virtual void widget_specific_batch_next (void)
 
virtual void widget_specific_batch_previous (void)
 
virtual void widget_specific_enable_disable (void)
 
virtual void widget_specific_enable (void)
 
virtual void widget_specific_disable (void)
 
virtual void widget_specific_row_added (void)
 
virtual void widget_specific_row_deleted (void)
 
virtual void before_row_change (void)
 
virtual void before_store_changed_data (void)
 
virtual void after_store_changed_data (void)
 
virtual void before_datasource_enables (void)
 
virtual void row_added (void)
 
virtual void row_deleted (void)
 
virtual bool columns_new_created (void)
 
virtual void list_changes (listtype type)
 
virtual bool table_structure_changes (void)
 
virtual void before_source_vanishes (void)
 
virtual void widget_specific_presentationdatasource (long)
 
- Protected Member Functions inherited from hk_visible
virtual void widget_specific_form_resizes (void)
 
virtual void widget_specific_font_changed (void)
 
virtual void widget_specific_label_changed (void)
 
virtual void widget_specific_foregroundcolour_changed (const hk_colour &oldcolour)
 
virtual void widget_specific_backgroundcolour_changed (const hk_colour &oldcolour)
 
virtual bool widget_specific_coordinates (unsigned int px, unsigned int py, unsigned int pwidth, unsigned int pheight)
 
virtual void widget_specific_raise_widget (void)
 
virtual void widget_specific_lower_widget (void)
 
virtual void widget_specific_tooltip_changed (void)
 
virtual void widget_specific_enabled_changed (void)
 
virtual void before_presentationmode_changed (void)
 
virtual void widget_specific_alignment (void)
 
virtual void sizetype_changed (void)
 
virtual void widget_specific_sizetype_changed (void)
 
bool allow_datachanging (bool force_setting)
 
void has_changed (bool registerchange, enum_has_changed force_setting=standard)
 
void set_tabvisible (hk_tabvisible *)
 
- Protected Member Functions inherited from hk_class
hk_interpreternew_interpreter (const hk_string &interpreter, hk_presentation *)
 

Protected Attributes

hk_columnp_column
 
hk_string p_filterreplacevalue
 
hk_string p_filtervalueend
 
- Protected Attributes inherited from hk_dsvisible
hk_datasourcep_datasource
 
hk_datetime p_date
 
hk_string debug_p_columnname
 
- Protected Attributes inherited from hk_visible
hk_presentationp_presentation
 
enum_visibletype p_visibletype
 
bool p_setcoordinates
 
bool p_setwidgetcoordinates
 
bool while_init
 

Friends

class hk_column
 

Additional Inherited Members

- Public Types inherited from hk_visible
enum  enum_visibletype {
  textlabel, button, rowselector, boolean,
  lineedit, memo, combobox, grid,
  form, report, reportsection, reportdata,
  query, subform, image, date,
  tabvisible, other
}
 
enum  alignmenttype { alignleft, alignright, aligncenter, aligndefault }
 
- Public Types inherited from hk_class
enum  enum_interaction { noninteractive, interactive }
 
enum  enum_measuresystem { cm, inch }
 
enum  enum_tagtype { normaltag, mastertag }
 
- Protected Types inherited from hk_visible
enum  enum_has_changed { standard, forcesetting }
 
- Static Protected Attributes inherited from hk_class
static hk_string p_defaulttimeformat ="h:m:s"
 
static hk_string p_defaultdateformat ="D.M.Y"
 
static hk_string p_defaultdatetimeformat ="D.M.Y h:m:s"
 
static bool p_runtime_only =false
 

Detailed Description

base class for visible widgets with data connection

Version
Revision:
1.50
Author
Horst Knorr (hk_cl.nosp@m.asse.nosp@m.s@kno.nosp@m.da.o.nosp@m.rg) This is the base class for visible widgets that provides access to a specific column and its data. To use visible objects you have to define the datasource and the column.

Member Function Documentation

bool hk_dsdatavisible::before_columns_deleted ( void  )
protectedvirtual

FOR WIDGET DEVELOPERS ONLY: will be automatically called before the columns will be deleted. usually column pointers will be set to NULL in this function. i.e.when enabling,disabling or when a depending datasource has to requery its rows.

Reimplemented from hk_dsvisible.

Reimplemented in hk_listvisible.

Referenced by hk_listvisible::before_columns_deleted().

hk_column * hk_dsdatavisible::column ( void  )
int hk_dsdatavisible::commadigits ( void  )
Deprecated:
use precision() instead

Referenced by hk_dscombobox::value_at(), and value_at().

void hk_dsdatavisible::datasource_delete ( void  )
protectedvirtual

FOR WIDGET DEVELOPERS ONLY: will be automatically called when the datasources is destroyed

Reimplemented from hk_dsvisible.

References hk_class::hkdebug(), and hk_dsvisible::widget_specific_enable_disable().

bool hk_dsdatavisible::datasource_disable ( void  )
protectedvirtual

FOR WIDGET DEVELOPERS ONLY: will be automatically called when the datasources is disabling

Reimplemented from hk_dsvisible.

Reimplemented in hk_listvisible, and hk_dscombobox.

References hk_dsvisible::datasource_disable(), and hk_class::hkdebug().

Referenced by hk_dscombobox::datasource_disable().

bool hk_dsdatavisible::datasource_enable ( void  )
protectedvirtual

FOR WIDGET DEVELOPERS ONLY: will be automatically called when the datasources is enabling

Reimplemented from hk_dsvisible.

Reimplemented in hk_listvisible, hk_dscombobox, and hk_dsimage.

References column(), hk_dsvisible::datasource_enable(), and hk_class::hkdebug().

Referenced by hk_dsimage::datasource_enable(), hk_dscombobox::datasource_enable(), and hk_listvisible::datasource_enable().

hk_string hk_dsdatavisible::defaultvalue ( void  )
Returns
the default value, but variables are replaced by its values

References hk_column::columntype(), hk_datetime::date_asstring(), hk_datetime::datetime_asstring(), hk_class::hk_translate(), and hk_datetime::time_asstring().

Referenced by value_at().

void hk_dsdatavisible::loaddata ( xmlNodePtr  definition)
virtual

loads the object's values out of the definition string. Especially used to load queries, forms and reports

Reimplemented from hk_dsvisible.

Reimplemented in hk_dscombobox, hk_dsgridcolumn, and hk_dsimage.

References hk_class::get_tagvalue(), hk_class::hkclassname(), hk_class::hkdebug(), and hk_dsvisible::loaddata().

Referenced by hk_dsimage::loaddata(), hk_dsgridcolumn::loaddata(), and hk_dscombobox::loaddata().

hk_string hk_dsdatavisible::raw_defaultvalue ( void  )
Returns
the default value as set with set_defaultvalue
void hk_dsdatavisible::reset_default ( bool  registerchange = true)

resets the default value. After that no default value will be used

References hk_class::hkdebug().

void hk_dsdatavisible::savedata ( ostream &  s)
virtual

stores the object's values to stream s. Especially used to store queries, forms and reports

Reimplemented from hk_dsvisible.

Reimplemented in hk_dscombobox, hk_dsgridcolumn, and hk_dsimage.

References hk_class::end_mastertag(), hk_class::set_tagvalue(), and hk_class::start_mastertag().

Referenced by hk_dsimage::savedata(), hk_dsgridcolumn::savedata(), and hk_dscombobox::savedata().

void hk_dsdatavisible::set_columnname ( const hk_string &  c,
bool  registerchange = true 
)

column name in the datasource. If there is no column with this name the widget will not be enabled

Parameters
columnthe wished column
registerchange,:If this object will be displayed on a form you can decide whether changing the column name should mark the form as changed (then it will be saved when closed). Default is "true".

Referenced by hk_reportsectionpair::init_sections(), hk_reporthtml::set_betweenheadtags(), hk_reportsectionpair::set_columnname(), and hk_dscombobox::set_listcolumnname().

void hk_dsdatavisible::set_data_has_changed ( void  )
protected

used from eg. hk_kdememo to allow to signal the datasource that the data has changed without writing it with hk_column::set_asstring

void hk_dsdatavisible::set_datasource ( hk_datasource d)
virtual
void hk_dsdatavisible::set_defaultvalue ( const hk_string &  def,
bool  registerchange = true 
)

sets the default value

Parameters
defthe new default value
registerchangeif true and this widget is part of a form the new default value will be stored when closing the form.
The following variables are available:
 NOW% the actual date, time or datetime, depending on the fieldtype. Default ist datetime
 NOWDATE% the actual date
 NOWTIME% the actual time
 TRUE% the driver specific true value.
 FALSE% the driver specific false value.

References hk_class::hkdebug().

void hk_dsdatavisible::set_value ( const hk_string &  v)
virtual

sets the display value. If this object has an existing column() the data will be changed

Reimplemented in hk_dsimage.

References column(), hk_class::hkdebug(), and hk_column::set_asstring().

Referenced by hk_dsimage::set_value().

bool hk_dsdatavisible::use_defaultvalue ( void  )

true if the default value will be used while inserting a new row

References hk_column::columntype().

Referenced by value_at().

hk_string hk_dsdatavisible::value_at ( unsigned long  row)
virtual

The documentation for this class was generated from the following files: