Difference between revisions of "Console UI Core Classes - OOP344 20111"

From CDOT Wiki
Jump to: navigation, search
(Hierarchy)
(General Internal Header file (ccgh.h R0.1))
Line 17: Line 17:
 
The general header file holds the common setting and definition between all the Core Classes.
 
The general header file holds the common setting and definition between all the Core Classes.
 
<big><syntaxhighlight lang="cpp">
 
<big><syntaxhighlight lang="cpp">
#ifndef ___CCGH_H__
 
#define ___CCGH_H__
 
  
  #ifndef _CRT_SECURE_NO_DEPRECATE
+
#ifndef ___CGH_H__
#define _CRT_SECURE_NO_DEPRECATE
+
#define ___CGH_H__
#endif
+
   
#ifndef _CRT_SECURE_NO_WARNINGS
+
#ifndef _CRT_SECURE_NO_DEPRECATE
  #define _CRT_SECURE_NO_WARNINGS
+
#define _CRT_SECURE_NO_DEPRECATE
  #endif
+
#endif
 +
#ifndef _CRT_SECURE_NO_WARNINGS
 +
#define _CRT_SECURE_NO_WARNINGS
 +
#endif
 +
   
 +
#define C_MAX_NO_FIELDS 100
 +
#define C_BUTTON_HIT 1
 +
#define C_MAX_LINE_CHARS  (1024u)
 +
 
 +
//#define C_REFRESH -2
 +
#define C_FULL_FRAME -1
 +
#define C_NO_FRAME 0
 +
 
 +
#define C_BORDER_CHARS "/-\\|/-\\|"
 +
enum CDirection {bio_centre, bio_left, bio_right, bio_up, bio_down};
 +
 
 +
extern "C"{
 +
#include "bio.h"
 +
};
 +
 
 +
enum MessageStatus{ClearMessage,SetMessage};
 +
 
 +
 
 +
#ifdef NO_HELPFUNC
 +
# undef NO_HELPFUNC
 +
#endif
 +
#define NO_HELPFUNC ((void(*)(MessageStatus, CDialog&))(0))
 +
#ifdef NO_VALDFUNC
 +
# undef NO_VALDFUNC
 +
#endif
 +
#define NO_VALDFUNC ((bool(*)(const char*, CDialog&))(0))
  
#define CC_BORDER_CHARS "/-\\|/-\\|"
+
 
 +
#define C_MAX_LINE_CHARS (1024u)
 +
#define C_INITIAL_NUM_OF_LINES (100u)
  
 
#endif
 
#endif
 
</syntaxhighlight></big>
 
</syntaxhighlight></big>
 +
 
=File Names=
 
=File Names=
 
Use the following rules to create filenames for your class.
 
Use the following rules to create filenames for your class.

Revision as of 05:10, 8 March 2011


OOP344 | Weekly Schedule | Student List | Teams | Project | Student Resources
Under Construction!

Your objective at this stage is to create series core of classes designed to interact with the user. These Core Classes then can be used in development of any interactive application.

Please note that the class definitions here are minimum requirement for the Core Classes and you are free to add any enhancements or features you find useful. However make sure that you discuss these enhancements with your professor to make sure they are feasible before implementation.

It is highly recommended to develop the classes in the order they are stated here. You must create your won tester programs fore each class (if possible); However, close to due date of each release, a tester program is provided to help you verify the functionality of your classes. Executables of the test programs are available on matrix to show you how it is supposed to run.

Start by creating mock-up classes (class declaration and definition with empty methods that only compiles and don't do anything). Each class MUST have its own header file to hold its declaration and "cpp" file to hold its implementation. To make sure you do not do circular includes follow these simple guidelines:

  • Add recompilation safeguards to all your header files.
  • Always use forward declaration if possible instead of including a class header-file.
  • Use includes only in files in which the actual header file code is used.
  • Avoid "just in case" includes.

General Internal Header file (ccgh.h R0.1)

The general header file holds the common setting and definition between all the Core Classes.

#ifndef ___CGH_H__
#define ___CGH_H__
 
#ifndef _CRT_SECURE_NO_DEPRECATE
#define _CRT_SECURE_NO_DEPRECATE
#endif
#ifndef _CRT_SECURE_NO_WARNINGS
#define _CRT_SECURE_NO_WARNINGS
#endif
 
#define C_MAX_NO_FIELDS 100
#define C_BUTTON_HIT 1
#define C_MAX_LINE_CHARS  (1024u)

//#define C_REFRESH -2
#define C_FULL_FRAME -1
#define C_NO_FRAME 0

#define C_BORDER_CHARS  "/-\\|/-\\|"
enum CDirection {bio_centre, bio_left, bio_right, bio_up, bio_down};

extern "C"{
#include "bio.h"
};

enum MessageStatus{ClearMessage,SetMessage};


#ifdef NO_HELPFUNC
# undef NO_HELPFUNC
#endif
#define NO_HELPFUNC ((void(*)(MessageStatus, CDialog&))(0))
#ifdef NO_VALDFUNC
# undef NO_VALDFUNC
#endif
#define NO_VALDFUNC ((bool(*)(const char*, CDialog&))(0))


#define C_MAX_LINE_CHARS  (1024u)
#define C_INITIAL_NUM_OF_LINES (100u)

#endif

File Names

Use the following rules to create filenames for your class.

  • Each class MUST have its own header file and cpp file for implementation
  • Use the class name for the name of the file but make sure it is all lowercase.
    For example CFrame class should have cframe.h and cframe.cpp files for its implementation.

Hierarchy

CCFrame
 |
 |---CCDialog
 |
 |
 |---CCField
       |
       |-------- CCLabel
       |         |
       |         |-------CCCheckMark
       |         |-------CCMenuItem
       |
       |-------- CCButton
       |
       |
       |-------- CCLineEdit
       |         |
       |         |-------CCValEdit
       |
       |-------- CCText
       |
       |-------- CCCheckList
       |-------- CCMenu 

Basic (BIO) Encapsulating Classes

CFrame