FieldDef Class Reference

Category Definition. More...

#include <fielddef.h>

List of all members.

Public Types

enum  Type {
  NoType = -1, Text = 0, Number = 1, Date = 2,
  Telephone = 3, CheckBox = 7, Name = 11, DataFile = 12,
  Image = 13, Time = 14, ExcelCell = 15, Calculation = 20,
  Sequence = 21, Selection = 22, EMailAddress = 23, InternetAddress = 24
}
 Field Type Codes. More...

Public Member Functions

QString defaultValue () const
 Get the field DefaultString value
.
 FieldDef (const FieldDef &copy)
 Copy Constructor.
 FieldDef (QObject *parent=0)
 Default Constructor.
 FieldDef (const QString &fieldName, const CategoryDef catDef, const QObject *parent=0)
 Standard Constructor
.
bool isMandatory () const
 Get the field IsMandatory flag
.
bool isRecurring () const
 Get the field IsRecurring flag
.
bool isSelection () const
 Get the field IsSelection flag
.
bool isShared () const
 Get the field IsShared flag
.
int maxChars () const
 Get the field MaxCharacters value
.
FieldDef operator= (const FieldDef &copy)
 Assignment Operator.
QString string () const
 Field Definition String
.
QVariant::Type toSqlFieldType () const
 Return SQL field type.
Type typeCode () const
 Field Type
.
QString typeName () const
 Field Type Name
.
 ~FieldDef ()
 Primary Destructor.

Properties

QString defaultValue
 Get the field DefaultValue 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.
Type typeCode
 Field Type.

Private Attributes

QSharedPointer< FieldDefPrivate > d_ptr
 Convert to QSqlField type.


Detailed Description

Category Definition.

Definition at line 72 of file fielddef.h.


Member Enumeration Documentation

enum Type

Field Type Codes.

These are the field type codes as provided by the API

Enumerator:
NoType  -1 ~ no type defined
Text  0 ~ regular text field.
Number  1 ~ numeric field
Date  2 ~ date field (format MM/DD/YYYY)
Telephone  3 ~ telephone field (regular text field)
CheckBox  7 ~ check box
Name  11 ~ name (key) field
DataFile  12 ~ data file reference
Image  13 ~ bitmap (.bmp) image
Time  14 ~ time value (format HH:MM:SS)
ExcelCell  15 ~ excel field reference
Calculation  20 ~ calculated field
Sequence  21 ~ numeric automatic sequence
Selection  22 ~ selection (combo box)
EMailAddress  23 ~ fully qualified email address. Example: name@website.domain A double-click on fields of this type cause the default send-email program to launch
InternetAddress  24 ~ url address. Example: http://www.google.com A double-click on fields of this type cause the default browser to load. Note that these fields can also be loaded with the file:// prefix, causing the Commence to launch the appropriate application for the file type specified

Definition at line 92 of file fielddef.h.


Constructor & Destructor Documentation

FieldDef ( const QString &  fieldName,
const CategoryDef  catDef,
const QObject *  parent = 0 
)

Standard Constructor
.

Definition at line 222 of file fielddef.cpp.

FieldDef ( QObject *  parent = 0  ) 

Default Constructor.

Definition at line 238 of file fielddef.cpp.

FieldDef ( const FieldDef copy  ) 

Copy Constructor.

Definition at line 249 of file fielddef.cpp.

~FieldDef (  ) 

Primary Destructor.

This destructor handles cleanup of the object.

Definition at line 276 of file fielddef.cpp.


Member Function Documentation

QString defaultValue (  )  const

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

bool isMandatory (  )  const

Get the field IsMandatory flag
.

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

bool isRecurring (  )  const

Get the field IsRecurring flag
.

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

bool isSelection (  )  const

Get the field IsSelection flag
.

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

bool isShared (  )  const

Get the field IsShared flag
.

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

int maxChars (  )  const

Get the field MaxCharacters value
.

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

FieldDef operator= ( const FieldDef copy  ) 

Assignment Operator.

Definition at line 261 of file fielddef.cpp.

QString string (  )  const

Field Definition String
.

Field Definition String.

Definition at line 321 of file fielddef.cpp.

QVariant::Type toSqlFieldType (  )  const

Return SQL field type.

This returns a Variant Type that is consistent with this field type. the variant type is used to build a QSqlField object.

See also:
toSqlField

Definition at line 470 of file fielddef.cpp.

Type typeCode (  )  const

Field Type
.

QString typeName (  )  const

Field Type Name
.


Member Data Documentation

QSharedPointer<FieldDefPrivate> d_ptr [private]

Convert to QSqlField type.

Definition at line 299 of file fielddef.h.


Property Documentation

QString defaultValue [read]

Get the field DefaultValue 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 83 of file fielddef.h.

bool isMandatory [read]

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 79 of file fielddef.h.

bool isRecurring [read]

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 80 of file fielddef.h.

bool isSelection [read]

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 81 of file fielddef.h.

bool isShared [read]

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 78 of file fielddef.h.

int maxChars [read]

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 82 of file fielddef.h.

FieldDef::Type typeCode [read]

Field Type.

Definition at line 76 of file fielddef.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 Support User Group Forum
http://newsgroup.showoff-db.org/
~ ~ ~ ~ ~ ~
Author: Mark Petryk
Lorimark Solutions, LLC
mark@lorimarksolutions.com