DumontEXE 0.0.1
Public Types | Public Slots | Public Member Functions | Properties
cmcFieldDef Class Reference

Field Definition. More...

#include <cmcFieldDef.h>

Inheritance diagram for cmcFieldDef:

List of all members.

Public Types

enum  cmcFieldTypeCodes {
  ft_text = 0, ft_number = 1, ft_date = 2, ft_telephone = 3,
  ft_checkBox = 7, ft_name = 11, ft_dataFile = 12, ft_image = 13,
  ft_time = 14, ft_excelCell = 15, ft_calculation = 20, ft_sequence = 21,
  ft_selection = 22, ft_eMailAddress = 23, ft_internetAddress = 24
}
 Field Type Codes
. More...

Public Slots

QString defaultString ()
 Get the field DefaultString value
.
bool isMandatory ()
 Get the field IsMandatory flag
.
bool isRecurring ()
 Get the field IsRecurring flag
.
bool isSelection ()
 Get the field IsSelection flag
.
bool isShared ()
 Get the field IsShared flag
.
long maxChars ()
 Get the field MaxCharacters value
.
QString string ()
 Field Definition String
.
long typeCode ()
 Field Type
.
QString typeName ()
 Field Type Name
.

Public Member Functions

 cmcFieldDef (const cmcFieldDef &copy)
 Copy Constructor
.
 cmcFieldDef (const QString &fieldName, cmcApplication *application, cmcFieldDefs *parent)
 Standard Constructor
.
virtual ~cmcFieldDef ()
 Primary Destructor
.

Properties

long index
 Index property
.

Detailed Description

Field Definition.

Definition at line 43 of file cmcFieldDef.h.


Member Enumeration Documentation

Field Type Codes
.

These are the field type codes as provided by the API

Enumerator:
ft_text 

0 ~ regular text field.

ft_number 

1 ~ numeric field

ft_date 

2 ~ date field (format MM/DD/YYYY)

ft_telephone 

3 ~ telephone field (regular text field)

ft_checkBox 

7 ~ check box

ft_name 

11 ~ name (key) field

ft_dataFile 

12 ~ data file reference

ft_image 

13 ~ bitmap (.bmp) image

ft_time 

14 ~ time value (format HH:MM:SS)

ft_excelCell 

15 ~ excel field reference

ft_calculation 

20 ~ calculated field

ft_sequence 

21 ~ numeric automatic sequence

ft_selection 

22 ~ selection (combo box)

ft_eMailAddress 

23 ~ name@website.domain

ft_internetAddress 

24 ~ url address

Definition at line 86 of file cmcFieldDef.h.


Constructor & Destructor Documentation

cmcFieldDef ( const cmcFieldDef copy)

Copy Constructor
.

Definition at line 36 of file cmcFieldDef.cpp.

cmcFieldDef ( const QString &  fieldName,
cmcApplication application,
cmcFieldDefs parent 
)

Standard Constructor
.

Definition at line 41 of file cmcFieldDef.cpp.

~cmcFieldDef ( ) [virtual]

Primary Destructor
.

This destructor handles cleanup of the object.

Definition at line 48 of file cmcFieldDef.cpp.


Member Function Documentation

QString defaultString ( void  ) [slot]

Get the field DefaultString value
.

The default value is a component of the field definition() as it is accessed through the DDE conversation module.

vbScript Example:
 msgbox "the default value is: " & dfrm.Field("Address").defaultString

Definition at line 149 of file cmcFieldDef.cpp.

bool isMandatory ( void  ) [slot]

Get the field IsMandatory flag
.

The isMandatory value is a component of the field definition() as it is accessed through the DDE conversation module.

Definition at line 123 of file cmcFieldDef.cpp.

bool isRecurring ( void  ) [slot]

Get the field IsRecurring flag
.

The isRecurring value is a component of the field definition() as it is accessed through the DDE conversation module.

Definition at line 130 of file cmcFieldDef.cpp.

bool isSelection ( void  ) [slot]

Get the field IsSelection flag
.

The isSelection value is a component of the field definition() as it is accessed through the DDE conversation module.

Definition at line 137 of file cmcFieldDef.cpp.

bool isShared ( void  ) [slot]

Get the field IsShared flag
.

The isShared value is a component of the field definition() as it is accessed through the DDE conversation module.

Definition at line 116 of file cmcFieldDef.cpp.

long maxChars ( void  ) [slot]

Get the field MaxCharacters value
.

The maxChars value is a component of the field definition() as it is accessed through the DDE conversation module.

Definition at line 144 of file cmcFieldDef.cpp.

QString string ( void  ) [slot]

Field Definition String
.

Definition at line 81 of file cmcFieldDef.cpp.

long typeCode ( ) [slot]

Field Type
.

QString typeName ( ) [slot]

Field Type Name
.


Property Documentation

long index [read]

Index property
.

Reimplemented from cmcObject.

Definition at line 47 of file cmcFieldDef.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties




~ ~ ~ ~ ~ ~
Source Code without Comments is like a Cranberry Garland
without the berries. Comment your Code!
 
Commence Database User Support Group Forum
http://newsgroup.showoff-db.org/
~ ~ ~ ~ ~ ~
Author: Mark Petryk
Lorimark Solutions, LLC
mark@lorimarksolutions.com