Class definition file: wpprint.idl
Class hierarchy SOMObject
WPObject
WPAbstract
WPPrinter
Description
This is the printer object class. An instance of this class can be created as a Workplace object. An instance of this class is created initially by the system in its template form. It has the title "Printer" and resides in the "Templates" folder. Instances of this class are also created initially by the system for each print configured. Each instance has a title corresponding to the description of the configured queue and printer and resides on the desktop.
Instance methods
The following list shows all the WPPrinter methods:
SOMObject instance methods
The following list shows all the instance methods overridden by the WPObject class. These instance methods are overridden in order to modify the behavior defined by an ancestor class.
WPObject instance methods
The following list shows all the methods overridden by the WPPrinter class. These methods are overridden in order to modify the behavior defined by an ancestor class.
wpSetup override by WPPrint
The following table shows the keyname-value pairs added by the WPPrint class.
┌─────────────────────────┬─────────────┬───────────────────────────┐│KEYNAME │VALUE │DESCRIPTION │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │APPDEFAULT │YES │This printer object is to │ │ │ │become the application's │ │ │ │default printer object for │ │ │ │printing. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │ │NO │This printer object is not │ │ │ │to become the application's│ │ │ │default printer object for │ │ │ │printing. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │DEFAULTVIEW │DETAILS │Default open view for this │ │ │ │printer object is in │ │ │ │details view. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │ │ICON │Default open view for this │ │ │ │printer object is in icon │ │ │ │view. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │JOBDIALOGBEFOREPRINT │YES │The job properties dialog │ │ │ │is displayed before │ │ │ │printing. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │ │NO │The job properties dialog │ │ │ │is not displayed before │ │ │ │printing. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │JOBPROPERTIES │filename │The complete path to a │ │ │ │binary file containing the │ │ │ │default job properties for │ │ │ │this printer object. This │ │ │ │file can be created by │ │ │ │saving the │ │ │ │PRQINFO3->pDriverData data │ │ │ │to a file; this data can be│ │ │ │obtained by using the │ │ │ │SplQueryQueue API of the │ │ │ │spooler. │ │ │ │For more information about │ │ │ │spooler functions, see the │ │ │ │Presentation Manager │ │ │ │Programming Reference. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │OUTPUTTOFILE │YES │The output of this printer │ │ │ │object goes to a file. The│ │ │ │user will be prompted for a│ │ │ │file name each time a print│ │ │ │job is submitted to this │ │ │ │printer object. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │ │NO │The output of this printer │ │ │ │object does not go to a │ │ │ │file. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │PORTNAME │portname │The names of already │ │ │ │installed ports to which │ │ │ │this printer object is to │ │ │ │be attached. In the case │ │ │ │of more than one port, │ │ │ │specify a comma-separated │ │ │ │list. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │PRINTDRIVER │driver.device│The complete name of the │ │ │ │print-driver that this │ │ │ │printer object is to use. │ │ │ │For example: 'IBM42XX.IBM │ │ │ │420 Proprinter III' │ │ │ │In the case of more than │ │ │ │one print driver, specify a│ │ │ │comma-separated list. │ │ │ │These printer drivers must │ │ │ │already be installed. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │PRINTERSPECIFICFORMAT │YES │The printer object spools │ │ │ │print jobs in PM_Q_RAW │ │ │ │format. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │ │NO │The printer object spools │ │ │ │print jobs in PM_Q_STANDARD│ │ │ │format. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │PRINTWHILESPOOLING │YES │The printing is enabled │ │ │ │while the job is spooling. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │ │NO │The printing is disabled │ │ │ │while the job is spooling. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │PRIORITY │priority │This sets the priority of │ │ │number (0-9) │the print queue associated │ │ │ │with the printer object. │ │ │ │All print jobs that are │ │ │ │submitted to the printer │ │ │ │object will inherit a job │ │ │ │priority derived from the │ │ │ │print queue's priority. │ │ │ │Zero is the highest │ │ │ │priority and 9 is the │ │ │ │lowest priority. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │QSTARTTIME │time │The time when the printer │ │ │ │object starts printing. │ │ │ │The time format is HH:MM, │ │ │ │and the base is a 24-hour │ │ │ │clock. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │QSTOPTIME │time │The time when the printer │ │ │ │object is to stop printing.│ │ │ │The time format is HH:MM, │ │ │ │and the base is a 24-hour │ │ │ │clock. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │QUEUENAME │name │The local queue name for │ │ │ │the printer object. If a │ │ │ │queue name is not │ │ │ │specified, one is created │ │ │ │by the printer object. │ │ │ │The QUEUENAME key will be │ │ │ │ignored if this object has │ │ │ │already been assigned a │ │ │ │queue. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │QUEUEPARMS │qparm │This sets the queue │ │ │ │parameters, and can be any │ │ │ │text string. Queue │ │ │ │parameters are specific │ │ │ │instructions that are read │ │ │ │and used by OS/2 print │ │ │ │drivers, OS/2 queue │ │ │ │drivers, and the OS/2 │ │ │ │spooler. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │QUEUEDRIVER │qdrvname │The queue driver name. The │ │ │ │queue driver must already │ │ │ │be installed. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │SEPARATORFILE │filename │A separator file that │ │ │ │prints before each print │ │ │ │job. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │SYNCJOBPROP │YES │This specifies that the │ │ │ │default job properties of │ │ │ │the printer object are to │ │ │ │be synchronized with the │ │ │ │network's printer job │ │ │ │properties. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │ │NO │This specifies that the │ │ │ │default job properties will│ │ │ │not be synchronized. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │SYNCPRINTERPROP │YES │This specifies that the │ │ │ │printer properties of the │ │ │ │printer object are to be │ │ │ │synchronized with the │ │ │ │network's printer job │ │ │ │properties. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │ │NO │This specifies that the │ │ │ │printer properties will not│ │ │ │be synchronized. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │TAKEDEFAULTS │YES │This specifies that the │ │ │ │printer object takes the │ │ │ │default values when it is │ │ │ │created. │ ├─────────────────────────┼─────────────┼───────────────────────────┤ │ │NO │This specifies that the │ │ │ │printer object does not │ │ │ │take default values when it│ │ │ │is created. This will │ │ │ │cause the "Create a │ │ │ │printer" dialog to be │ │ │ │displayed. │ └─────────────────────────┴─────────────┴───────────────────────────┘
Class methods
There are currently no class methods defined for the WPPrinter Workplace class object.
WPObject class methods
The following list shows all the class methods overridden by the WPPrinter class. These methods are overridden to modify the behavior defined by an ancestor class.