QCommenceCalendarForm Class Reference

Calendar Form Specialization Object. More...

#include <DumontDLL.h>

Inheritance diagram for QCommenceCalendarForm:

Inheritance graph

List of all members.

Public Slots

void verify ()
QCommenceFielddateStart (void)
 Date Start Field.
QCommenceFielddateEnd (void)
 Date End Field.
QCommenceFieldstartTime (void)
 Start Time Field.
QCommenceFieldendTime (void)
 End Time Field.
QCommenceFielddocketType (void)
QCommenceFieldolLocation (void)
QCommenceFielddateStarttz (void)
 Date Start Time Zone.
QCommenceFielddateEndtz (void)
 Date End Time Zone.
QCommenceFieldstartTimetz (void)
 Start Time Time Zone.
QCommenceFieldendTimetz (void)
 Date Start Time Zone.
QCommenceFieldnote (void)
QCommenceFieldoPrivate (void)
QCommenceFieldemailEmployees (void)
QCommenceFieldcalendarMsg (void)
QCommenceFieldshortType (void)
QCommenceFieldcalendarColor (void)
QCommenceConnectiontypeOfActivity (void)
QCommenceConnectiontypeOfSubType (void)
QCommenceConnectionrelatesToMatters (void)
QCommenceConnectionattendeeContacts (void)
QCommenceConnectionpRDEmployee (void)
QCommenceConnectionpWREmployee (void)
QCommenceConnectioninTimeZone (void)
QCommenceConnectionrelatesToAlerts (void)
bool onSave (void)
 Fire Form_OnSave event.
bool onEnterField (QString i_fieldName)
 Fire Form_OnEnterField event.
bool onLeaveField (QString i_fieldName)
 Fire Form_OnLeaveField event.
void changeField (QString i_fieldName, QString i_fieldValue)
 ChangeField Call-back slot.
void changeConnection (QString i_connName, QString i_toCategory, QString i_fieldValue)
 ChangeConnection Call-back slot.
void processMultiDates (void)
QString subTypeAbbv (void)
void setSystemMessage (void)
void setTimeCSTFields (void)
void setTimeZoneFields (void)
void connectMatterContacts (bool i_allContacts)
QString multiDateStart (void)
 Return the multi-date start.
QString multiDateEnd (void)
 Return the multi-date end.

Public Member Functions

 QCommenceCalendarForm (QCocDispatch *i_unknown=NULL, QObject *i_parent=NULL)
 QCommenceCalendarForm (QCocDispatch *i_unknown, QString formOptions, QObject *i_parent=NULL)
virtual ~QCommenceCalendarForm ()
void copyData (void)

Private Member Functions

QString mapField (QString fieldName, QString defaultValue)
 Field Mapper.
QStringList multiDateFieldList () const
QStringList multiDateConnectionList () const
void fireAgent (const QString &agentName, const QStringList &itemList)

Private Attributes

QString m_options
 Form Options.


Detailed Description

Calendar Form Specialization Object.

This is a Form override object. When a form object is requested, if it is in the calendar category, this Calendar form object will be returned instead of the base Commence Form object. This object adds calendar-specific functionality to the basic Form object that is common to Calendar-related functions, such as manipulating multi-date events and maintaining time-zone related fields.

Commence only uses a single date in most of its functions mostly because multi-date items in Commence are represented by multiple items, each item having its own single date. But when synchronizing with most external databases two dates are required; one for the start-date and one for the end-date. Therefore, this module assumes both a "Start Date" and an "End Date", and in order to get this module to function properly, your database will require both a "Start Date" and and "End Date".

Since this form has access to the calendar, some method of designating expected fields in the calendar category needs to be provided, for the advanced functions of the object. Therefore, this form object will look for an item in the Dumont category to provide these designations. The content of that item will be as follows:

See also:
How to use the Multidate Engine

Definition at line 1415 of file DumontDLL.h.


Constructor & Destructor Documentation

QCommenceCalendarForm::QCommenceCalendarForm ( QCocDispatch i_unknown = NULL,
QObject *  i_parent = NULL 
)

Definition at line 50 of file QCommenceCalendarForm.cpp.

QCommenceCalendarForm::QCommenceCalendarForm ( QCocDispatch i_unknown,
QString  formOptions,
QObject *  i_parent = NULL 
)

Definition at line 56 of file QCommenceCalendarForm.cpp.

QCommenceCalendarForm::~QCommenceCalendarForm (  )  [virtual]

Definition at line 63 of file QCommenceCalendarForm.cpp.


Member Function Documentation

QCommenceConnection * QCommenceCalendarForm::attendeeContacts ( void   )  [slot]

Definition at line 490 of file QCommenceCalendarForm.cpp.

QCommenceField * QCommenceCalendarForm::calendarColor ( void   )  [slot]

Definition at line 467 of file QCommenceCalendarForm.cpp.

QCommenceField * QCommenceCalendarForm::calendarMsg ( void   )  [slot]

Definition at line 482 of file QCommenceCalendarForm.cpp.

void QCommenceCalendarForm::changeConnection ( QString  i_connName,
QString  i_toCategory,
QString  i_value 
) [slot]

ChangeConnection Call-back slot.

This is a change-connection call-back slot. This method gets called anytime a connection content changes and the cursor focus is moved to the next field or connection. This method requires that the Form Animation Concept functions be called during form execution.

Reimplemented from QCommenceForm.

Reimplemented in QCommenceDocketForm.

Definition at line 76 of file QCommenceCalendarForm.cpp.

void QCommenceCalendarForm::changeField ( QString  i_fieldName,
QString  i_fieldValue 
) [slot]

ChangeField Call-back slot.

This is a change-field call-back slot. This method gets called anytime a field content changes and the cursor focus is moved to the next field. This method requires that the Form Animation Concept functions be called during form execution.

Reimplemented from QCommenceForm.

Reimplemented in QCommenceDocketForm.

Definition at line 68 of file QCommenceCalendarForm.cpp.

void QCommenceCalendarForm::connectMatterContacts ( bool  i_allContacts  )  [slot]

Definition at line 1394 of file QCommenceCalendarForm.cpp.

void QCommenceCalendarForm::copyData ( void   ) 

Reimplemented in QCommenceDocketForm.

Definition at line 87 of file QCommenceCalendarForm.cpp.

QCommenceField * QCommenceCalendarForm::dateEnd ( void   )  [slot]

Date End Field.

This function maps the Date End of the calendar item.

Note:
defaults to form.field.("Date End")
See also:
dateStart, startTime, endTime

dateStarttz, dateEndtz, startTimetz, endTimetz

Definition at line 342 of file QCommenceCalendarForm.cpp.

QCommenceField * QCommenceCalendarForm::dateEndtz ( void   )  [slot]

Date End Time Zone.

This function maps the Time-Zone version of the Date End field.

Note:
defaults to form.field("Date End tz")
See also:
dateStarttz, startTimetz, endTimetz

dateStart, dateEnd, startTime, endTime

Definition at line 408 of file QCommenceCalendarForm.cpp.

QCommenceField * QCommenceCalendarForm::dateStart ( void   )  [slot]

Date Start Field.

This function maps the Start Date of the calendar item.

Note:
defaults to: form.field("Date Start")
See also:
dateEnd, startTime, endTime

dateStarttz, dateEndtz, startTimetz, endTimetz

Definition at line 326 of file QCommenceCalendarForm.cpp.

QCommenceField * QCommenceCalendarForm::dateStarttz ( void   )  [slot]

Date Start Time Zone.

This function maps the Time-Zone version of the Date Start field.

Note:
defaults to form.field("Date Start tz")
See also:
dateEndtz, startTimetz, endTimetz

dateStart, dateEnd, startTime, endTime

Definition at line 391 of file QCommenceCalendarForm.cpp.

QCommenceField * QCommenceCalendarForm::docketType ( void   )  [slot]

Definition at line 472 of file QCommenceCalendarForm.cpp.

QCommenceField * QCommenceCalendarForm::emailEmployees ( void   )  [slot]

Definition at line 477 of file QCommenceCalendarForm.cpp.

QCommenceField * QCommenceCalendarForm::endTime ( void   )  [slot]

End Time Field.

This function maps the End Time of the calendar item.

Note:
defaults to form.field("End Time")
See also:
dateStart, dateEnd, startTime

dateStarttz, dateEndtz, startTimetz, endTimetz

Definition at line 374 of file QCommenceCalendarForm.cpp.

QCommenceField * QCommenceCalendarForm::endTimetz ( void   )  [slot]

Date Start Time Zone.

This function maps the Time-Zone version of the Date Start field.

Note:
defaults to form.field("Date Start tz")
See also:
dateStarttz, dateEndtz, startTimetz

dateStart, dateEnd, startTime, endTime

Definition at line 442 of file QCommenceCalendarForm.cpp.

void QCommenceCalendarForm::fireAgent ( const QString &  agentName,
const QStringList &  itemList 
) [private]

QCommenceConnection * QCommenceCalendarForm::inTimeZone ( void   )  [slot]

Definition at line 489 of file QCommenceCalendarForm.cpp.

QString QCommenceCalendarForm::mapField ( QString  fieldName,
QString  defaultValue 
) [private]

Field Mapper.

This internal function takes care of looking for the mapped field definitions. If a field map definition can be found for the form, then the field item uses this new field name. If not, then an error message is sent to the console.

Definition at line 277 of file QCommenceCalendarForm.cpp.

QStringList QCommenceCalendarForm::multiDateConnectionList (  )  const [private]

Definition at line 504 of file QCommenceCalendarForm.cpp.

QString QCommenceCalendarForm::multiDateEnd ( void   )  [slot]

Return the multi-date end.

If a middle-date appointment is edited this will return the ending date of the multi-date.

Definition at line 1533 of file QCommenceCalendarForm.cpp.

QStringList QCommenceCalendarForm::multiDateFieldList (  )  const [private]

Definition at line 497 of file QCommenceCalendarForm.cpp.

QString QCommenceCalendarForm::multiDateStart ( void   )  [slot]

Return the multi-date start.

If a middle-date appointment is edited this will return the beginning date of the multi-date.

Definition at line 1521 of file QCommenceCalendarForm.cpp.

QCommenceField * QCommenceCalendarForm::note ( void   )  [slot]

Definition at line 447 of file QCommenceCalendarForm.cpp.

QCommenceField * QCommenceCalendarForm::olLocation ( void   )  [slot]

Definition at line 457 of file QCommenceCalendarForm.cpp.

bool QCommenceCalendarForm::onEnterField ( QString  i_fieldName  )  [slot]

Fire Form_OnEnterField event.

vbScript Example:
 Sub Form_OnEnterField(ByVal FieldName)
   dfrm.onEnterField FieldName
 End Sub

Reimplemented from QCommenceForm.

Reimplemented in QCommenceDocketForm.

Definition at line 172 of file QCommenceCalendarForm.cpp.

bool QCommenceCalendarForm::onLeaveField ( QString  i_fieldName  )  [slot]

Fire Form_OnLeaveField event.

vbScript Example:
 Sub Form_OnLeaveField(ByVal FieldName)
   dfrm.onLeaveField FieldName
 End Sub

Reimplemented from QCommenceForm.

Reimplemented in QCommenceDocketForm.

Definition at line 178 of file QCommenceCalendarForm.cpp.

bool QCommenceCalendarForm::onSave ( void   )  [slot]

Fire Form_OnSave event.

The DumontDLL onSave event includes a few procedures for automatically stamping items with change-log information and assigning guid's and THID's and whatnot. You should review the source to see what's going on here.

 Sub Form_OnSave()
   dfrm.onSave
 End Sub

Reimplemented from QCommenceForm.

Reimplemented in QCommenceDocketForm.

Definition at line 91 of file QCommenceCalendarForm.cpp.

QCommenceField * QCommenceCalendarForm::oPrivate ( void   )  [slot]

Definition at line 452 of file QCommenceCalendarForm.cpp.

QCommenceConnection * QCommenceCalendarForm::pRDEmployee ( void   )  [slot]

Definition at line 491 of file QCommenceCalendarForm.cpp.

void QCommenceCalendarForm::processMultiDates ( void   )  [slot]

Definition at line 606 of file QCommenceCalendarForm.cpp.

QCommenceConnection * QCommenceCalendarForm::pWREmployee ( void   )  [slot]

Definition at line 492 of file QCommenceCalendarForm.cpp.

QCommenceConnection * QCommenceCalendarForm::relatesToAlerts ( void   )  [slot]

Definition at line 495 of file QCommenceCalendarForm.cpp.

QCommenceConnection * QCommenceCalendarForm::relatesToMatters ( void   )  [slot]

Definition at line 494 of file QCommenceCalendarForm.cpp.

void QCommenceCalendarForm::setSystemMessage ( void   )  [slot]

Definition at line 1279 of file QCommenceCalendarForm.cpp.

void QCommenceCalendarForm::setTimeCSTFields ( void   )  [slot]

Definition at line 1362 of file QCommenceCalendarForm.cpp.

void QCommenceCalendarForm::setTimeZoneFields ( void   )  [slot]

Definition at line 1302 of file QCommenceCalendarForm.cpp.

QCommenceField * QCommenceCalendarForm::shortType ( void   )  [slot]

Definition at line 462 of file QCommenceCalendarForm.cpp.

QCommenceField * QCommenceCalendarForm::startTime ( void   )  [slot]

Start Time Field.

This function maps the Start Time of the calendar item.

Note:
defaults to form.field("Start Time")
See also:
dateStart, dateEnd, endTime

dateStarttz, dateEndtz, startTimetz, endTimetz

Definition at line 358 of file QCommenceCalendarForm.cpp.

QCommenceField * QCommenceCalendarForm::startTimetz ( void   )  [slot]

Start Time Time Zone.

This function maps the Time-Zone version of the Start Time field.

Note:
defaults to form.field("Start Time tz")
See also:
dateStarttz, dateEndtz, endTimetz

dateStart, dateEnd, startTime, endTime

Definition at line 425 of file QCommenceCalendarForm.cpp.

QString QCommenceCalendarForm::subTypeAbbv ( void   )  [slot]

Definition at line 1258 of file QCommenceCalendarForm.cpp.

QCommenceConnection * QCommenceCalendarForm::typeOfActivity ( void   )  [slot]

Definition at line 487 of file QCommenceCalendarForm.cpp.

QCommenceConnection * QCommenceCalendarForm::typeOfSubType ( void   )  [slot]

Definition at line 488 of file QCommenceCalendarForm.cpp.

void QCommenceCalendarForm::verify (  )  [slot]

Definition at line 219 of file QCommenceCalendarForm.cpp.


Member Data Documentation

Form Options.

This options field is used to store customization attributes for this form object. Typically, the customization attributes are stored in a Commence item (such as calendarFieldMap.inc) and are loaded into the form when the form loads. These attributes then control the operation of the form, such as providing custom field mappings and other database-specific features.

Refer to QCommenceCalendarForm for notes about using the form customization features.

Definition at line 1500 of file DumontDLL.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