DumontEXE 0.0.1
Public Slots | Public Member Functions | Protected Attributes | Properties | Private Attributes | Static Private Attributes
cmcObject Class Reference

Commence Base Object. More...

#include <cmcObject.h>

Inheritance diagram for cmcObject:

List of all members.

Public Slots

QString aliasName ()
 Return the object Alias Name
.
virtual cmcApplicationapp ()
 Return the Commence application object
.
static QString appendString (const QString &initial, const QString &appendValue, const QString &separator=", ")
 Append a String using a Delimiter
.
virtual cmcApplicationapplication ()
 Return the Commence application object
.
static cmcApplicationsapps ()
 Return pointer to Application R.O.T.
.
cmcActiveViewInfoavi ()
 Return a copy of the form's Active View Info
.
virtual cmcCdaItemcdaItem ()
 CDA Item
.
virtual QString comment ()
 Read the One-line Comment
.
static QString crc8String (const QString &string)
 Calculate a CRC.
virtual cmcConversationcv ()
 Return the Commence DDE Conversation object
.
QString dateTimeStamp (long length)
 TimeDate code stamp
.
QString dateTimeStamp (const QDateTime &dateTime=QDateTime::currentDateTime(), long length=14)
 Time Date code stamp
.
virtual cmcDatabasedb ()
 Return the Commence database object
.
static QString delVar (const QString &v_var, const QString &v_fld)
 Delete a Variable
.
virtual QString description ()
 Read the Multi-line Description
.
virtual QString documentation ()
 Read the Full Documentation
.
static QString dq (const QString &string)
 Double Quote
.
static void dumpString (const QString &i_string)
 Dump a string binary to debug
.
cmcErrorerror ()
 Return Error Object
.
static QString fixCase (const QString &i_value)
 Fix the case of a string
.
static QString fixPhone (const QString &i_value)
 Fix a Phone Number
.
static QString formatText (const QString &i_preText, const QString &i_text, const QString &i_postText)
 Format some text
.
cmcStringListgetStringList (long flags=0)
 Get the String List object
.
virtual QString guid ()
 Read a GUID
.
virtual long index ()
 object index number

virtual QString instanceID ()
 Object Instance ID
.
QString name ()
 Object Name
.
static QString packDate (const QDate &date=QDate::currentDate())
 Pack a Date
.
static QString packDateTime (const QDateTime &dateTimeIn=QDateTime::currentDateTime())
 Pack a Date Time
.
static QString packDateTime (const QDate &i_date, const QTime &i_time)
 Pack a Date Time
.
static QString packTime (const QTime &i_time=QTime::currentTime())
 Pack a Time
.
static QString pad (const QString &string, const QString &padString, long length)
 Pad a string
.
static bool phoneTooShort ()
 Tell if the phone was too short
.
static QString prepend (const QString &prep, const QString string, long count)
 Prepend a string to a string
.
static QString prependZero (const QString &string, long count)
 Add zeros to the beginning of a string
.
void setAliasName (const QString &value)
 Set the object Alias Name
.
virtual void setComment (const QString &value)
 Set then One-line Comment
.
virtual void setDescription (const QString &value)
 Set the Multi-line Description
.
virtual void setDocumentation (const QString &value)
 Set the One-line Comment
.
virtual void setGuid (const QString &newGuid)
 Set a GUID
.
virtual void setTemp (const QString &key, const QString &value)
 Write to a Property
.
virtual QString temp (const QString &key)
 Read a Property
.
virtual long tempCount ()
 Return the property Count
.
virtual QString tempKey (const long index)
 Return a property key at index
.
virtual QString tempValue (const long index)
 Return a property value at index
.
long trace ()
 Get the trace level
.
void trace (long flags)
 Set the trace level
.
static QString unpackDateTime (const QString &i_packedDateTime)
 Unpack a Date Time
.
static QString var (const QString &v_var, const QString &v_fld)
 Access a Var field
.
static QString var (const QString &v_var, const QString &v_fld, const QString &v_val)
 Set a Var field
.
static QString vbString (const QString &i_string)
 Make a vbString
.

Public Member Functions

 cmcObject (const cmcObject &copy)
 Copy Constructor
.
 cmcObject (QObject *parent=NULL)
 Simple Constructor
.
 cmcObject (const QString &objectName, cmcApplication *application, QObject *parent=NULL)
 Standard Constructor
.
cmcObjectparent ()
 Return the cmcObject parent pointer
.
virtual void setApp (cmcApplication *application)
 Set the application object
.
virtual void setApp (void *dispatch, const QString &dumontCategory="Dumont")
 Set the application pointer
.
virtual ~cmcObject ()
 Default Destructor
.

Protected Attributes

cmcError err
 Error Element
.
cmcActiveViewInfom_avi
 Active View Info
.
QPointer< cmcCdaItemm_cdaItem
 Reference a CDA item for this object
.

Properties

QString aliasName
 Object Alias Name
.
QString comment
 Comment Property
.
QString description
 Description Property
.
QString documentation
 Documentation Property
.
QString guid
 GUID property
.
long index
 Index property
.

Private Attributes

QPointer< cmcApplicationm_application
 Reference the Application object
.
QHash< QString, QVariant > m_props
 Local Property Store
.
QHash< QString, QString > m_temp
 Extended Properties store
.
long m_traceFlags
 Trace Flags
.

Static Private Attributes

static cmcApplications s_applications
 Static Applications Pointer
.
static bool s_showWarnings
 Global Flag to Indicate Warnings.

Detailed Description

Commence Base Object.

This is the object upon which all Commence objects are derived. This object provides for the basic object functionality such as an integrated logger and reference to the application object from which this object sprang.

Reference to the application object is required so that any Commence object rooted here can access the Commence Application API that created it. This reference to the API also allows for multiple Commence API's to run concurrently through the DumontEXE framework, thus providing vbScript access to multiple Commence databases concurrently - something that's not possible given the Commence API.

Definition at line 457 of file cmcObject.h.


Constructor & Destructor Documentation

cmcObject ( const cmcObject copy)

Copy Constructor
.

Definition at line 699 of file cmcObject.cpp.

cmcObject ( QObject *  parent = NULL)

Simple Constructor
.

Definition at line 704 of file cmcObject.cpp.

cmcObject ( const QString &  objectName,
cmcApplication application,
QObject *  parent = NULL 
)

Standard Constructor
.

This constructor is used by default for nearly all createObject operations.

Parameters:
objectNameObject Name

All cmcObjects in the system should be named. This can be any string of characters but really should be limited to good variable name characters (in other words, no punctuation or other silly characters). The object name will probably tolerate various punctuation characters, but care should be taken when creating these kinds of category names, field names, connection names and so on. Consider that these categories and fields and connections may be exported to other systems, and other system can be rather intolerant of strange punctuation marks within category and field names. Care should be taken when naming objects in your system.


Parameters:
applicationApplication Reference

All cmcObjects require a reference to the application object that created it. This is an internal reference and is mostly provided for convenience, but also to insure that objects that are created within the application also get properly destroyed by the application when the application itself is destroyed. In the case of detail forms and cursors and rowsets, the objects are not directly parented by the application object, but, rather, indirectly spawned from the application object. These objects can quickly be lost within the system (think memory leak) causing problems shutting down Commence (Commence won't shut down when there are references to Commence still open - something that happens when a vbs file crashes midstream). In the CDA, when an application is closed, all objects that were created by that application are properly released. This means that even if your vbScript file crashes, and leave a component open, once your Commence database application is shut down, and removed from the Dumont.ROT, all left-over objects will be properly destroyed, allowing Commence to also shut down properly.


Parameters:
parentDirect Parent Reference

Not all objects within the system are directly parented by the app() object. These objects include the detail forms and cursors and rowsets. These aforementioned objects get parented by the vbScript program that requested them. This allows the vbScript program that created them to also take care of destroying them. In these cases these objects (forms and rowsets) receive no parent, and get parented by the vbScript program.


Definition at line 710 of file cmcObject.cpp.

~cmcObject ( ) [virtual]

Default Destructor
.

Definition at line 755 of file cmcObject.cpp.


Member Function Documentation

QString aliasName ( ) [slot]

Return the object Alias Name
.

See also:
setAliasName, Object Alias Names
cmcApplication * app ( void  ) [virtual, slot]

Return the Commence application object
.

Every object references a single application object. The application object provides access to the database object, conversation object, cursors and rowsets and so on.

Reimplemented in cmcCda.

Definition at line 768 of file cmcObject.cpp.

QString appendString ( const QString &  initial,
const QString &  appendValue,
const QString &  separator = ", " 
) [static, slot]

Append a String using a Delimiter
.

Sometimes you will want to append a string to another string and you want to include a delimiter between the two strings. This means that you must first initialize the string to the first value, and then append any number of additional values so that you end up with, say, a comma delimited string, for instance. This is a bit of a tricky exercise in vbScript when you're filling a string via a for/next loop. To format the string properly you have to first test your existing string and if there is text in it already, then you need to include a separator. If there is not text in it already then you can just apply your string... it gets confusing.

This function should make all that a breeze.

vbScript Example ~ Building a delimited string list
 dim retVal
 dim i: for i = 1 to Attendees.connectedItemCount
   Attendees.CurrentSelection = i
   retVal = dapp.appendString( retVal, Attendees.fieldValue("FirstName") )
 next
 '
 ' result: "Tom, Dick, Harry"
 '
Returns:
Newly formatted String, containing the initial value, a delimiter, followed by the append value.
Parameters:
initialstring ~ this is the initial string. It can be blank, or it can already contain some data

appendValuestring ~ this is the value you want appended. It can be blank.

separatorstring ~ (default to ", " [comma space]) This is the delimiter. It is an optional value. If left off from the function call it will default to a comma followed by a space character.

Definition at line 167 of file cmcObject.cpp.

cmcApplication * application ( void  ) [virtual, slot]

Return the Commence application object
.

Every object references a single application object. The application object provides access to the database object, conversation object, cursors and rowsets and so on.

Definition at line 774 of file cmcObject.cpp.

static cmcApplications* apps ( ) [inline, static, slot]

Return pointer to Application R.O.T.
.

The application R.O.T. (running object table) is a static table of all the registered running applications.

Definition at line 633 of file cmcObject.h.

cmcActiveViewInfo * avi ( ) [slot]

Return a copy of the form's Active View Info
.

This method returns a copy of the Active View Info that was true when this request was made. This allows the user to determine the AVI that caused

Definition at line 1053 of file cmcObject.cpp.

cmcCdaItem * cdaItem ( ) [virtual, slot]

CDA Item
.

Reimplemented in cmcApplication.

Definition at line 807 of file cmcObject.cpp.

QString comment ( void  ) [virtual, slot]

Read the One-line Comment
.

The comment field is designed to provide for a quick, one-line comment reminder of the purpose of this object. It is used primarily for the documentation package and doesn't have any functional impact over the system.

cmcObjectComment.png
xml example of Description and Comment and Documentation
 <cmcCategoryDef name="Address" >
   <objectName type="static" >Address</objectName>
   <comment type="static" >Contact Multiple Address</comment>
   <description type="static" >This category is used to catalog multiple addresses
 for a single contact.  Each address can be given 
 designations such as 'home', 'work', 'shipping',
 'mailing', 'primary', 'secondary' and so on.</description>
   <documentation type="static" ></documentation>
See also:
ObjectExtensions, setComment, description, setDescription, documentation, setDocumentation

Definition at line 868 of file cmcObject.cpp.

QString crc8String ( const QString &  string) [static, slot]

Calculate a CRC.

This takes a string of characters and calculates a CRC value for it.

Parameters:
stringstring ~ input string

Definition at line 135 of file cmcObject.cpp.

cmcConversation * cv ( void  ) [virtual, slot]

Return the Commence DDE Conversation object
.

This is a convenience function to reference the DDE conversation object of the application. It is the same as referencing the conversation object from the database object such as in Form.Application.Database.getConversation("GetData", "Commence")

Definition at line 799 of file cmcObject.cpp.

QString dateTimeStamp ( long  length) [slot]

TimeDate code stamp
.

Returns:
String of Date/Time stamp

Definition at line 1019 of file cmcObject.cpp.

QString dateTimeStamp ( const QDateTime &  dateTime = QDateTime::currentDateTime(),
long  length = 14 
) [slot]

Time Date code stamp
.

Definition at line 1024 of file cmcObject.cpp.

cmcDatabase * db ( void  ) [virtual, slot]

Return the Commence database object
.

This is a convenience function to reference the database object of the application. It is the same as referencing the database object from the Application object such as Form.Application.Database... and so on.

Definition at line 791 of file cmcObject.cpp.

QString delVar ( const QString &  v_var,
const QString &  v_fld 
) [static, slot]

Delete a Variable
.

Delete a var.

This deletes a variable from a Var field.

This removes a varValue from a long string. In some cases it is preferrable to remove any reference to the varValue, and setting the value to "" results in a "varName=" field remaining in the varString.

Definition at line 257 of file cmcObject.cpp.

QString description ( void  ) [virtual, slot]

Read the Multi-line Description
.

The description field is used to provide a little bit more documentation about the object in question. In the case of the dumont user interface, the description field is provided as a hint pop-up. When the user flys his mouse over any of the designated objects, the description field is used to further illustrate the purpose of the object definition within the system.

cmcObjectDescription.png
Object Extensions example of Description and Comment and Documentation
 <cmcCategoryDef name="Address" >
   <objectName type="static" >Address</objectName>
   <comment type="static" >Contact Multiple Address</comment>
   <description type="static" >This category is used to catalog multiple addresses
 for a single contact.  Each address can be given 
 designations such as 'home', 'work', 'shipping',
 'mailing', 'primary', 'secondary' and so on.</description>
   <documentation type="static" ></documentation>
See also:
ObjectExtensions, setDescription, comment, setComment, documentation, setDocumentation

Definition at line 884 of file cmcObject.cpp.

QString documentation ( void  ) [virtual, slot]

Read the Full Documentation
.

The documentation field is designed to provide a full text document for this object. The document

See also:
ObjectExtensions, comment, setComment, description, setDescription, setDocumentation

Definition at line 896 of file cmcObject.cpp.

QString dq ( const QString &  string) [static, slot]

Double Quote
.

This is a convenience function for adding double quotes to strings. This is generally done before parameters are passed along to various dde commands and filter functions. This function is provided as part of the root Commence Database Api object library so that it is available to both the vbScripting environment and any object in the system.

dq example
 filter = "[GetFieldDefinition(" + dq(categoryName()) + "," + dq(fieldName()) + ")]";
 // filter == "[GetFieldDefinition("Person","Last,First")]"

One thing to note is, if the string already contains quotes, this can screw up a formatted parameter. Therefore, this function double-quotes existing quote characters before quoting the entire string. Therefore:

dq example with quoted string: itemName = "Jones, Bubba ("Jim") Alan"
 filter = "[GetField(" + dq(categoryName()) + "," + dq(itemName) + "," + dq(fieldName()) + ")]";
 // filter == "[GetField("Person","Jones, Bubba (""Jim"") Alan","Position")]"
Parameters:
stringstring ~ input

Definition at line 77 of file cmcObject.cpp.

void dumpString ( const QString &  i_string) [static, slot]

Dump a string binary to debug
.

This takes an input string and dumps it to the debug window in a ascii/binary form that makes it possible to examine the internals of the string. This is useful for doing things like determining the contents of a string, including non-printable imbedded characters like vbCrLf.

Example Output
   dumDLL.dumpString dumFRM.toXml("*")

 0000: 3c 21 44 4f 43 54 59 50 45 20 51 43 6f 6d 6d 65  <!DOCTYPE QComme
 0010: 6e 63 65 46 6f 72 6d 3e 0d 0a 3c 69 74 65 6d 20  nceForm>..<item 
 0020: 66 6f 72 6d 4e 61 6d 65 3d 22 44 75 6d 6f 6e 74  formName="Dumont
 0030: 22 20 63 61 74 65 67 6f 72 79 4e 61 6d 65 3d 22  " categoryName="
 0040: 44 75 6d 6f 6e 74 22 20 69 74 65 6d 4e 61 6d 65  Dumont" itemName
 0050: 3d 22 74 65 73 74 22 20 69 74 65 6d 43 6c 61 72  ="test" itemClar
 0060: 69 66 79 3d 22 22 20 3e 0d 0a 20 20 20 3c 66 69  ify="" >..   <fi
 0070: 65 6c 64 30 20 6e 61 6d 65 3d 22 4e 61 6d 65 22  eld0 name="Name"
 0080: 20 3e 74 65 73 74 3c 2f 66 69 65 6c 64 30 3e 0d   >test</field0>.
 0090: 0a 20 20 20 3c 66 69 65 6c 64 31 20 6e 61 6d 65  .   <field1 name

Definition at line 626 of file cmcObject.cpp.

cmcError * error ( ) [slot]

Return Error Object
.

This returns a pointer to the error element of this object.

Definition at line 1013 of file cmcObject.cpp.

QString fixCase ( const QString &  i_value) [static, slot]

Fix the case of a string
.

Definition at line 350 of file cmcObject.cpp.

QString fixPhone ( const QString &  i_value) [static, slot]

Fix a Phone Number
.

Definition at line 367 of file cmcObject.cpp.

QString formatText ( const QString &  i_preText,
const QString &  i_text,
const QString &  i_postText 
) [static, slot]

Format some text
.

Definition at line 343 of file cmcObject.cpp.

cmcStringList * getStringList ( long  flags = 0) [slot]

Get the String List object
.

This will create a new String List object and return it to the caller.

Parameters:
flagslong ~ Flags for creating the object
  • 0 ~ no flags (default)
  • 1 ~ allow duplicates

Definition at line 1061 of file cmcObject.cpp.

virtual QString guid ( ) [virtual, slot]

Read a GUID
.

Reimplemented in cmcMeInfo.

virtual long index ( ) [virtual, slot]

object index number

This returns the index of the object within the list of objects.

Reimplemented in cmcConnection, and cmcField.

QString instanceID ( ) [virtual, slot]

Object Instance ID
.

Every object created within the Dumont system represents an 'object instance'. This is true of all detail forms registered in Dumont, cursors, rowsets, fields and connections. When an object is destroyed (or closed), the instance memory it occupies is freed back into the system.

Sometimes referring to an object by name can be problemmatic, if there is a second or third object in the system with the same name. Take, for instance, detail forms. When two detail forms are opened on the same category both detail forms will be registered in the form ROT with the same name since the form name is provided by Commence.

If you wish to run an external script and give it reference to a specific form instance you can do so by passing to that program this instanceID value. This value is unique for every object instance. If the form is closed and reopened, then it will receive a new instance ID.

Therefore, this reference object instance ID is a temporary value.

vbScript Example ~ Referring to a form by Instance
 dim dexe: set dexe = createObject("Dumont.EXE")
 dim dfrm: set dfrm = dexe.form(form)
 dexe.launch "C:\Commence\Scripts\FixMyFile.vbs " & dfrm.instanceID
Returns:
string ~ unique instance identifier

Definition at line 845 of file cmcObject.cpp.

QString name ( ) [slot]

Object Name
.

Calling this method is identical to calling the objectName() method. It is provided simply for convenience, and the fact that myObject.name is much easier to remember, and more intuitive, than myObject.objectName().

Reimplemented in cmcApplication, cmcConnection, cmcDatabase, cmcField, cmcForm, and cmcItems.

Definition at line 850 of file cmcObject.cpp.

QString packDate ( const QDate &  date = QDate::currentDate()) [static, slot]

Pack a Date
.

Pack the Date//Time.

This converts a QDateTime value into a packed field with no punctuation. This is intended for TimeDate stamping in category row items, and the punctuation is removed to reduce the possibility of processing errors and to standardize the format across system-wide regional time/date formatting settings.

Return values:
QStringPacked DateTime value
 The format for the field is: 
  YYYYMMDDHHNNSS
  +---+-+-+-+-+-
  |   | | | | |
  |   | | | | +-- seconds (prepend zero)
  |   | | | +---- minute (prepend zero)
  |   | | +------ hour (prepend zero)
  |   | +-------- day of month (prepend zero)
  |   +---------- month (prepend zero)
  +-------------- full (4 digit) year
Parameters:
datedate ~ defaults to currentDate

Definition at line 294 of file cmcObject.cpp.

QString packDateTime ( const QDateTime &  dateTimeIn = QDateTime::currentDateTime()) [static, slot]

Pack a Date Time
.

Definition at line 307 of file cmcObject.cpp.

QString packDateTime ( const QDate &  i_date,
const QTime &  i_time 
) [static, slot]

Pack a Date Time
.

Definition at line 316 of file cmcObject.cpp.

QString packTime ( const QTime &  i_time = QTime::currentTime()) [static, slot]

Pack a Time
.

Definition at line 302 of file cmcObject.cpp.

QString pad ( const QString &  string,
const QString &  padString,
long  length 
) [static, slot]

Pad a string
.

This will pad a string with another string until the result string is the desired length.

Parameters:
stringstring ~ the input string

padStringstring ~ the string to pad with

lengthlong ~ the overall desired length

Definition at line 151 of file cmcObject.cpp.

cmcObject * parent ( )

Return the cmcObject parent pointer
.

This function overrides the base-class QObject::parent() function

Definition at line 763 of file cmcObject.cpp.

bool phoneTooShort ( ) [static, slot]

Tell if the phone was too short
.

Definition at line 427 of file cmcObject.cpp.

QString prepend ( const QString &  prep,
const QString  string,
long  count 
) [static, slot]

Prepend a string to a string
.

Parameters:
prepstring to prepend (this is usually a single character)
stringinput string
countoverall desired length of the return string

Definition at line 186 of file cmcObject.cpp.

QString prependZero ( const QString &  string,
long  count 
) [static, slot]

Add zeros to the beginning of a string
.

Parameters:
stringinput string

countnumber of zeros to prepend

Definition at line 196 of file cmcObject.cpp.

void setAliasName ( const QString &  value) [slot]

Set the object Alias Name
.

See also:
aliasName, Object Alias Names

Definition at line 862 of file cmcObject.cpp.

void setApp ( void *  dispatch,
const QString &  dumontCategory = "Dumont" 
) [virtual]

Set the application pointer
.

This method turns a dispatch pointer into a cmcApplication object and stores it along with the object. This is necessary when wrapping a regular Commence form dispatch pointer, because, normally, we don't get a reference to the application object that the form is running from.

Definition at line 780 of file cmcObject.cpp.

void setApp ( cmcApplication application) [virtual]

Set the application object
.

When a form is instantiated directly from a form script, it does not include information about the active applicaiton. During that form registration process the form wrapper will query the system for its application object, and if it finds one that is registered, it will set the application object using that registered object.

Definition at line 786 of file cmcObject.cpp.

void setComment ( const QString &  value) [virtual, slot]

Set then One-line Comment
.

This sets the comment value for this object. Note that after setting the comment field in order for the comment to be remembered permanently, the scripting program must call cmcApplication.saveDefs in order for the comment to be permanently committed to the database definition.

See also:
ObjectExtensions, comment, description, setDescription, documentation, setDocumentation

Definition at line 876 of file cmcObject.cpp.

void setDescription ( const QString &  value) [virtual, slot]

Set the Multi-line Description
.

When setting the description, you should set the value to something slightly more meaningful than a single one-liner comment, but less then an entire documentation package. Since this field is used in the 'hint' text of the dumont explorer, it should be kept reasonably short.

See also:
ObjectExtensions, description, comment, setComment, documentation, setDocumentation

Definition at line 890 of file cmcObject.cpp.

void setDocumentation ( const QString &  value) [virtual, slot]

Set the One-line Comment
.

See also:
ObjectExtensions, comment, setComment, description, setDescription, documentation

Definition at line 902 of file cmcObject.cpp.

void setGuid ( const QString &  newGuid) [virtual, slot]

Set a GUID
.

Definition at line 922 of file cmcObject.cpp.

void setTemp ( const QString &  key,
const QString &  value 
) [virtual, slot]

Write to a Property
.

Definition at line 989 of file cmcObject.cpp.

QString temp ( const QString &  key) [virtual, slot]

Read a Property
.

Definition at line 983 of file cmcObject.cpp.

long tempCount ( void  ) [virtual, slot]

Return the property Count
.

Definition at line 995 of file cmcObject.cpp.

QString tempKey ( const long  index) [virtual, slot]

Return a property key at index
.

Definition at line 1001 of file cmcObject.cpp.

QString tempValue ( const long  index) [virtual, slot]

Return a property value at index
.

Definition at line 1007 of file cmcObject.cpp.

void trace ( long  flags) [slot]

Set the trace level
.

Definition at line 1029 of file cmcObject.cpp.

long trace ( ) [slot]

Get the trace level
.

Definition at line 1034 of file cmcObject.cpp.

QString unpackDateTime ( const QString &  i_packedDateTime) [static, slot]

Unpack a Date Time
.

Definition at line 326 of file cmcObject.cpp.

QString var ( const QString &  v_var,
const QString &  v_fld,
const QString &  v_val 
) [static, slot]

Set a Var field
.

Set a var value.

This sets a varValue in a long string. The string will be coded with \r\n (vbCrLf) characters seperating each line of varValue. The varValue fields contains the format varName=varValue common in most .ini files.

Definition at line 231 of file cmcObject.cpp.

QString var ( const QString &  v_var,
const QString &  v_fld 
) [static, slot]

Access a Var field
.

Get a var Value.

This pulls a varValue from a long string. The string is assumed to have encoded \r\n (vbCrLf) characters seperating each line of varValue. The varValue fields contains the format varName=varValue common in most .ini files.

Definition at line 210 of file cmcObject.cpp.

QString vbString ( const QString &  i_string) [static, slot]

Make a vbString
.

Definition at line 616 of file cmcObject.cpp.


Member Data Documentation

cmcError err [protected]

Error Element
.

Maintain a local reference to the error element for this object.

Definition at line 1259 of file cmcObject.h.

QPointer<cmcApplication> m_application [private]

Reference the Application object
.

Definition at line 1315 of file cmcObject.h.

cmcActiveViewInfo* m_avi [protected]

Active View Info
.

Reimplemented in cmcForm.

Definition at line 1266 of file cmcObject.h.

QPointer<cmcCdaItem> m_cdaItem [protected]

Reference a CDA item for this object
.

Definition at line 1272 of file cmcObject.h.

QHash<QString,QVariant> m_props [private]

Local Property Store
.

Definition at line 1300 of file cmcObject.h.

QHash<QString,QString> m_temp [private]

Extended Properties store
.

Definition at line 1321 of file cmcObject.h.

long m_traceFlags [private]

Trace Flags
.

Definition at line 1294 of file cmcObject.h.

cmcApplications s_applications [static, private]

Static Applications Pointer
.

Every Commence object has access to the global running object table.

Definition at line 1309 of file cmcObject.h.

bool s_showWarnings [static, private]

Global Flag to Indicate Warnings.

Definition at line 1281 of file cmcObject.h.


Property Documentation

QString aliasName [read, write]

Object Alias Name
.

This property holds the aliasName property.

Definition at line 474 of file cmcObject.h.

QString comment [read, write]

Comment Property
.

This property holds the comment property.

Definition at line 482 of file cmcObject.h.

QString description [read, write]

Description Property
.

Definition at line 488 of file cmcObject.h.

QString documentation [read, write]

Documentation Property
.

Definition at line 494 of file cmcObject.h.

QString guid [read, write]

GUID property
.

Definition at line 500 of file cmcObject.h.

long index [read]

Index property
.

Reimplemented in cmcFieldDef.

Definition at line 506 of file cmcObject.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties




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