This is HKGnatsReport.rtf in view mode; [Download] [Up]
Release 1.0 Copyright ©1994 by WSC Investment Services. All Rights Reserved.
Developed by Hutchison Ave. Software <info@hasc.ca>
HKGnatsReport
Inherits From: Object
Declared In: <hk-gnats/HKGnatsReport.h>
Library: libhk-gnats.a
Requires: libhk.a (The HascKit)
Class Description
The HKGnatsReport class is used to add GNATS problem reporting functionality to your application. Using this class is quite simple. All you need to do is instantiate the class: you can do this by calling:
[[HKGnatsReport alloc] init]
Within any object. An alternate useage is to instantiate an HKGnatsReport object within a nib. This object will automatically add a menu item to your application's ``Info'' submenu, titled ``Bug Report.'' Since the HKGnatsReport must access the Application's mainMenu ivar, you must be sure that when you instantiate the HKGnatsReport by hand, you do so after (or when) the Application's delegate has been sent the appDidInit: message. If you elect to place the HKGnatsReport object in a nib, you need not worry about this.
The HKGnatsReport object expects to find a bundle called HKGnatsReport.bundle in your application's main bundle. This bundle contains nib files, and a file called categories, all of which are used by the HKGnatsReport object. The categories file should be the same as what your site is using in its GNATS installation, in the identical format. You may trim the number of categories present if you wish the users of your application to have a reduced number of choices for their bug category selection (ie. some or most of your categories may not apply to users of any particular application).
Once you've made sure you have the bundle inside your "Other Resources" of your project, the "categories" file is correct, and you've instantiated an HKGnatsReport object, you need not do anything else. The HKGnatsReport object is fully self-contained, and was designed to be as low-overhead as possible.
For more information on GNATS, please refer to the GNU documentation.
Instance Variables
id sendPr;
id categoryPop;
id classPop;
id priorityPop;
id severityPop;
id problemText;
id summaryField;
id submitterField;
id organizationField;
id confidentialSwitch;
id reportToField;
id problem;
id possibleFix;
id howToRepeat;
id current;
id controlMatrix;
id panel;
BOOL installedMenu;
id categories;
sendPr The HKSendPr object used for creating and sending the problem report.
categoryPop The PopUpList for bug categories.
classPop The PopUpList for bug class.
priorityPop The PopUpList for bug priority.
severityPop The PopUpList for bug severity.
problemText The HKEmacsText object used for setting problem description, etc.
summaryField The summary.
submitterField The submitter. The HKGnatsReport object will store and access the value for this field from the defaults database. The submitter-id is something assigned to you by your support site.
organizationField Your organization. The HKGnatsReport object will store and access this value from the defaults database, and from your shell environment.
confidentialSwitch The switch used for setting confidential status.
reportToField The email address to send the bug report to. Normally "bugs@somwhere.com". This instance variable will be stored and accessed from the defaults database.
problem An HKString used to store the problem description.
possibleFix An HKString used to store the possible fix.
howToRepeat An HKString used to store the replication details.
current The current string being edited. One of {problem, possibleFix, howToRepeat}.
controlMatrix A matrix used to switch the edited string.
panel The problem report panel.
installedMenu Whether or not the HKGnatsReport object has successfuly installed its menu.
categories An HKDelimitedTable used to read the ``categories'' file.
Method Types
- change:
- clear:
- setCategoryPop:
- setClassPop:
- setOrganizationField:
- setPriorityPop:
- setReportTo:
- setReportToField:
- setSeverityPop:
- setSubmitterField:
- setSubmitterID:
- showPanel:
- submit:
Instance Methods
change:
- change:sender
Changes the edited string.
clear:
- clear:sender
Clears the problem report, summaryField, possibleFix, and howToFix. Redisplays the UI. You don't normally call this yourself: it's called by a button on the bug report panel.
setCategoryPop:
- setCategoryPop:sender
Used when loading the nib to configure the category PopUpList. Don't call this yourself.
setClassPop:
- setClassPop:sender
Used when loading the nib to configure the class PopUpList. Don't call this yourself.
setOrganizationField:
- setOrganizationField:sender
Used when loading the nib to configure the organization Field. Don't call this yourself.
setPriorityPop:
- setPriorityPop:sender
Used when loading the nib to configure the bug priority PopUpList. Don't call this yourself.
setReportTo:
- setReportTo:(const char *)name
You can use this to change the value of the ReportTo field (the email address) of the bug report. The HKGnatsReport will store this value in the defaults database and read it in the next time it's run.
setReportToField:
- setReportToField:sender
Used when loading the nib to configure the reportTo Field. Don't call this yourself.
setSeverityPop:
- setSeverityPop:sender
Used when loading the nib to configure the bug severity PopUpList. Don't call this yourself.
setSubmitterField:
- setSubmitterField:sender
Used when loading the nib to configure the submitter-id Field. Don't call this yourself.
setSubmitterID:
- setSubmitterID:(const char *)name
You can use this to change the value of the SubmitterID field (the support code assigned to you by your support site) of the bug report. The HKGnatsReport will store this value in the defaults database and read it in the next time it's run.
showPanel:
- showPanel:sender
Brings the bug report panel to the front, and makes it key.
submit:
- submit:sender
Attempts to send the bug report. If the report is improperly filled out, a warning panel will come up, and the bug report panel remains after the warning panel is dealt with. If the report is properly filled out, the panel will be dismissed after sending the report by email to the support site. You don't normally call this yourself: it's sent by a button on the bug report panel.
These are the contents of the former NiCE NeXT User Group NeXTSTEP/OpenStep software archive, currently hosted by Netfuture.ch.