Scripts

sReportError(const QString &);

This slot writes a debugging message. See Script Debugging below.

sTick();

This slot is typically used internally by the application and should rarely be used in scripts. It checks the connection to the database server and updates the user's event notification icon.

sChecksUpdated(int, int, bool);

This slot tells other open windows that this script has updated the definition or status of one or more bank Checks.

sAssortmentsUpdated(int, bool);

This slot tells other open windows that this script has updated the definition or status of one or more Assortments.

sBBOMsUpdated(int, bool);

This slot tells other open windows that this script has updated the definition or status of one or more Breeder Bills of Materials.

sBOMsUpdated(int, bool);

This slot tells other open windows that this script has updated the definition or status of one or more Bills of Materials.

sBOOsUpdated(int, bool);

This slot tells other open windows that this script has updated the definition or status of one or more Bills of Operations.

sBudgetsUpdated(int, bool);

This slot tells other open windows that this script has updated the definition or status of one or more Budgets.

sBankAdjustmentsUpdated(int, bool);

This slot tells other open windows that this script has updated the definition or status of one or more Bank Adjustments.

sBillingSelectionUpdated(int, int);

This slot tells other open windows that this script has updated the definition or status of one or more Billing Selections.

sCashReceiptsUpdated(int, bool);

This slot tells other open windows that this script has updated the definition or status of one or more Cash Receipts.

sConfigureGLUpdated();

This slot tells other open windows that this script has updated the General Ledger configuration.

sCreditMemosUpdated();

This slot tells other open windows that this script has updated the definition or status of one or more Credit Memos.

sCrmAccountsUpdated(int);

This slot tells other open windows that this script has updated the definition or status of one or more CRM Accounts.

sCustomCommand();

This slot tells other open windows that this script has updated the definition or status of one or more Custom Commands.

sCustomersUpdated(int, bool);

This slot tells other open windows that this script has updated the definition or status of one or more Customers.

sGlSeriesUpdated();

Use this slot to tell other windows in the application that this script has updated the definition or status of one or more General Ledger Series.

sInvoicesUpdated(int, bool);

This slot tells other open windows that this script has updated the definition or status of one or more Invoices.

sItemGroupsUpdated(int, bool);

This slot tells other open windows that this script has updated the definition or status of one or more Item Groups.

sItemsUpdated(int, bool);

This slot tells other open windows that this script has updated the definition or status of one or more Items.

sItemsitesUpdated();

This slot tells other open windows that this script has updated the definition or status of one or more Item Sites.

sPaymentsUpdated(int, int, bool);

This slot tells other open windows that this script has updated the definition or status of one or more Payments.

sProjectsUpdated(int);

This slot tells other open windows that this script has updated the definition or status of one or more Projects.

sProspectsUpdated();

This slot tells other open windows that this script has updated the definition or status of one or more Prospects.

sPurchaseOrderReceiptsUpdated();

This slot tells other open windows that this script has updated the list of Receipts.

sPurchaseOrdersUpdated(int, bool);

This slot tells other open windows that this script has updated the definition or status of one or more Purchase Orders.

sPurchaseRequestsUpdated();

This slot tells other open windows that this script has updated the definition or status of one or more Purchase Requests.

sQOHChanged(int, bool);

This slot tells other open windows that this script has updated the Quantity on Hand of some Item Site.

sQuotesUpdated(int);

This slot tells other open windows that this script has updated the definition or status of one or more Quotes.

sReportsChanged(int, bool);

This slot tells other open windows that this script has updated the definition or status of one or more Reports.

sReturnAuthorizationsUpdated();

This slot tells other open windows that this script has updated the definition or status of one or more Return Authorizations.

sSalesOrdersUpdated(int);

This slot tells other open windows that this script has updated the definition or status of one or more Sales Orders.

sStandardPeriodsUpdated();

This slot tells other open windows that this script has updated the definition or status of one or more Standard Periods.

sTaxAuthsUpdated(int);

This slot tells other open windows that this script has updated the definition or status of one or more Tax Authorities.

sTransferOrdersUpdated(int);

This slot tells other open windows that this script has updated the definition or status of one or more Transfer Orders.

sVendorsUpdated();

This slot tells other open windows that this script has updated the definition or status of one or more Vendors.

sVouchersUpdated();

This slot tells other open windows that this script has updated the definition or status of one or more Vouchers.

sWarehousesUpdated();

This slot tells other open windows that this script has updated the definition or status of one or more Sites or Warehouses.

sWorkCentersUpdated();

This slot tells other open windows that this script has updated the definition or status of one or more work centers.

sWorkOrderMaterialsUpdated(int, int, bool);

This slot tells other open windows that this script has updated the definition or status of work order materials.

sWorkOrderOperationsUpdated(int, int, bool);

This slot tells other open windows that this script has updated the definition or status of one or more work order operations.

sWorkOrdersUpdated(int, bool);

This slot tells other open windows that this script has updated the definition or status of one or more work orders.

sIdleTimeout();

This slot should rarely or never be called by a script. It is used by the application to inform the user that s/he has been idle for a long time and asks if the user wants to exit the application.

sFocusChanged(QWidget* old, QWidget* now);

This slot should rarely or never be called by a script. It indicates to the application that the user's focus has changed from one window to another.

tick();

This signal is emitted on a regular basis, usually every minute or so. Scripts that want to repeat an action at a regular interval can connect to this signal. This is often used by Automatically Update check boxes.

checksUpdated(int, int, bool);

assortmentsUpdated(int, bool);

bankAdjustmentsUpdated(int, bool);

bbomsUpdated(int, bool);

billingSelectionUpdated(int, int);

bomsUpdated(int, bool);

boosUpdated(int, bool);

budgetsUpdated(int, bool);

cashReceiptsUpdated(int, bool);

configureGLUpdated();

creditMemosUpdated();

crmAccountsUpdated(int);

customersUpdated(int, bool);

glSeriesUpdated();

invoicesUpdated(int, bool);

itemGroupsUpdated(int, bool);

itemsUpdated(int, bool);

itemsitesUpdated();

paymentsUpdated(int, int, bool);

projectsUpdated(int);

prospectsUpdated();

purchaseOrderReceiptsUpdated();

purchaseOrdersUpdated(int, bool);

purchaseRequestsUpdated();

qohChanged(int, bool);

quotesUpdated(int, bool);

reportsChanged(int, bool);

returnAuthorizationsUpdated();

salesOrdersUpdated(int, bool);

standardPeriodsUpdated();

taxAuthsUpdated(int);

transferOrdersUpdated(int);

vendorsUpdated();

vouchersUpdated();

warehousesUpdated();

workCentersUpdated();

workOrderMaterialsUpdated(int, int, bool);

workOrderOperationsUpdated(int, int, bool);

workOrdersUpdated(int, bool);

QObject * executeQuery(const QString & query);

This method takes a SQL statement, executes the it against the database server, and returns that query as a ScriptQuery object.

QObject * widgetGetLayout(QWidget * w);

If you have a widget that you have added to a form or that you have retreived from a form, this method gives you the layout object that contains that widget. Then you can use one of the methods below to place another widget on the window near a widget you choose.

void layoutBoxInsertWidget(QObject *, int index, QWidget *, int stretch = 0, int alignment = 0);

These let you add new widgets to an existing form so that they are positioned appropriately and respond properly to window size changes.

void layoutGridAddWidget(QObject *, QWidget *, int row, int column, int alignment = 0);

void layoutGridAddWidget(QObject *, QWidget *, int fromRow, int fromColumn, int rowSpan, int columnSpan, int alignment = 0);

void layoutStackedInsertWidget(QObject *, int index, QWidget *);

QObject * menuAddAction(QObject * menu, const QString & text);

This lets you add an item to a menu with a particular name. The returned object is the action that will be taken when the user selects this new menu item. The script must populate the properties of this action to ensure the desired result.

QObject * menuAddMenu(QObject * menu, const QString & text, const QString & name = QString());

This lets you add a submenu to an existing menu.

QWidget * tabWidget(QWidget * tab, int idx);

This method lets you retrieve a particular tab from a tab widget. The idx is the integer associated with the desired tab.

int tabInsertTab(QWidget * tab, int idx, QWidget * page, const QString & text);

This method lets you add a new tab to an existing tab widget in position idx.

void tabRemoveTab(QWidget * tab, int idx);

This method lets you remove a tab from an existing tab widget.

void tabSetTabText(QWidget * tab, int idx, const QString & text);

This method lets you change the label of a particular tab in a tab widget.

QString tabtabText(QWidget * tab, int idx);

This method lets you retrieve the label of a particular tab in a tab widget.

QWidget * createWidget(const QString & className, QWidget * parent = 0, const QString & name = QString());

This method lets you create a new widget. The first parameter is the name of the desired widget's class (e.g. QSpinBox or ContactCluster. The second parameter is the window or dialog that should take responsibility for destroying the widget (usually this). The third parameter is the name of the widget (this is not the label visible to the user, but rather a string that can be used later to find the widget again if the QWidget* variable gets lost).

QObject * createLayout(const QString & className, QWidget * parent, const QString & name = QString());

This method lets you create a new layout. The first parameter is the name of the desired layout's class (e.g. QGridLayout or QHBoxLayout). The second parameter is the widget that layout is to be applied. The third parameter is the name of the layout (this is not the label visible to the user, but rather a string that can be used later to find the widget again if the QObject* variable gets lost).

QWidget * loadUi(const QString & screenName, QWidget * parent = 0);

This method lets you load a UI file from the database. The first parameter is the name of the screen as you have specified it in the Screen window of the application. The second parameter is the window or dialog that should take responsibility for destroying the widget (usually this).

QWidget * lastWindow() const;

This method opens a new window using a user defined screen and script.  pname is the name of the screen, parent is the caller (usually mywindow),  modality determines whether the window opens in a modal state. 

Note: Opening core C++ windows using script and passing parameters is not supported at this time.

bool printReport(const QString & name, const ParameterList  & params);

This takes a report name and a set of parameter name/value pairs and causes the named report to print.

Opens a file dialog window from the parent with a caption of caption, a starting directory of dir a file type filter of filter in selection mode fileModeSel and returns a file path.

fileModeSel enumerators are:

• 1 = Existing File
• 2 = Directory
• 3 = Directory Only
• 4 = Existing Files
• 5 = Any File

Opens the given url in the appropriate Web browser for the user's desktop environment, and returns true if successful; otherwise returns false.

If the URL is a reference to a local file (i.e., the URL scheme is "file") then it will be opened with a suitable application instead of a Web browser.

If a mailto URL is specified, the user's e-mail client will be used to open a composer window containing the options specified in the URL, similar to the way mailto links are handled by a Web browser.

Copies the file fileName to newName. Returns true if successful; otherwise returns false.

If a file with the name newName already exists, copyFile() returns false (i.e., the script will not overwrite it).

Renames the file oldName to newName. Returns true if successful; otherwise returns false.

If a file with the name newName already exists, renameFile() returns false (i.e., script will not overwrite it).

Removes the file specified by name. Returns true if successful; otherwise returns false.

The file is closed before it is removed.

Returns the absolute path of the user's home directory.

Under Windows this function will return the directory of the current user's profile. Typically, this is:

 C:/Documents and Settings/Username

Use the toNativeSeparators() function to convert the separators to the ones that are appropriate for the underlying operating system.

If the directory of the current user's profile does not exist or cannot be retrieved, the following alternatives will be checked (in the given order) until an existing and available path is found:

1. The path specified by the USERPROFILE environment variable.
2. The path formed by concatenating the HOMEDRIVE and HOMEPATH environment variables.
3. The path specified by the HOME environment variable.
4. The path returned by the rootPath() function (which uses the SystemDrive environment variable)
5. The C:/ directory.

Under non-Windows operating systems the HOME environment variable is used if it exists, otherwise the path returned by the rootPath() function is used.

Creates the directory path mkPath in the directory rootPath.

The function will create all parent directories necessary to create the directory.

Returns true if successful; otherwise returns false.

Removes the directory path rmPath from the rootPath.

The function will remove all parent directories in rmPath, provided that they are empty. This is the opposite of makepath(mkPath, rootPath).

Returns true if successful; otherwise returns false.

Returns the absolute path of the root directory.

For Unix operating systems this returns "/". For Windows file systems this normally returns "c:/".

int messageBox(const QString & type, QWidget * parent, const QString & title, const QString & text, int buttons = 0x00000400, int defaultButton = 0x00000000);

This is a convenience function to create a message dialog. The first parameter is either "critical", "information", "question", or "warning" and controls the icon that will appear in the dialog. The second parameter is the parent window (usuallythis) and controls where the dialog box will appear. The third parameter lets the script set the title bar of the message dialog, while the fourth parameter sets the main content text displayed inside the dialog. The buttons and defaultButton parameters are describe further in the QMessageBox documentation; in general they let you choose from among a set of pre-defined buttons to display and select which one is the default button. This method returns the value of the button which the user clicked.

bool coreDisconnect(QObject * sender, const QString & signal, QObject * receiver, const QString method);

Disconnects a signal/slot connection made in the core.  Usually used when there is a desire to over-ride existing core behavior with new behavior defined by a script, such as replacing a standard query function with a new one.

XSqlQuery query()

Get the XSqlQuery object from the ScriptQuery. XSqlQuery is an xTuple subclass of Qt's QSqlQuery class, so anything you can script with a QSqlQuery can be scripted with the value returned by query().

void setQuery(XSqlQuery query)

If you have an XSqlQuery object, perhaps from a prior call to query(), you can assign it to a ScriptQuery variable.

bool isActive()

These are wrappers around QSqlQuery object methods and are provided here to make it easy to use them. Consult the QSqlQuery documentation for more information.

bool isValid()

bool isForwardOnly()

bool isSelect()

bool first()

The script should call this when it needs to read the first result row from an executed query.

bool last()

The script should call this when it wants to skip over the intervening results and look at the last row returned by an executed query.

bool next()

The script should call this when it wants to retrieve the next available row from an executed query's result set. If the query has just been executed and first() has not yet been called, next() returns the first result row.

bool previous()

The script should call this if it needs to look backwards through the query result set.

int size()

This method returns the approximate number of rows in the query result set.

int numRowsAffected()

This returns the (approximate) number of rows modified by a query containing an update statement, removed by a query containing a delete statement, or added by a query containing an insert statement.

QScriptValue value(int)

Once the script has executed a query and positioned itself on a particular row (using first(), last(), next(), or previous()) you usevalue() to read the contents of a particular column. You can either refer to the column by its position in the select statement by passing an integer to value() or by its name in the query using the QString version of value().

QScriptValue value(const QString)

QVariantMap lastError()

You can learn about errors executing queries by looking at the lastError(). You can ask for the databaseText, driverText, text, number, type, and validity of the error. See the Sample Scripts for examples of how lastError() can be used.