QCommenceConnectionDefs Class Reference

Commence Connection Definition Collection. More...

#include <QCommenceDB.h>

Inheritance diagram for QCommenceConnectionDefs:

Inheritance graph

List of all members.

Public Slots

QString names (void)
 Return a "->"/vbCrLf delimited list of the connection names.
QStringList list (void)
long count (void)
 Return the count of connection definitions.
bool contains (QString i_conCatName)
 Find a connection by name in the list.
long indexOf (QString i_conCatName)
 Return the index of a ConCat definition.
QCommenceConnectionDefget (long i_index)
 Return connection by Index.
QCommenceConnectionDefget (QString i_fieldCatName)
QCommenceConnectionDefget (QString i_connectionName, QString i_toCategory)

Public Member Functions

void init (void)
 QCommenceConnectionDefs (void)
 QCommenceConnectionDefs (const QCommenceConnectionDefs &copy)
 QCommenceConnectionDefs (QCommenceCategoryDef *i_parent)
virtual ~QCommenceConnectionDefs ()
QCommenceCategoryDefcategoryDef (void)
QCommenceDatabaseDB ()
QDomElement de (void)
QDomElement toXml (QDomDocument &doc, QDomNode &parent)

Private Attributes

QString m_names
QStringList m_list
QPointer< QCommenceDatabasem_db


Detailed Description

Commence Connection Definition Collection.

inline_dotgraph_9.dot

This object represents a collection of connection definitions. These connection definitions are usually associated with a category as its host of the connection definitions. This collection can be iterated through to find the definition for any connection.

Parameter Notes
When specifying the Connection/Category name as a single string, several format options are available. These formats include:
  ' {conName} {space} {toCategory}   (typical for Form_OnEnter, OnLeave events)
  ' {conName} "->" {toCategory}      (Default for Dumont)
  ' {conName} {tab} {toCategory}     (Default for Commence)
  '
  ' The following calls are identical:
  Sub Form_OnEnterField(ByRef FieldName)
    if( dfrm.isConnection(FieldName) ) then
      dim con: set con = dfrm.connection(FieldName)
      ddll.debug "name  " & con.name                ' "name  Calendar Item->Outlook Calendar"
      ddll.debug "count " & con.connectedItemCount  ' "count 1"
  
      set con = dfrm.connection("Calendar Item", "Outlook Calendar")
      ddll.debug "name  " & con.name                ' "name  Calendar Item->Outlook Calendar"
      ddll.debug "count " & con.connectedItemCount  ' "count 1"

      set con = dfrm.connection("Calendar Item Outlook Calendar")
      ddll.debug "name  " & con.name                ' "name  Calendar Item->Outlook Calendar"
      ddll.debug "count " & con.connectedItemCount  ' "count 1"
  
      set con = dfrm.connection("Calendar Item->Outlook Calendar")
      ddll.debug "name  " & con.name                ' "name  Calendar Item->Outlook Calendar"
      ddll.debug "count " & con.connectedItemCount  ' "count 1"
  
      set con = dfrm.connection("Calendar Item" & Chr(9) & "Outlook Calendar")
      ddll.debug "name  " & con.name                ' "name  Calendar Item->Outlook Calendar"
      ddll.debug "count " & con.connectedItemCount  ' "count 1"
    end if
  End Sub

Definition at line 989 of file QCommenceDB.h.


Constructor & Destructor Documentation

QCommenceConnectionDefs::QCommenceConnectionDefs ( void   )  [inline]

Definition at line 1001 of file QCommenceDB.h.

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

Definition at line 1006 of file QCommenceDB.h.

QCommenceConnectionDefs::QCommenceConnectionDefs ( QCommenceCategoryDef i_parent  )  [inline]

Definition at line 1013 of file QCommenceDB.h.

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

Definition at line 1022 of file QCommenceDB.h.


Member Function Documentation

QCommenceCategoryDef * QCommenceConnectionDefs::categoryDef ( void   ) 

Definition at line 2072 of file QCommenceDB.cpp.

bool QCommenceConnectionDefs::contains ( QString  i_conCatName  )  [slot]

Find a connection by name in the list.

This searches the list of connections for a matching name.

Parameters:
i_conCatName Connection/Category name

Definition at line 2103 of file QCommenceDB.cpp.

long QCommenceConnectionDefs::count ( void   )  [slot]

Return the count of connection definitions.

This returns the count of connection definitions.

Definition at line 2098 of file QCommenceDB.cpp.

QCommenceDatabase * QCommenceConnectionDefs::DB ( void   ) 

Definition at line 2077 of file QCommenceDB.cpp.

QDomElement QCommenceConnectionDefs::de ( void   ) 

Definition at line 2198 of file QCommenceDB.cpp.

QCommenceConnectionDef * QCommenceConnectionDefs::get ( QString  i_connectionName,
QString  i_toCategory 
) [slot]

Definition at line 2188 of file QCommenceDB.cpp.

QCommenceConnectionDef * QCommenceConnectionDefs::get ( QString  i_fieldCatName  )  [slot]

Definition at line 2166 of file QCommenceDB.cpp.

QCommenceConnectionDef * QCommenceConnectionDefs::get ( long  i_index  )  [slot]

Return connection by Index.

This returns a connection object by index number.

vbScript Example
 Sub ShowMyConnections(ByRef categoryDef)
   dim i: for i = 0 to categoryDef.connectionDefs.count - 1
     dim conDef: set conDef = categoryDef.connectionDefs.get(i)
     msgbox conDef.name & "::" & conDef.toCategory
   next
 End Sub

Definition at line 2161 of file QCommenceDB.cpp.

long QCommenceConnectionDefs::indexOf ( QString  i_conCatName  )  [slot]

Return the index of a ConCat definition.

Definition at line 2117 of file QCommenceDB.cpp.

void QCommenceConnectionDefs::init ( void   )  [inline]

Definition at line 996 of file QCommenceDB.h.

QStringList QCommenceConnectionDefs::list ( void   )  [slot]

Definition at line 2091 of file QCommenceDB.cpp.

QString QCommenceConnectionDefs::names ( void   )  [slot]

Return a "->"/vbCrLf delimited list of the connection names.

This returns a list of all the names in this category connection definition collection. The list items are delimited as follows:

  • {conName1} "->" {toCategory1} {vbCrLf}
  • {conName2} "->" {toCategory2} {vbCrLf}
  • {conName3} "->" {toCategory3} {vbCrLf}
  • {conName4} "->" {toCategory4} {vbCrLf}

Definition at line 2084 of file QCommenceDB.cpp.

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

Definition at line 2205 of file QCommenceDB.cpp.


Member Data Documentation

Definition at line 1111 of file QCommenceDB.h.

QStringList QCommenceConnectionDefs::m_list [private]

Definition at line 1109 of file QCommenceDB.h.

Definition at line 1108 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