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

base class for multidatasource based classes like forms and reports More...

#include <hk_presentation.h>

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

Public Types

enum  enum_presentationtype {
  general, form, report, qbe,
  referentialintegrity
}
 
enum  enum_bulkoperation { bulkfont, bulkforeground, bulkbackground }
 
enum  enum_sizetype { relative, absolute }
 
- Public Types inherited from hk_dsmodevisible
enum  enum_mode { designmode, viewmode, filtermode }
 
- 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 }
 

Public Member Functions

void set_database (hk_database *db)
 
hk_databasedatabase (void) const
 
enum_presentationtype presentationtype (void) const
 
void set_name (const hk_string &n)
 
hk_string name (void) const
 
virtual bool set_mode (enum_mode s)
 
list< hk_datasource * > * datasources (void) const
 
long new_datasource (const hk_string &name, datasourcetype dt=dt_table)
 
hk_datasourceget_datasource (long nr)
 
hk_datasourceget_datasource (const hk_string &description)
 
hk_datasourceget_datasource_by_shortname (const hk_string &description)
 
hk_string unique_datasourcename (long nr)
 
hk_string unique_shortdatasourcename (long nr)
 
virtual void savedata (ostream &s)
 
virtual void loaddata (xmlNodePtr definition)
 
void clear_datasourcelist (void)
 
void set_designsize (unsigned int width, unsigned int height, bool registerchange=true)
 
virtual void set_presentationsize (unsigned int, unsigned int)
 
unsigned int designwidth (void)
 
unsigned int designheight (void)
 
unsigned int horizontal2relativ (unsigned int h)
 
unsigned int vertical2relativ (unsigned int v)
 
unsigned int relativ2horizontal (unsigned int r)
 
unsigned int relativ2vertical (unsigned int r)
 
virtual void register_object (hk_visible *)
 
void set_automatic_enable_datasources (bool)
 
bool automatic_enable_datasources (void)
 
virtual void bulk_operation (enum_bulkoperation bulkoperation)
 
void set_sizetype (enum_sizetype type, bool registerchange=true)
 
enum_sizetype sizetype (void)
 
hk_interpreterinterpreter (void)
 
virtual void script_error (hk_visible *, hk_interpreter::enum_action)
 
void set_interpretername (const hk_string &, bool registerchange=true)
 
hk_string interpretername (void) const
 
void enable_datasources (bool enable, hk_datasource::enum_accessmode mode=hk_datasource::standard)
 
virtual bool is_subpresentation (void)
 
virtual bool while_loading (void)
 
virtual bool intervaltasks (void)
 
bool load_module (const hk_string &modulename)
 
- Public Member Functions inherited from hk_dsmodevisible
 hk_dsmodevisible (hk_presentation *presentation=NULL)
 
virtual void set_designmode (void)
 
virtual void set_viewmode (void)
 
enum_mode mode (void) const
 
bool has_changed (void) const
 
void has_changed (bool)
 
void set_block_has_changed (bool)
 
bool block_has_changed (void) const
 
virtual void reset_has_changed (void)
 
bool is_new () const
 
- Public Member Functions inherited from hk_dsvisible
 hk_dsvisible (hk_presentation *presentation=NULL)
 
virtual void set_datasource (hk_datasource *d)
 
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 hk_string tag_value (int tagnumber, bool &ok)
 
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_defaultsizetype (enum_sizetype type)
 
static enum_sizetype defaultsizetype (void)
 
static void set_snap2gridx (int)
 
static int snap2gridx (void)
 
static void set_snap2gridy (int)
 
static int snap2gridy (void)
 
- 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 remove_datasource (long nr, bool registerchange=true)
 
virtual void widget_specific_presentationresize (void)
 
virtual void widget_specific_fieldresize (hk_visible *)
 
virtual void widget_specific_set_name (void)
 
void database_delete (void)
 
virtual void database_has_vanished (void)
 
void before_source_vanishes (void)
 
bool ask_name (void)
 
virtual void raise_widget (hk_visible *)
 
virtual void lower_widget (hk_visible *)
 
virtual void sizetype_changed (void)
 
- Protected Member Functions inherited from hk_dsmodevisible
virtual void set_has_changed (enum_has_changed forcesetting=standard)
 
virtual void widget_specific_modechanges (enum_mode)
 
virtual bool widget_specific_before_modechanges (enum_mode)
 
- 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_insert_row (void)
 
virtual void before_datasource_enables (void)
 
virtual bool datasource_disable (void)
 
virtual bool datasource_enable (void)
 
virtual void datasource_delete (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 before_columns_deleted (void)
 
virtual bool table_structure_changes (void)
 
virtual void widget_specific_presentationdatasource (long)
 
virtual bool presentationmode_changed (void)
 
- 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 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

enum_presentationtype p_presentationtype
 
unsigned int p_actualwidth
 
unsigned int p_actualheight
 
bool p_while_errorhandling
 
- Protected Attributes inherited from hk_dsmodevisible
bool p_is_new
 
- 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_datasource
 
class hk_database
 
class hk_dsvisible
 
class hk_visible
 

Additional Inherited Members

- 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 multidatasource based classes like forms and reports

Version
Revision:
1.56
Author
Horst Knorr (hk_cl.nosp@m.asse.nosp@m.s@kno.nosp@m.da.o.nosp@m.rg)

Member Function Documentation

void hk_presentation::before_source_vanishes ( void  )
protectedvirtual

FOR WIDGET DEVELOPERS ONLY: will be automatically called before the database will be closed.(i.e when a new database will be created and the old one will be destroyed by hk_connection

Reimplemented from hk_dsvisible.

void hk_presentation::clear_datasourcelist ( void  )

resets the internal datasourcelist and deletes all datasourceobjects except of "nodelete"

References hk_datasource::disable(), hk_class::hkdebug(), and hk_datasource::store_changed_data().

Referenced by loaddata().

list< hk_datasource * > * hk_presentation::datasources ( void  ) const

a list of all existing datasources in this presentation

hk_datasource * hk_presentation::get_datasource ( long  nr)

returns the datasource with the unique identification number nr

References hk_class::hkdebug().

Referenced by loaddata(), hk_datasource::set_depending_on_presentationdatasource(), hk_dscombobox::set_listpresentationdatasource(), and unique_datasourcename().

void hk_presentation::loaddata ( xmlNodePtr  definition)
virtual
long hk_presentation::new_datasource ( const hk_string &  name,
datasourcetype  dt = dt_table 
)

loads an existing datasource "name". if query=false this datasource is a table else a query.

Returns
each presentationdatasource gets a unique number as an identifier.

References hk_class::hkclassname(), hk_class::hkdebug(), hk_database::load_datasource(), and hk_datasource::set_name().

Referenced by loaddata().

void hk_presentation::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_report, hk_form, and hk_qbe.

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

Referenced by hk_qbe::savedata(), hk_form::savedata(), and hk_report::savedata().

void hk_presentation::set_automatic_enable_datasources ( bool  b)

if true (default) all datasources will be automatically enabled when mode changes to viewmode else you have to enable the datasources manually

void hk_presentation::set_database ( hk_database db)

set the database which is base of this presentation

References hk_class::hkdebug().

Referenced by hk_datasource::loaddata(), and hk_reportsection::set_subreport().

void hk_presentation::set_designsize ( unsigned int  width,
unsigned int  height,
bool  registerchange = true 
)

sets the logic size of the form.

References hk_class::hkdebug().

Referenced by loaddata(), hk_form::set_designsize(), and hk_report::set_pageformat().

bool hk_presentation::set_mode ( enum_mode  s)
virtual

if mode is design then you can define or alter a presentation else the data will be shown

Reimplemented from hk_dsmodevisible.

Reimplemented in hk_report, and hk_form.

References hk_class::runtime_only(), and hk_dsmodevisible::set_mode().

Referenced by hk_form::set_mode(), and hk_report::set_mode().

void hk_presentation::set_name ( const hk_string &  n)

name of the presentation under which it will be stored

Referenced by hk_form::load_form(), and hk_form::save_form().

hk_string hk_presentation::unique_datasourcename ( long  nr)

returns a unique name for a datasource looks like : nameofdatasource (uniquenumber) [dependingondatasource] | filter

References get_datasource().


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