QCommenceFieldDef Class Reference

Commence Field Definition Object. More...

#include <QCommenceDB.h>

Inheritance diagram for QCommenceFieldDef:

Inheritance graph

List of all members.

Public Types

enum  CommenceFieldTypes {
  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
}

Public Slots

QString name (void)
QString string (void)
long index (void)
 Get the Index number of this field.
long type (void)
 Get the Field Type.
QString typeName (void)
bool isShared (void)
 Get the field IsShared flag.
bool isMandatory (void)
 Get the field IsMandatory flag.
bool isRecurring (void)
 Get the field IsRecurring flag.
bool isSelection (void)
 Get the field IsSelection flag.
long maxChars (void)
 Get the field MaxCharacters value.
QString defaultString (void)
 Get the field DefaultString value.
QString comment (void)
QString documentation (void)
bool isPublished (void)
QString xml (void)
 Get an xml-compliant string.

Public Member Functions

 QCommenceFieldDef (void)
 QCommenceFieldDef (const QCommenceFieldDef &copy)
 QCommenceFieldDef (QString i_name, QCommenceFieldDefs *i_parent)
virtual ~QCommenceFieldDef ()
QCommenceFieldDefsfieldDefs (void)
QCommenceCategoryDefcategoryDef (void)
QCommenceDatabaseDB (void)
QDomElement toXml (QDomDocument &doc, QDomNode &parent)
 Load a QDomElement for this field.
QDomElement de (void)

Private Attributes

QString m_string
long m_index
QPointer< QCommenceCategoryDefm_categoryDef
QPointer< QCommenceDatabasem_db


Detailed Description

Commence Field Definition Object.

inline_dotgraph_14.dot

Definition at line 1149 of file QCommenceDB.h.


Member Enumeration Documentation

Enumerator:
ft_text 
ft_number 
ft_date 
ft_telephone 
ft_checkBox 
ft_name 
ft_dataFile 
ft_image 
ft_time 
ft_excelCell 
ft_calculation 
ft_sequence 
ft_selection 
ft_eMailAddress 
ft_internetAddress 

Definition at line 1156 of file QCommenceDB.h.


Constructor & Destructor Documentation

QCommenceFieldDef::QCommenceFieldDef ( void   )  [inline]

Definition at line 1175 of file QCommenceDB.h.

QCommenceFieldDef::QCommenceFieldDef ( const QCommenceFieldDef copy  )  [inline]

Definition at line 1182 of file QCommenceDB.h.

QCommenceFieldDef::QCommenceFieldDef ( QString  i_name,
QCommenceFieldDefs i_parent 
) [inline]

Definition at line 1189 of file QCommenceDB.h.

virtual QCommenceFieldDef::~QCommenceFieldDef (  )  [inline, virtual]

Definition at line 1200 of file QCommenceDB.h.


Member Function Documentation

QCommenceCategoryDef * QCommenceFieldDef::categoryDef ( void   ) 

Definition at line 2247 of file QCommenceDB.cpp.

QString QCommenceFieldDef::comment ( void   )  [slot]

Definition at line 2413 of file QCommenceDB.cpp.

QCommenceDatabase * QCommenceFieldDef::DB ( void   ) 

Definition at line 2254 of file QCommenceDB.cpp.

QDomElement QCommenceFieldDef::de ( void   ) 

Definition at line 2391 of file QCommenceDB.cpp.

QString QCommenceFieldDef::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 2339 of file QCommenceDB.cpp.

QString QCommenceFieldDef::documentation ( void   )  [slot]

Definition at line 2418 of file QCommenceDB.cpp.

QCommenceFieldDefs * QCommenceFieldDef::fieldDefs ( void   ) 

Definition at line 2240 of file QCommenceDB.cpp.

long QCommenceFieldDef::index ( void   )  [slot]

Get the Index number of this field.

Note that the index number will change when fields are added or removed from the category definition.

Definition at line 2350 of file QCommenceDB.cpp.

bool QCommenceFieldDef::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 2313 of file QCommenceDB.cpp.

bool QCommenceFieldDef::isPublished ( void   )  [slot]

Definition at line 2423 of file QCommenceDB.cpp.

bool QCommenceFieldDef::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 2320 of file QCommenceDB.cpp.

bool QCommenceFieldDef::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 2327 of file QCommenceDB.cpp.

bool QCommenceFieldDef::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 2306 of file QCommenceDB.cpp.

long QCommenceFieldDef::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 2334 of file QCommenceDB.cpp.

QString QCommenceFieldDef::name ( void   )  [slot]

Definition at line 2261 of file QCommenceDB.cpp.

QString QCommenceFieldDef::string ( void   )  [slot]

Definition at line 2266 of file QCommenceDB.cpp.

QDomElement QCommenceFieldDef::toXml ( QDomDocument &  doc,
QDomNode &  parent 
)

Load a QDomElement for this field.

Definition at line 2359 of file QCommenceDB.cpp.

long QCommenceFieldDef::type ( void   )  [slot]

Get the Field Type.

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

Definition at line 2276 of file QCommenceDB.cpp.

QString QCommenceFieldDef::typeName ( void   )  [slot]

Definition at line 2281 of file QCommenceDB.cpp.

QString QCommenceFieldDef::xml ( void   )  [slot]

Get an xml-compliant string.

This function formats this field definition as an xml-compliant document string.

Definition at line 2381 of file QCommenceDB.cpp.


Member Data Documentation

Definition at line 1322 of file QCommenceDB.h.

Definition at line 1323 of file QCommenceDB.h.

Definition at line 1320 of file QCommenceDB.h.

QString QCommenceFieldDef::m_string [private]

Definition at line 1319 of file QCommenceDB.h.


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




~ ~ ~ ~ ~ ~
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