class hk_class

Public Types

• enum enum_interaction {noninteractive,interactive}
• enum enum_measuresystem {cm,inch}
• enum enum_tagtype {normaltag,mastertag}

Public Methods

• 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)
• virtual void  savedata (ostream& s)
• virtual void  loaddata (const hk_string& definition)

Public Static Methods

• 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_showpedantic (bool s)
• static bool  showpedantic (void)
• static void  set_measuresystem (enum_measuresystem)
• static enum_measuresystem  measuresystem (void)
• static bool  get_tagvalue (const hk_string &where, const hk_string &tag, hk_string &value, int position=1,enum_tagtype tagtype=normaltag)
• static bool  get_tagvalue (const hk_string &where, const hk_string &tag, unsigned long &value, int position=1)
• static bool  get_tagvalue (const hk_string &where, const hk_string &tag, unsigned int &value, int position=1)
• static bool  get_tagvalue (const hk_string &where, const hk_string &tag, long &value, int position=1)
• static bool  get_tagvalue (const hk_string &where, const hk_string &tag, int &value, int position=1)
• static bool  get_tagvalue (const hk_string &where, const hk_string &tag, bool &value, int position=1)
• 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)

Protected Methods

•  hk_class (void)
• virtual  ~hk_class (void)
• hk_interpreter*  new_interpreter (const hk_string& interpreter,hk_presentation*)

Protected Members

• static hk_string p_defaulttimeformat
• static hk_string p_defaultdateformat
• static hk_string p_defaultdatetimeformat
• static bool p_runtime_only

Detailed Description

hk_class is the basic class for all other defined classes. It has some methods to support a simple debugging.

this enum will be used from other class members if their behaviour should be different e.g. if called from the command line in a script (then they should be noninteractive) or as a GUI application, where the user should interactively enter a password when the previous login failed.

The classname is for internal debugging use only It will be shown in front of all debugging messages.

[const]

[const]

if wanna_debug is true hkdebug prints on standard output the classname and the message d.

Parameters:

d	is the message that will be printed.

[const]

[const]

[const]

Parameters:

d	if true hk_debug will print messages of the class else there is no output.

[const]

[static]

Parameters:

d	if true hk_debug will print messages of ALL classes even if wanna_debug is false for a particular class.

[static]

tries to translate the message t by using the translatingfunction set with set_translatefunction.

Returns: the translated message. If translating was not possible it will return the parameter t unchanged.

[static]

prints a warning message by using a function set with set_warningmessage. If none is set the message will be print to standard error (cerr).

[static]

you can write your own GUI dependend function to print warning messages by defining a function of messagewindowtype

[static]

prints a question by using a function set with set_yesnomessage. If none is set the question will be print to standard error (cerr). The user has either to answer the question with yes or no.

Parameters:

m	the shown question
default_value	if set_show_pedantic == false the default_value will be returned without asking.

[static]

you can write your own GUI dependend function to print yes_no message by defining a function of dialogtype

[static]

prints a question by using a function set with set_stringvaluedialog. If none is set the question will be print to standard error (cerr). The user has to answer the question by entering a string (i.e. a filename).

Parameters:

t	the shown question

Returns: the string the user gave as an answer

[static]

you can write your own GUI dependend function to print a string value dialog by defining a function of stringvalue_dialogtype

[static]

[static]

if true all dialogs and messages will be shown. if false only important messages(errors and warnings) will be shown.

Parameters:

s	default = true

[static]

[static]

[static]

[virtual]

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

[virtual]

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

[static]

called from loaddata to load a variable value originally stored with set_tagvalue

Parameters:

where	a text where the wished value has to be filtered out
tag	the tag name. See set_tagvalue for details
value	the found value will be returned in this parameter
position	if there are more than one values for a variable (i.e. a list of columnnames),first position is 1 give the wished position of the value.

Returns: true if the tag was found and the value could be set else false

[static]

[static]

[static]

[static]

[static]

[static]

Each value will be stored between delimiting tags in the form value\n

Parameters:

stream	a stream to which the value will be written
tag	the tag name
value	the value to be stored

[static]

[static]

[static]

[static]

[static]

[static]

just writes to a stream. Use this function if you want to begin a section. Don't forget to call end_mastertag

[static]

just writes to a stream. Use this function if you want to end a section

[static]

[static]

[static]

[static]

[static]

This function stores all preferences of the hk_classes library in the file ~/.hk_classes/preferences like the defaultdateformat, and hk_report::printcommand

[static]

true if widgets can't get in design mode

[static]

sets the locale which is used for the regional formats (e.g. dataformat). Default is "" that means that the environment variable is queried and set

[static]

[static]

[static]

[protected]

[protected virtual]

[protected]

[protected]

[protected]

[protected]

[protected]

• Version: $Revision: 1.5 $
• Author: Horst Knorr (hk_classes@knoda.org)
• Generated: horst on horstnotebook on Mon Nov 22 10:41:06 2004, using kdoc 2.0a54.