Conversation Class Reference

Commence DDE Conversation. More...

#include <conversation.h>

Inherited by Conversation.

List of all members.

Public Slots

bool addItem (const QString &cat, const QString &item, const QString &clarify="")
 Add an Item.
bool addSharedItem (const QString &cat, const QString &item)
 Add a Shared Item.
bool appendText (const QString &cat, const QString &item, const QString &field, const QString &text)
 Append Text to a field.
QString appName () const
 Application Name.
bool assignConnection (const QString &fromCat, const QString &fromItem, const QString &conName, const QString &toCat, const QString &toItem)
 Assign a connection.
bool checkInFormScript (const QString &cat, const QString &form, const QString &file)
 Check a script into a form.
bool checkOutFormScript (const QString &cat, const QString &form, const QString &file)
 Check a script out of a form.
bool clarifyItemNames () const
 Return Clarified Item Name Status.
void clarifyItemNames (bool status)
 Set the Clarify Item Names status.
bool close ()
 Close Conversation Object.
QString databases () const
 Return a database list.
bool deleteItem (const QString &cat, const QString &item)
 Delete an Item.
bool deleteView (const QString &view)
 Delete a View.
bool editItem (const QString &categoryName, const QString &item, const QString &field, const QString &value)
 Edit an Item.
bool execute (const QString &cmd)
 Execute a DDE command.
bool fireTrigger (const QString &trig, const QString &arg2="", const QString &arg3="", const QString &arg4="", const QString &arg5="", const QString &arg6="", const QString &arg7="", const QString &arg8="", const QString &arg9="")
 Fire an Agent Trigger.
QString formats () const
 Return Clipboard Formats.
QString getActiveViewInfo (const QString &delimiter=LIST_DELIMITER) const
 Return to Active View Info.
QString getCallerID (const QString &cat, const QString &phone, const QString &delim=LIST_DELIMITER) const
 Return Caller ID.
int getCategoryCount () const
 Get Category Count.
QString getCategoryDefinition (const QString &cat, const QString &delim=LIST_DELIMITER) const
 Get Category Definition.
QString getCategoryNames (const QString &delimiter=LIST_DELIMITER) const
 Get Category Names.
QStringList getCategoryNamesList () const
 Get Category List.
int getConnectedItemCount (const QString &fromCat, const QString &fromItem, const QString &conName, const QString &toCat, const QString &delimiter=LIST_DELIMITER) const
 Get Connected Item Count.
QString getConnectedItemField (const QString &fromCat, const QString &fromItem, const QString &conName, const QString &toCategory, const QString &toFieldName, const QString &delim=LIST_DELIMITER) const
 Get Connected Item Field.
QString getConnectedItemNames (const QString &fromCategory, const QString &fromItem, const QString &connectionName, const QString &toCategory, const QString &delimiter=LIST_DELIMITER) const
 Get Connected Item Names.
QString getConnectionNames (const QString &cat, const QString &delim=LIST_DELIMITER, const QString &conCatdelim=CONCAT_DELIMITER) const
 Get Connection Names.
QString getDatabase (const QString &delim=LIST_DELIMITER) const
 Get Database.
QString getDatabaseDefinition (const QString &delim=LIST_DELIMITER) const
 Get Database Definition.
int getDesktopCount () const
 Get Desktop Count.
QString getDesktopNames (const QString &delim=LIST_DELIMITER) const
 Get Desktop Names.
QStringList getDesktopNamesList () const
 Get Desktop Name List.
QString getField (const QString &cat, const QString &item, const QString &field) const
 Get Field.
int getFieldCount (const QString &cat) const
 Get Field Count.
QString getFieldDefinition (const QString &cat, const QString &field, const QString &delim=LIST_DELIMITER) const
 Get Field Definition.
QStringList getFieldDefinitionList (const QString &cat, const QString &field) const
 Get Field Definition List.
QString getFieldNames (const QString &categoryName, const QString &delimiter=LIST_DELIMITER) const
 Get Field Names.
QStringList getFieldNamesList (const QString &cat) const
 Get the fields out as a list.
bool getFieldToFile (const QString &cat, const QString &item, const QString &field, const QString &file) const
 Get Field to File.
int getFormCount (const QString &cat) const
 Get Form Count.
QString getFormNames (const QString &cat, const QString &delimiter=LIST_DELIMITER) const
 Get Form Names.
QStringList getFormNamesList (const QString &cat) const
 Get Form Names List.
int getItemCount (const QString &cat) const
 Get Item Count.
QString getLastCommand () const
 Return the Last Command.
QString getMeField (const QString &field) const
 Get Me Field value.
QString getPreference (const QString &setting, const QString &delimiter=LIST_DELIMITER) const
 Get Preference Setting.
QStringList getPreferenceList (const QString &setting) const
QString getViewNames (const QString &cat, const QString &delimiter=LIST_DELIMITER) const
 Get View Names.
QStringList getViewNamesList (const QString &cat) const
bool isValid () const
 Is Valid.
QString request (const QString &req) const
 DDE Request.
bool setTimeStamp (const QString &categoryName, const QString &itemName)
 Set Item Time Stamp.
bool showItem (const QString &cat="", const QString &item="", const QString &form="")
 Show Item.
bool showView (const QString &view, bool reopen=false)
 Show View.
QString topic () const
 Topic Name.
void traceOn (bool)
 Change Trace Mode.
bool viewCategory (const QString &categoryName) const
 View Category.
bool viewFilter (const QString &filter) const
 View Filter.
int viewItemCount () const
 View Item Count.
bool viewMarkItem (int index) const
 View Mark Item.

Public Member Functions

 Conversation (const Conversation &copy)
 Copy Constructor.
 Conversation (QObject *parent=0)
 Default Constructor.
 Conversation (const QString &appName, const QString &topic, const Database &db)
 Standard Constructor.
Database database () const
 Originating Database Reference.
CommenceAPI::ICommenceConversation * getCommenceConversation () const
 DDE Conversation Server.
Conversation operator= (const Conversation &copy)
 Assignment Operator.


Detailed Description

Commence DDE Conversation.

The Commence DDE conversation is a component that wraps the basic DDE component in Commence. This object provides a higher-level of functionality to the basic dde function.

Definition at line 90 of file conversation.h.


Constructor & Destructor Documentation

Conversation ( const QString &  appName,
const QString &  topic,
const Database db 
)

Standard Constructor.

This constructor is used by the Database object to construct a Conversation object.

Parameters:
appName string ~ this is always "Commence"
topic string ~ this can be "GetData" but should be the Database.path()
db reference to originating database

Definition at line 254 of file conversation.cpp.

Conversation ( QObject *  parent = 0  ) 

Default Constructor.

This is the ~default~ constructor

Definition at line 278 of file conversation.cpp.

Conversation ( const Conversation copy  ) 

Copy Constructor.

This copy constructor copies the reference to the base ConversationPrivate object, so that it acts and responds just like the original.

Definition at line 293 of file conversation.cpp.


Member Function Documentation

bool addItem ( const QString &  categoryName,
const QString &  itemName,
const QString &  itemClarify = "" 
) [slot]

Add an Item.

This function adds an item to a category.

Note:
Care should be taken to insure that the category can accept a new item. This is the responsibility of the programmer. No action is taken on the part of this function to determine if the category can be written to, or the potential pitfalls therein. For instance it may be possible to write to a category, but if that category has special permissions appied to it, and if the (-me-) connection is not properly assigned, you could potentially have an item in a category that you can neither write to nor delete.
Attention:
If the Category has mandatory fields, those fields must be filled in with subsequent editItem commands. Use the getFieldDefinition request to determine which fields are mandatory. Unpredictable results may follow if mandatory fields are left unfilled.
vbScript Example
 dim dexe: set dexe = createObject("Dumont.EXE") ' hook dumont
 dim dapp: set dapp = dexe.applications("DB1")   ' fetch an app by the its aliasName

 if( not dapp.cv.addItem("Person", "Smith, John (""sparky"")") ) then
   msgbox "Hmm, problem here"
   exit sub
 end if
See also:
addSharedItem
Returns:
bool ~ false on error
Parameters:
categoryName see: categoryName
itemName see: itemName
itemClarify see: itemClarify. (optional)

Definition at line 498 of file conversation.cpp.

bool addSharedItem ( const QString &  categoryName,
const QString &  itemName 
) [slot]

Add a Shared Item.

Identical in function to addItem except that it creates a shared item, provided that the database is connected and the category is shared. Otherwise a local item is created.

Attention:
If the Category has mandatory fields, those fields must be filled in with subsequent editItem commands. Use the getFieldDefinition request to determine which fields are mandatory. Unpredictable results may follow if mandatory fields are left unfilled.
See also:
addItem
Returns:
bool ~ false on error
Parameters:
categoryName see: categoryName
itemName see: itemName

Definition at line 535 of file conversation.cpp.

bool appendText ( const QString &  categoryName,
const QString &  itemName,
const QString &  fieldName,
const QString &  appendText 
) [slot]

Append Text to a field.

Appends Text to an existing text Field. Use this command to overcome the 256 character maximum string limitation of certain macro languages (such as WordBasic). Whenever possible, use a clarified item name.

Returns:
bool ~ false on error
Parameters:
categoryName see: categoryName
itemName see: itemName
fieldName see: fieldName
appendText Text to append to the field

Definition at line 562 of file conversation.cpp.

QString appName (  )  const [slot]

Application Name.

This returns the value of appName that was used when creating the conversation object. The value should always be "Commence".

Definition at line 395 of file conversation.cpp.

bool assignConnection ( const QString &  fromCategory,
const QString &  fromItem,
const QString &  connectionName,
const QString &  toCategory,
const QString &  toItem 
) [slot]

Assign a connection.

Assign a connection between the two indicated Items via Connection. Whenever possible, use a Clarified Item Name.

Returns:
bool ~ false on error
Parameters:
fromCategory see: categoryName
fromItem see: itemName
connectionName see: connectionName
toCategory see: categoryName
toItem see: itemName

Definition at line 595 of file conversation.cpp.

bool checkInFormScript ( const QString &  categoryName,
const QString &  formName,
const QString &  fileName 
) [slot]

Check a script into a form.

Updates the named detail form with the VBScript in the specified Filename. Only text (.txt) format files are currently supported. Filename must be a fully qualified path including the drive letter (e.g. c:\tmp\script.txt).

See also:
cmcApplication::loadDefs
Returns:
bool ~ false on error
Parameters:
categoryName see: categoryName
formName see: formName
fileName see: fieldName

Definition at line 636 of file conversation.cpp.

bool checkOutFormScript ( const QString &  categoryName,
const QString &  formName,
const QString &  fileName 
) [slot]

Check a script out of a form.

Saves the VBScript associated with a particular detail form, FormName, to the named file, Filename. Only text (.txt) format files are currently supported. Filename must be a fully qualified path including the drive letter (e.g. c:\tmp\script.txt).

See also:
cmcApplication::loadDefs
Returns:
bool ~ false on error
Parameters:
categoryName see: categoryName
formName see: formName
fileName see: fieldName

Definition at line 669 of file conversation.cpp.

bool clarifyItemNames (  )  const [slot]

Return Clarified Item Name Status.

See also:
clarifiedItemNames
Returns:
bool ~ true if clarified item names is turned on

Definition at line 725 of file conversation.cpp.

void clarifyItemNames ( bool  status  )  [slot]

Set the Clarify Item Names status.

Tells Commence if clarified item names should be returned.

See also:
clarifiedItemNames
Returns:
bool ~ false on error
Parameters:
status Status Flag true/false
If Status is "True", Commence will always return clarified item names (if the category has a clarify field defined). If Status is "False", non-clarified item names are returned. The default is "False".

Definition at line 699 of file conversation.cpp.

bool close (  )  [slot]

Close Conversation Object.

This closes the conversation object and release all resources associated with it. It effectively kills this instance of this object.

Definition at line 365 of file conversation.cpp.

Database database (  )  const

Originating Database Reference.

This returns a reference to the Database object that opened the DDE conversation.

Definition at line 324 of file conversation.cpp.

QString databases (  )  const [slot]

Return a database list.

Note:
Use the getDatabase request to determine the currently active database.
Returns:
List of Commence databases. The list is of the form: {Database Name 1}TAB{Database Path 1}CR/LF{Database Name 2}TAB{Database Path 2}CR/LF... CR/LF{Database Name n}TAB{Database Path n}

Definition at line 743 of file conversation.cpp.

bool deleteItem ( const QString &  categoryName,
const QString &  itemName 
) [slot]

Delete an Item.

Deletes the indicated Item from the Category. Once an item is deleted, it cannot be recovered. Whenever possible, use a clarified item name..

Returns:
bool ~ false if the item could not be deleted
Parameters:
categoryName see: categoryName
itemName see: itemName

Definition at line 757 of file conversation.cpp.

bool deleteView ( const QString &  viewName  )  [slot]

Delete a View.

This command deletes the saved view.

Returns:
bool ~ false if the view could not be deleted
Parameters:
viewName see: viewName

Definition at line 781 of file conversation.cpp.

bool editItem ( const QString &  categoryName,
const QString &  itemName,
const QString &  fieldName,
const QString &  fieldValue 
) [slot]

Edit an Item.

Sets the value of Field to Value for the item identified by Item in Category. Field must not specify a Calculation field. Date fields may not specify a range, (e.g., "every day"). Whenever possible, use a clarified Item name.

If Field is an image field, Value must specify the filename containing the image. The filename must be a fully qualified path including the drive letter. The specified .bmp file is pasted into the image field. Only .BMP format image fields are currently supported. For example:

 if( not cv.editItem("Person", "Doe, John", "Snapshot", "c:\image\photo.bmp") ) then
   dexe.debug "problem editing photo into item"
 end if

Returns:
bool ~ false if the item could not be edited
Parameters:
categoryName see: categoryName
itemName see: itemName
fieldName see: fieldName
fieldValue New Field Value overwrites the existing field value

Definition at line 815 of file conversation.cpp.

bool execute ( const QString &  cmd  )  [slot]

Execute a DDE command.

Returns:
false if the execute call did not succeed
Parameters:
cmd DDE command string

Definition at line 441 of file conversation.cpp.

bool fireTrigger ( const QString &  trigger,
const QString &  arg2 = "",
const QString &  arg3 = "",
const QString &  arg4 = "",
const QString &  arg5 = "",
const QString &  arg6 = "",
const QString &  arg7 = "",
const QString &  arg8 = "",
const QString &  arg9 = "" 
) [slot]

Fire an Agent Trigger.

This command fires the indicated Agent Trigger.

You can pass arguments to be used by the agent actions. The arguments passed via a DDE trigger are accessible using the following keyword strings: (-0-), (-1-), (-2-), (-3-), (-4-), (-5-), (-6-), (-7-), (-8-), and (-9-). These keyword strings may be used to display the passed arguments using a message box or status bar action, to set values in an Add or Edit Item action or any other place that keyword replacement is allowed in agents. The following example illustrates how the DDE trigger arguments are mapped to keywords.

  [FireTrigger(TrigStr, Arg2, Arg3, Arg4, Arg5, Arg6, Arg7, Arg8, Arg9)]
    (-0-) = Always FireTrigger
    (-1-) = Trigger String, e.g., TrigStr
    (-2-) through (-9-) = The string passed in that position, e.g., Arg2
    through Arg9 respectively.

Returns:
bool ~ false on error
Parameters:
trigger Trigger Name
arg2 Argument values arg2..arg9
arg3 optional argument ~ string
arg4 optional argument ~ string
arg5 optional argument ~ string
arg6 optional argument ~ string
arg7 optional argument ~ string
arg8 optional argument ~ string
arg9 optional argument ~ string

Definition at line 864 of file conversation.cpp.

QString formats (  )  const [slot]

Return Clipboard Formats.

Returns:
A tab-delimited list of clipboard formats supported by Commence for DDE.

Definition at line 912 of file conversation.cpp.

QString getActiveViewInfo ( const QString &  delimiter = LIST_DELIMITER  )  const [slot]

Return to Active View Info.

Returns:
Information about the currently active view. The return string is of the form: {ViewName}Delim {ViewType}Delim {CategoryName}Delim {ItemName}Delim {FieldName} {ViewType} can be any one of the following:
Book Calendar Gantt Chart Report Item Detail

{FieldName} is only valid if the active child window is an item detail. Note that a getField on an active item detail will only retrieve the previous field value (before the edit). Until an item is saved, there is no way to retrieve updated field values.

Note:
If the optional Delim parameter is not specified, the returned list is delimited with CR/LF (ASCII codes 13 and 10). The Delim parameter can be any string (up to 8 characters).
Parameters:
delimiter delimiter (optional)

Definition at line 940 of file conversation.cpp.

QString getCallerID ( const QString &  categoryName,
const QString &  phoneNumber,
const QString &  delimiter = LIST_DELIMITER 
) const [slot]

Return Caller ID.

Returns:
list of all items in the Category having the given phone number in a phone field.
If Category is blank, this function searches all categories in the currently active database. The phone number may be given in a variety of formats. Some examples of valid phone values are:

 1(800)CALLNOW
 415-555-1212
 123

Note:
If the optional Delim parameter is not specified, the returned list is delimited with CR/LF (ASCII codes 13 and 10). The Delim parameter can be any string (up to 8 characters).
Parameters:
categoryName see: categoryName
phoneNumber formatted phone number
delimiter delimiter (optional)

Definition at line 974 of file conversation.cpp.

int getCategoryCount (  )  const [slot]

Get Category Count.

Returns:
long ~ number of categories in the system

Definition at line 999 of file conversation.cpp.

QString getCategoryDefinition ( const QString &  categoryName,
const QString &  delimiter = LIST_DELIMITER 
) const [slot]

Get Category Definition.

Returns:
String ~ delimited text of Category Definition
Parameters:
categoryName see: categoryName
delimiter delimiter (optional)

Definition at line 1010 of file conversation.cpp.

QString getCategoryNames ( const QString &  delimiter = LIST_DELIMITER  )  const [slot]

Get Category Names.

Returns:
String ~ Delimited string of category names
Parameters:
delimiter optional ~ defaults to vbCrLf

Definition at line 1041 of file conversation.cpp.

QStringList getCategoryNamesList (  )  const [slot]

Get Category List.

Return the category names as a String List.

Definition at line 1055 of file conversation.cpp.

CommenceAPI::ICommenceConversation * getCommenceConversation (  )  const

DDE Conversation Server.

This is the original object pointer being wrapped.

Definition at line 337 of file conversation.cpp.

int getConnectedItemCount ( const QString &  fromCategory,
const QString &  fromItem,
const QString &  connectionName,
const QString &  toCategory,
const QString &  delimiter = LIST_DELIMITER 
) const [slot]

Get Connected Item Count.

Returns:
long ~ Number of Connected items
Parameters:
fromCategory see: categoryName
fromItem see: itemName
connectionName see: connectionName
toCategory see: categoryName
delimiter delimiter (optional)

Definition at line 1066 of file conversation.cpp.

QString getConnectedItemField ( const QString &  fromCategory,
const QString &  fromItem,
const QString &  connectionName,
const QString &  toCategory,
const QString &  toFieldName,
const QString &  delimiter = LIST_DELIMITER 
) const [slot]

Get Connected Item Field.

Returns:
String ~
Parameters:
fromCategory see: categoryName
fromItem see: itemName
connectionName see: connectionName
toCategory see: categoryName
toFieldName see: fieldName
delimiter delimiter (optional)

Definition at line 1100 of file conversation.cpp.

QString getConnectedItemNames ( const QString &  fromCategory,
const QString &  fromItem,
const QString &  connectionName,
const QString &  toCategory,
const QString &  delimiter = LIST_DELIMITER 
) const [slot]

Get Connected Item Names.

Returns:
Parameters:
fromCategory see: categoryName
fromItem see: itemName
connectionName see: connectionName
toCategory see: categoryName
delimiter delimiter (optional)

Definition at line 1138 of file conversation.cpp.

QString getConnectionNames ( const QString &  categoryName,
const QString &  delimiter = LIST_DELIMITER,
const QString &  conCatDelimiter = CONCAT_DELIMITER 
) const [slot]

Get Connection Names.

Returns:
A list of all connections where the named Commence category is the From category.
The list is of the form:

  • {Connection 1}ConnCatDelim {ToCategory 1}Delim
  • {Connection 2}ConnCatDelim {ToCategory 2}Delim...Delim
  • {Connection n}ConnCatDelim
  • {ToCategory n}
where {Connection n} is the name of the nth connection and {ToCategory n} is the name of the To category for the nth connection.

Note:
If the optional delimiter parameters are not specified, the returned list is delimited with CR/LF (ASCII codes 13 and 10). The Delim parameter can be any string (up to 8 characters). If the optional connCatDelim parameter is not specified, the connection names and their To categories are delimited with " -> ". The ConnCatDelim parameter can be any string (up to 8 characters).
 vbScript Example
 dim dexe: set dexe = createObject("Dumont.EXE") ' open dumont
 dim dapp: set dapp = dexe.applications("KES")   ' fetch a database by its alias name

 '
 ' Pull the connection names out.  You should have an array of
 '  connection names, each of the "conName -> toCatName" format.
 '
 dim conDefs: set conDefs = Array( dapp.cv.getConnectionNames("Calendar"), vbCrLf )
Parameters:
categoryName see: categoryName
delimiter Item delimiter. This is usually vbCrLf.
conCatDelimiter Connection Category Delimiter. This delimiter defaults to " -> " in the cmcDatabaseApi package. You can override this when making your queries, however, this delimiter was chosen because it was assumed that this string would be fairly reliably unique... in otherwords, some developers encode special attributes in their connection/cat names so as to be able to quickly distinguish a field name from a connection name. The cmcDatabaseApi doesn't do that, but it may turn out that on some databases, the cmcDatabaseApi approach may conflict with some existing connection name encoding methods (such as if that developer already included a "->" in their connection name directly... that would be a big problem, probably).

Definition at line 1223 of file conversation.cpp.

QString getDatabase ( const QString &  delimiter = LIST_DELIMITER  )  const [slot]

Get Database.

Returns:
Parameters:
delimiter delimiter (optional)

Definition at line 1287 of file conversation.cpp.

QString getDatabaseDefinition ( const QString &  delimiter = LIST_DELIMITER  )  const [slot]

Get Database Definition.

Returns:
Parameters:
delimiter delimiter (optional)

Definition at line 1305 of file conversation.cpp.

int getDesktopCount (  )  const [slot]

Get Desktop Count.

Returns:

Definition at line 1327 of file conversation.cpp.

QString getDesktopNames ( const QString &  delimiter = LIST_DELIMITER  )  const [slot]

Get Desktop Names.

Returns:
Parameters:
delimiter delimiter (optional)

Definition at line 1338 of file conversation.cpp.

QStringList getDesktopNamesList (  )  const [slot]

Get Desktop Name List.

Definition at line 1355 of file conversation.cpp.

QString getField ( const QString &  categoryName,
const QString &  itemName,
const QString &  fieldName 
) const [slot]

Get Field.

Returns:
Parameters:
categoryName see: categoryName
itemName see: itemName
fieldName see: fieldName

Definition at line 1366 of file conversation.cpp.

int getFieldCount ( const QString &  categoryName  )  const [slot]

Get Field Count.

Returns:
Parameters:
categoryName see: categoryName

Definition at line 1392 of file conversation.cpp.

QString getFieldDefinition ( const QString &  categoryName,
const QString &  fieldName,
const QString &  delimiter = LIST_DELIMITER 
) const [slot]

Get Field Definition.

Returns:
Parameters:
categoryName see categoryName
fieldName see: fieldName
delimiter see: delimiter

Definition at line 1410 of file conversation.cpp.

QStringList getFieldDefinitionList ( const QString &  categoryName,
const QString &  fieldName 
) const [slot]

Get Field Definition List.

Parameters:
categoryName see categoryName
fieldName see: fieldName

Definition at line 1436 of file conversation.cpp.

QString getFieldNames ( const QString &  categoryName,
const QString &  delimiter = LIST_DELIMITER 
) const [slot]

Get Field Names.

Returns:
Parameters:
categoryName see categoryName
delimiter see: delimiter

Definition at line 1454 of file conversation.cpp.

QStringList getFieldNamesList ( const QString &  categoryName  )  const [slot]

Get the fields out as a list.

Parameters:
categoryName see categoryName

Definition at line 1475 of file conversation.cpp.

bool getFieldToFile ( const QString &  categoryName,
const QString &  itemName,
const QString &  fieldName,
const QString &  fileName 
) const [slot]

Get Field to File.

Returns:
Parameters:
categoryName see: categoryName
itemName see: itemName
fieldName see: fieldName
fileName filename ~ string

Definition at line 1489 of file conversation.cpp.

int getFormCount ( const QString &  categoryName  )  const [slot]

Get Form Count.

Returns:
Parameters:
categoryName see: categoryName

Definition at line 1518 of file conversation.cpp.

QString getFormNames ( const QString &  categoryName,
const QString &  delimiter = LIST_DELIMITER 
) const [slot]

Get Form Names.

Returns:
Parameters:
categoryName see categoryName

Definition at line 1537 of file conversation.cpp.

QStringList getFormNamesList ( const QString &  cat  )  const [slot]

Get Form Names List.

Parameters:
cat String ~ Category Name

Definition at line 1556 of file conversation.cpp.

int getItemCount ( const QString &  categoryName  )  const [slot]

Get Item Count.

Parameters:
categoryName see categoryName

Definition at line 1570 of file conversation.cpp.

QString getLastCommand (  )  const [slot]

Return the Last Command.

Definition at line 456 of file conversation.cpp.

QString getMeField ( const QString &  fieldName  )  const [slot]

Get Me Field value.

Returns:
Parameters:
fieldName see: fieldName

Definition at line 1592 of file conversation.cpp.

QString getPreference ( const QString &  setting,
const QString &  delimiter = LIST_DELIMITER 
) const [slot]

Get Preference Setting.

Returns some Commence preferences setting (from Customize-Preferences). Valid Settings are:

  • "Me" Returns the Category and Item Name of the selected Me item (delimited by CR/LF). For example, "Person{Delim}Doe,John"
  • "ExternalDir" Returns the full path of the Commence external data file directory. For example, "c:\commence\data\files".
  • "LetterLogDir" Returns the full path of the Commence letter Log directory. For example, "c:\commence\letters".
Parameters:
setting Preference setting to retrieve
delimiter see: delimiter

Definition at line 1621 of file conversation.cpp.

QStringList getPreferenceList ( const QString &  setting  )  const [slot]

Parameters:
setting Preference setting to retrieve

Definition at line 1638 of file conversation.cpp.

QString getViewNames ( const QString &  categoryName,
const QString &  delimiter = LIST_DELIMITER 
) const [slot]

Get View Names.

Parameters:
categoryName string ~ view name
delimiter see: delimiter

Definition at line 1653 of file conversation.cpp.

QStringList getViewNamesList ( const QString &  categoryName  )  const [slot]

Parameters:
categoryName string ~ view name

Definition at line 1670 of file conversation.cpp.

bool isValid (  )  const [slot]

Is Valid.

This returns .true. if this DDE conversation object is valid

Definition at line 350 of file conversation.cpp.

Conversation operator= ( const Conversation copy  ) 

Assignment Operator.

This assigns one DDE conversation to another.

Definition at line 305 of file conversation.cpp.

QString request ( const QString &  req  )  const [slot]

DDE Request.

Send a dde request string

Returns:
String value of the response
Parameters:
req Request String

Definition at line 425 of file conversation.cpp.

bool setTimeStamp ( const QString &  categoryName,
const QString &  itemName 
) [slot]

Set Item Time Stamp.

This function performs a similar utility as the RowSet::setTimeStamp function. The only thing it does not do that its RowSet counterpart does is set the THID values.

Definition at line 1833 of file conversation.cpp.

bool showItem ( const QString &  categoryName = "",
const QString &  itemName = "",
const QString &  formName = "" 
) [slot]

Show Item.

[ShowItem(Category, Item, Form)]

Parameters:
categoryName string ~ Category Name
itemName string ~ Item Name
formName string ~ (optional) Form Name

Definition at line 1685 of file conversation.cpp.

bool showView ( const QString &  viewName,
bool  reopen = false 
) [slot]

Show View.

[ShowView(View Name, 1)]

Definition at line 1717 of file conversation.cpp.

QString topic (  )  const [slot]

Topic Name.

This returns the value of topic that was used when creating the conversation object. The value can be either "GetData" or the Database.path() value.

Definition at line 410 of file conversation.cpp.

void traceOn ( bool  state  )  [slot]

Change Trace Mode.

This turns Trace mode On and Off. When trace mode is ~on~ then all calls to request() and execute() cause the command strings to be sent to the debug terminal.

Definition at line 380 of file conversation.cpp.

bool viewCategory ( const QString &  categoryName  )  const [slot]

View Category.

[ViewCategory(Category)]

Parameters:
categoryName string ~ Category Name

Definition at line 1758 of file conversation.cpp.

bool viewFilter ( const QString &  filter  )  const [slot]

View Filter.

[ViewFilter(ClauseNumber, FilterType, NotFlag, FieldTypeParameters...)]

Definition at line 1779 of file conversation.cpp.

int viewItemCount (  )  const [slot]

View Item Count.

[ViewItemCount()]

Definition at line 1798 of file conversation.cpp.

bool viewMarkItem ( int  index  )  const [slot]

View Mark Item.

[ViewMarkItem(Index)]

Definition at line 1811 of file conversation.cpp.


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