3
edits
Changes
corrected spam and special character replacement
* Tag it in Release 0.3
===Tue March 22 R3.5===
* merge the code for CFrame and CField from tags/branches\fardad/coreclasses \FrameFieldStrarr into your project and compile, run and test it with Test1Frame.cpp
* Tag it in Release 0.35
===Tue march 29 R4.0===
* Code the following
*# '''CLineEdit''' Tester: Test3DialogAndLineEdit.cpp
* After successful testing, tag them in R4.0
===Fri Apr 8 R5.0===
* Code the following
*# '''CCheck'''
*# '''CButton'''
*# '''CMenuItem'''
*# '''CValEdit'''
* After successful testing, tag them in R5.0
= General Internal Header file (cgh.h R0.1)=
The general header file holds the common setting and definition between all the Core Classes.
#ifndef ___CGH_H__
#endif
</syntaxhighlight></big>
=File Names=
*:For example '''CFrame''' class should have '''cframe.h''' and '''cframe.cpp''' files for its implementation.
=Hierarchy=
CFrame
|
|
|-------- CMenu
</pre></big>
=Basic (BIO) Encapsulating Classes=
CFrame is base of all objects in our user interface system.
#pragma once
#include "cgh.h"
void refresh();
};
</syntaxhighlight></big>
===Properties===
int _row, holds the relative coordinate of top row of this border with respect to its container.<br />
===Methods and Constructors===
====Private Methods====
void capture();
</syntaxhighlight></big>
:if _covered pointer is not pointing to any allocated memory, it will call the bio_capture function to capture the area that is going to be covered by this frame and keeps its address in _covered.
====Public Methods====
CFrame(int Row=-1, int Col=-1, int Width=-1,int Height=-1,
bool Visible = false,
const char* Border=C_BORDER_CHARS,
CFrame* Frame = (CFrame*)0);
</syntaxhighlight></big>
:Sets the corresponding attributes to the incoming values in the argument list and set _covered to null
virtual void draw(int fn=C_FULL_FRAME);
</syntaxhighlight></big>
* First it will '''capture()''' the coordinates it is supposed to cover
* If frame is '''fullscreen()''' then it just clears the screen and exits. <br />
virtual void move(CDirection dir);
</syntaxhighlight></big>
First it will hide the Frame, then adjust the row and col to more to the "dir" direction and then draws the Frame back on screen.
virtual void hide();
</syntaxhighlight></big>
using bio_restore()it restores the characters behind the Frame back on screen. It will also free the memory pointed by _covered;
virtual ~CFrame();
</syntaxhighlight></big>
It will make sure allocated memories are freed.
bool fullscreen()const;
void visible(bool val);
void width(int val);
int width()const;
</syntaxhighlight></big>
These functions set and get the attributes of the CFrame.
CField is an abstract base class that encapsulates the commonalities of all Input Outputs Console Fields which are placeable on a CDialog. All Fields could be Framed, therefore a CField is int
#include "cframe.h"
class CDialog;
CDialog* container();
};
</syntaxhighlight></big>
===Attributes===
void* _data;
</syntaxhighlight></big>
Will hold the address of any type of data a CField can hold.
===Constructors and Methods===
CField(int Row = 0, int Col = 0,
int Width = 0, int Height =0,
bool Bordered = false,
const char* Border=C_BORDER_CHARS);
</syntaxhighlight></big>
Passes the corresponding attributes to it's parents constructor and then sets the _data attribute to the incoming Data argument.
~CField();
</syntaxhighlight></big>
Empty Destructor
virtual int edit() = 0;
virtual bool editable() const = 0;
virtual void set(const void* data) = 0;
</syntaxhighlight></big>
Enforce the children to implement;
* an edit() method
* an editable() method that returns true if the class is to edit data and false if the class is to only display data.
* a set() method to set the _data attribute to the data the class is to work with.
virtual void* data();
</syntaxhighlight></big>
Returns _data.
void container(CDialog* theContainer);
CDialog* container();
</syntaxhighlight></big>
Sets and Gets the _frame attribute of CFrame by calling CFrame::frame() method. Make sure to cast The CDialog to CFrame when setting and cast CFrame to CDialog when getting
==CLabel==
A readonly Field that encapsulates bio_display() function. (i.e it is responsible to display a short character string on the display) CLable although, by inheritance is Frame, but it is never '''bordered'''.
#include "cfield.h"
class CLabel : public CField{
void set(const void* str);
};
</syntaxhighlight></big>
===Attributes===
int _length;
</syntaxhighlight></big>
Holds the Length of the label, this will be stored to be passed to bio_display function.
===Constructors / Destructor ===
CLabel(const char *Str, int Row, int Col,
int Len = 0);
</syntaxhighlight></big>
passes the Row and Col to the CField constructor and then;
if len is zero, it will allocate enough memory to store the string pointed by Str and then copies the Str into it.
if len > 0, then it will allocate enough memory to store '''len''' chars in a string.
In any way, the allocated memory is pointed by '''_data'''
CLabel(int Row, int Col, int Len);
</syntaxhighlight></big>
Works exactly like the previous constructor, but len in this case can not be zero. (no validation required) and the string pointed by _data will be set to an empty string.
CLabel(const CLabel& L);
</syntaxhighlight></big>
Copy Constructor
~CLabel();
</syntaxhighlight></big>
makes sure that memory pointed by _data is deallocated before the object is destroyed.
===Methods===
void draw(int fn=C_NO_FRAME) ;
</syntaxhighlight></big>
makes a direct call to bio_display, passing '''_data''' for the string to be printed and absRow() and absCol() for row and col and _length for len.
this function ignores the argument fn.
int edit();
</syntaxhighlight></big>
calls draw, returning 0.
bool editable()const;
</syntaxhighlight></big>
always return false.
void set(const void* str);
</syntaxhighlight></big>
if _length is greater than zero, it will copy the string pointed by str into the string pointed by _data upto _length characters.
if _length is zero, it will delete the memory pointed by _data and reallocates enough memory for str and copies the string pointed by str into the newly allocated memory pointed by _data.
Organizes CField objects on the screen, displays them and then lets the user edit them one by one.
#include "cgh.h"
#include "cframe.h"
CField& curField();
};
</syntaxhighlight></big>
===Attributes===
====Mandatory====
int _fnum;
</syntaxhighlight></big>
Holds the number of Fields added to the Dialog
bool _editable;
</syntaxhighlight></big>
will be set to true if any of the Fields added are editable.
====Optional====
This is optional because it depends on how you are going to implement the collection of CFields:
int _curidx;
</syntaxhighlight></big>
Holds the index of the Field that is currently being edited.
CField* _fld[C_MAX_NO_FIELDS];
</syntaxhighlight></big>
Array of CField pointers to hold the address of the CField objects added to the screen.
bool _dyn[C_MAX_NO_FIELDS];
</syntaxhighlight></big>
Holds series of boolean to the exact number of fields, and each boolean here will hold false if the corresponding field pointed by _fld is allocated dynamically or not.
This array will later on be used by destructor to decide which object is dynamic and to be deleted.
===Constructors/Destructors===
CDialog(CFrame *Container = (CFrame*)0,
int Row = -1, int Col = -1,
bool Borderd = false,
const char* Border=C_BORDER_CHARS);
</syntaxhighlight></big>
The constructor, passes all the incoming arguments to the corresponding arguments of the apparent constructor '''CFrame'''.<br />
Then it will set called a attributes to their default values and then sets all the field pointers (_fld) to NULL.
It also sets all the dynamic (_dyn) flags to false.
virtual ~CDialog();
</syntaxhighlight></big>
The destructor, will loop through all the field pointers and if the corresponding dynamic flag is true then it will delete the field pointed to by the field pointer.
===Methods===
void draw(int fn = C_FULL_FRAME);
</syntaxhighlight></big>
If '''fn''' is '''C_FULL_FRAME''', it will call its parent draw. Then It will draw all the '''Fields''' in the '''Dialog'''. <br />
If '''fn''' is not '''C_FULL_FRAME''', then it will just draw all the '''Fields''' in the '''Dialog'''.<br />
If '''fn''' is a non-zero positive value, then it will only draw '''Field''' number '''fn''' in the dialog. (First added '''Field''' is field number one.)
int edit(int fn = C_FULL_FRAME);
</syntaxhighlight></big>
If '''CDialog''' is not editable (all fields are non-editable), it will just display the Dialog and then waits for the user to enter a key and then terminates the function returning the key.<br />
If fn is '''0''' or less, then before editing, the draw method is called with '''fn''' as its argument and then editing begins from the first editable Field.
# For any other key, terminate the edit function returning the character which caused the termination.
int add(CField* field, bool dynamic = true);
</syntaxhighlight></big>
Adds the '''CField''' pointed by '''field''' to the Fields of the Dialog; by appending the value of the field pointer after the last added '''field'' in the _fld array , setting the corresponding _dyn element to the value of dynamic argument and then increasing _fnum by one and returning it.<br />
'''important note:<br />
Make sure that add() sets the container of the added CField to this CDialog object, using the container() method of CField'''
int add(CField& field, bool dynamic = false);
</syntaxhighlight></big>
Makes a direct call to the first add method.
CDialog& operator<<(CField* field);
</syntaxhighlight></big>
Makes a direct call to the first add method, ignoring the second argument and then returns the owner (current CDialog).
CDialog& operator<<(CField& field);
</syntaxhighlight></big>
Makes a direct call to the second add method, ignoring the second argument and then returns the owner (current CDialog).
bool editable();
</syntaxhighlight></big>
Returns '''_editable''';
int fieldNum()const;
</syntaxhighlight></big>
returns '''_fnum'''.
int curIndex()const;
</syntaxhighlight></big>
returns '''_curidx''';
CField& operator[](unsigned int index);
</syntaxhighlight></big>
Returns the reference of the Field with incoming index. (Note that here, the first field index is '''0''')
CField& curField();
</syntaxhighlight></big>
Returns the reference of the Field that was just being edited.
==CLineEdit==
'''ClineEdit''' encapsulates the bio_edit function of bio library.
#pragma once
#include "cfield.h"
void set(const void* Str);
};
</syntaxhighlight></big>
CLineEdit(char* Str, int Row, int Col, int Width,
int Maxdatalen, int* Insertmode,
bool Bordered = false,
const char* Border=C_BORDER_CHARS);
</syntaxhighlight></big>
LineEdit, sets the Field's _data to the value of str. If LineEdit is instantiated with this constructor then it will edit an external string provided by the caller function of LineEdit. LineEdit in this case is not creating any dynamic memory, therefore _dyn is set to false (therefore the destructor will not attempt to deallocate the memory pointed by _data).<br />
(hint: use '''? :''' operator to pass the proper Height value to FWField's constructor)
CLineEdit(int Row, int Col, int Width,
int Maxdatalen, int* Insertmode,
bool Bordered = false,
const char* Border=C_BORDER_CHARS);
</syntaxhighlight></big>
Works exactly like the previous constructor with one difference; since no external data is passed to be edited here, this constructor must allocate enough dynamic memory to accommodate editing of '''Maxdatalen''' characters. Then make it an empty string and set Fields's _data to point to it. Make sure _dyn is set to true in this case, so the destructor knows that it has to deallocate the memory at the end.
~CLineEdit();
</syntaxhighlight></big>
If '''_dyn''' is true, it will deallocate the character array pointed by Fields's '''_data'''
void draw(int Refresh = C_FULL_FRAME);
</syntaxhighlight></big>
It will first call Frame's draw passing '''Refresh'''as an argument to it.<br />
Then it will make a direct call to bio_display to show the data kept in Field's '''_data'''.<br />
*col: absCol() (''add one if border is visible'')
*len: width() (''reduce by two is border is visible''')
int edit();
</syntaxhighlight></big>
Makes a direct call to, and returns '''bio_edit()'''.
For the coordinates and width arguments follow the same rules as the draw function.
For the rest of the arguments of bio_edit, use the attributes of '''CLineEdit'''.
bool editable()const;
</syntaxhighlight></big>
Always return true;
void set(const void* Str);
</syntaxhighlight></big>
Copies the characters pointed by '''Str''' into the memory pointed by Field's '''_data''' up to '''_maxdatalen''' characters.
It displays a small piece of text (usually one word or two) and accepts one key hit entry.
When in edit mode, to indicate the editing mode, it will surround the text with squared brackets.
#pragma once
#include "cfield.h"
};
</syntaxhighlight></big>
===Attributes===
This class does not have any attributes of its own!
===Constructor / Destructor===
CButton(const char *Str, int Row, int Col,
bool Bordered = true,
const char* Border=C_BORDER_CHARS);
</syntaxhighlight></big>
When creating a Button, allocate enough memory to hold the contents of the '''Str''' and set Field's _data to point to it. Then copy the content of '''Str''' into the newly allocated memory.<br />
Pass all the arguments directly to Field's constructor.<br />
For width: Set width to the length of '''Str''' + 2 (adding 2 for surrounding brackets) or if the Button is bordered set width to the length of '''Str''' + 4 (adding 2 for surrounding brackets and 2 for the borders).
For height: Set the height to 1 or if the Button is bordered, set the height to 3.
virtual ~CButton();
</syntaxhighlight></big>
Deallocates the allocated memory pointed by Field's '''_data'''.
===Methods===
void draw(int fn=C_FULL_FRAME);
</syntaxhighlight></big>
Draws the Button with border around it if it is Bordered. Note that there should be a space before and after of the text that will be used to surround the text with "[" and "]"<br />
hint:<br />
:*:display the text at absRow()+1 and absCol()+2
int edit();
</syntaxhighlight></big>
First draw() the Button, then surround it by squared brackets, place the cursor under the first character of Button's text and wait for user entry.<br />
When user hits a key, if the key is ENTER_KEY or SPACE, return FW_BUTTON_HIT C_BUTTON_HIT (defined in confwcgh.h) otherwise return the entered key.<br /><big><syntaxhighlight lang="cpp">
bool editable()const;
</syntaxhighlight></big>
Always returns true;
void set(const void* str);
</syntaxhighlight></big>
Reallocate memory for new text and then set it to content of '''str'''<br />
hint:<br />
==CCheck==
#include "cfield.h"
#include "clabel.h"
int _radio;
char _format[4];
CLabel Label_Label;
public:
CCheck(bool Checked,const char* Format, const char* Text, int Row, int Col, int Width, bool IsRadio = false);
bool editable()const;
void set(const void* flag);
bool checked()const;
void checked(bool val);
};
</syntaxhighlight>===Attributes===<syntaxhighlight lang="cpp"> int _flag; int _radio; char _format[4]; CLabel _Label;</syntaxhighlight>*'''_flag''' holds the status of the Checkbox (0: unchecked or 1: checked ) and is pointed by _data pointer .*'''_radio''' dictates the behavior of the Checkbox as a radio-button, or a check-mark.*'''_format''' holds the characters, the Checkbox is drawn with (i.e. "[X]", "(O)", "<*>", etc...).*'''_Label''' holds the Label attached to the this Checkbox===Constructor / Destructor===<syntaxhighlight lang="cpp"> CCheck(bool Checked,const char* Format, const char* Text, int Row, int Col, int Width, bool IsRadio = false);</syntaxhighlight>*Passes the Row, Col, Width and "1" to row, col, width and height arguments of CField and directly initializes* _Label with Text, 0, 4, and (Width-4) for Str, Row, Col and Len, arguments of CLabel's Constructor.<br />*: *see page 64 of Practical Programming Techniques Using C++*Sets the frame of _Label to itself*Sets _flag to Checked*Sets _radio to IsRadio*Copies Format to _format*Sets _data to the address of _flag <syntaxhighlight lang="cpp"> CCheck(const CCheck& C);</syntaxhighlight>*Passes incoming CCheck reference ("C") to CField's copy constructor, and directly initializes the _Label with the _Label of C*Sets all the attributes of this object to the attributes of incoming CCheck reference ("C")*Sets _data to the address of _flag ===Methods===<syntaxhighlight lang="cpp"> void draw(int fn = C_NO_FRAME) ;</syntaxhighlight>*Uses bio_displayflag() to display _flag using _format at absRow() and absCol()*Then draw()s the _Label<syntaxhighlight lang="cpp"> int edit();</syntaxhighlight>*returns bio_flag()'s returned value.*:bio_flag is to edit the value of _flag using the same arguments used in draw() as radiobutton or checkbox depending to the value of _radio<syntaxhighlight lang="cpp"> bool editable()const;</syntaxhighlight>*Always return true;<syntaxhighlight lang="cpp"> void set(const void* flag);</syntaxhighlight>*Casts the incoming flag pointer to an (int*) and sets the content of '''_flag''' to where '''flag''' is pointing to.<syntaxhighlight lang="cpp"> bool checked()const; void checked(bool val);</bigsyntaxhighlight>*These methods set and get _flag.
==CMenuItem==
#include "cfield.h"
class CMenuItem:public CField{
const char* Text();
};
</syntaxhighlight>===Attributes===<syntaxhighlight lang="cpp"> int _selected; char _format[3]; char* _text;</syntaxhighlight>*_selected holds the status of the menuitem (0: not selected, 1: selected) and is pointed by _data.*_format hods the surrounding "selection indicator" characters used by bio_displaymenuitem.*_text points to the allocated memory holding the text of the menuitem ===Constructors / Destructor===<syntaxhighlight lang="cpp"> CMenuItem(bool Selected,const char* Format, const char* Text, int Row, int Col, int Width);</syntaxhighlight>*Sets _selected to Selected (0 for false and 1 for true)*Copies Format into _format*Allocated enough memory to hold Text and sets _text to address of newly allocated memory*Copies the string pointed by Text into _text*Sets _data to the address of _selected*It passes the Row, the Col and the Width to the CField constructor<syntaxhighlight lang="cpp"> CMenuItem(const CMenuItem &CM);</syntaxhighlight>*Passes the incoming CMenuItem ("CM") to CFiled's constructor*Allocated enough memory to hold CM._text and sets _text to address of newly allocated memory*Copies the string pointed by CM._text into _text*Sets _selected to CM._selected*Sets _data to the address of _selected<syntaxhighlight lang="cpp"> ~CMenuItem(void);</syntaxhighlight>*Deallocated the memory pointed by _text ===Methods===<syntaxhighlight lang="cpp"> void draw(int fn = C_NO_FRAME) ;</syntaxhighlight>*Draws the object using bio_displayMenuItem function.*:Make sure absRow() and absCol() are used for Row and Col args of bio_displayMenuItem<syntaxhighlight lang="cpp"> int edit();</syntaxhighlight>*Returns the returned value of bio_menuItem() using the same arguemtns used in draw()<syntaxhighlight lang="cpp"> bool editable()const;</syntaxhighlight>*Always returns true<syntaxhighlight lang="cpp"> void set(const void* Selected);</syntaxhighlight>*Sets _selected to content pointed by Selected<syntaxhighlight lang="cpp"> bool selected()const; void selected(bool val);</syntaxhighlight>*These methods set and get _selected.<syntaxhighlight lang="cpp"> const char* Text()const;</bigsyntaxhighlight>*Returns _text
=Complex Core User Interface classes=
==CValEdit==
#include "clineedit.h"
class CValEdit: public CLineEdit{
void (*_help)(MessageStatus, CDialog&);
int edit();
};
</syntaxhighlight>
===Attributes===
<syntaxhighlight lang="cpp">
void (*_help)(MessageStatus, CDialog&);
bool (*_validate)(const char*, CDialog&);
</syntaxhighlight>
*_help, holds the address of the help logic (function) or NULL if there is no help function is assigned
*_validate, holds the address of the validation logic (function) or NULL if there is no validation function is assgned
===Constructors===<syntaxhighlight lang="cpp"> CValEdit(char* Str, int Row, int Col, int Width, int Maxdatalen, int* Insertmode, bool (*Validate)(const char* , CDialog&) = NO_VALDFUNC, void (*Help)(MessageStatus, CDialog&) = NO_HELPFUNC, bool Bordered = false, const char* Border=C_BORDER_CHARS); CValEdit(int Row, int Col, int Width, int Maxdatalen, int* Insertmode, bool (*Validate)(const char* , CDialog&) = NO_VALDFUNC, void (*Help)(MessageStatus, CDialog&) = NO_HELPFUNC, bool Bordered = false, const char* Border=C_BORDER_CHARS);</syntaxhighlight>These constructors pass all their arguments to corresponding arguments of CLineEdit constructor and then set '''_help''' and '''_validate''' attributes to the corresponding incoming arguments ===Method===<syntaxhighlight lang="cpp"> int edit();</syntaxhighlight>If the container() is NULL then this function works exactly like LineEdit::edit().<br />If the container() is not NULL:#If _help function exist it calls the function passing MessageStatus::SetMessage and container()'s reference as arguments.#Calls LineEdit's edit()#If validation function exists and the terminating key of LineEdit's edit() is a navigation key(see below)#:It will call the validation function on the Field's _data, if the data is valid, it goes to next step, otherwise it will repeat calling LineEdit's edit().#After validation is done, if _help function exists, it will recall the help function using MessageStatus::ClearMessage and contianer()'s reference as arguments.#It will return the terminating key ''Navigation keys are Up key, Down key, Tab key or Enter key.''<br /big>''MessageStatus is enumerated in '''cgh.h'''''
==CText==
#include "cfield.h"
~CText();
};
</syntaxhighlight></big>
==CCheckList==
#include "cfield.h"
#include "ccheck.h"
};
</syntaxhighlight></big>
==CMenu==
#include "cfield.h"
#include "cmenuitem.h"
~CMenu(void);
};
</syntaxhighlight></big>
=Make Files and Testers=
Copy these makefiles under "makefile" name in root of your project in Linux or Mac.<br />
where [X] is number of the test. (i.e. run $fardad.soleimanloo/t3 for test3
== Test2 Make file ==
t2: bio.o cframe.o cfield.o cdialog.o clabel.o Test2DialogAndLabel.o
<tab>c++ bio.o cframe.o cfield.o cdialog.o clabel.o \
<tab>c++ -c Test2DialogAndLabel.cpp
</pre></big>
==Test 3 make file==
prj: bio.o cframe.o cfield.o cdialog.o clabel.o clineedit.o Test3DialogAndLineEdit.o
Test3DialogAndLineEdit.o: Test3DialogAndLineEdit.cpp clineedit.h clabel.h cdialog.h cfield.h cframe.h cgh.h
<tab>c++ -c Test3DialogAndLineEdit.cpp
</pre></big>
==Full Project Makefile==
Not Tested!
prj: bio.o cframe.o cfield.o cdialog.o clabel.o clineedit.o cmenuitem.o cbutton.o ccheck.o cchecklist.o cmenu.o cveditline.o ctext.o strarr.o prj.o
c++ bio.o cframe.o cfield.o cdialog.o clabel.o clineedit.o cmenuitem.o cbutton.o ccheck.o cchecklist.o cmenu.o cveditline.o ctext.o strarr.o prj.o \
c++ -c prj.cpp
</pre></big>
