printer configuration tool |
modules/Printer.ycp |
Module for printer. | |
|
|
This module has an unstable interface. |
Version of YaST2 printer module for updates handling
Don't run SuSEconfig, don't restart services if true and possible
Shall be printers detected If nil, ask user
List of print queues. See description of map printer for members structure.
Backup list of print queues. See description of map printer for members structure.
Default queue name
Has to be saved all?
Were settings changed?
Were settings read?
Print queue we are currently working with.
- Example
-
$[ "name" : string, //queue name "uri" : string, //printer uri "unique_key" : string, // from libhd -| "ppd" : string // filename of used ppd file, non-raw queues only "ppd_info" : map // chached information about PPD file, non-raw only "options": map, // options from printer db -| "ff" : boolean, // print formfeed between pages, present only for queues with formfeed "raw": boolean, // raw queue, present only for raw queues ]
Index of printer we are working with.
List of printers that were deleted during this configuration session.
List of autodetected printers. For documentation see yast2-lib-printer.
List of unique keys of the printers read at the beginning. We need this because when writting, we must call Write (.probe.status.configured, "unique_key", `yes | `no) It is map of $[ unique_key : true ]. When saving, unique keys that are still configured are replaced by $[ unique_key : false ]
Type of start, true if autodetection
At least one queue has been tested - because of hw proposal
True if autodetection should be skipped
Current mode of configuration `det for configuring from detected printers dialog `adm for configuring from printer administration dialog
Selected item from main connection type dialog
Selected item from 2nd-level connection type dialog
Configuring printer, which is result of detection?
Selected item of the list of detected printers
Driver (backend) for HP all-in-one devices, one of "ptal" and "hp"
Inform user that using different driver may be possible
Test for abort.
- Return value:
-
true if abort was pressed
Add unpresent entries into a map
- Parameters:
-
p map of printer
- Return value:
-
modified map
Autodetect printers.
- Return value:
-
autodetected printers
Select printer to edit or something.
- Parameters:
-
i printer to select. Pass nil if you do not want to select printer, e.g. if printer is going to be added.
Let print queue named name be currently edited. If printer is not found, then queue will be $[] and index -1
- Parameters:
-
name name of the queue to find
Adds a queue to the deleted list
- Parameters:
-
name string queue name printer_type string "printer" or "class"
Set implicit default queue if no queue is set as default
Delete currently selected printer.
Set current printer as default printer
Return list(set) of names that can not be used as printer name. There can be same name for more printers in /etc/printcap. It was impossible to add printer, because all names were invalid because size (union (forbidden_names, new_names)) != size (forbidden_names) + size (new_names).
- Return value:
-
a list of already used names
Assign states to a printer
- Parameters:
-
p a map printer changed boolean true if queue was changed (to assign correct state)
- Return value:
-
a map printer with assigned states
Save currently edited printer.
Export module settings to map.
- Return value:
-
Map of module settings.
Import module settings.
- Parameters:
-
settings module settings
Reset all settings...
Read the CUPS settings.
- Return value:
-
a list of printers
Sorts entries of printcap
Detect spooler currently in use
- Return value:
-
true on success
Check if GhostScript is installed
- Return value:
-
true if is installed
Update configuration if cfg. saved by previous version
- Parameters:
-
read_version integere version written in cfg. file
Check if it is safe, ask user if needed, and detect local printers
- Return value:
-
true on success TODO error checking
Read queues set for spooler
- Return value:
-
a list of queues
Read the contents of /var/lib/YaST2/printers
- Return value:
-
true on success TODO error handling
Set unique keys after configuration reading
Old read function, called from new Read function TODO: better integrate TODO: error handling
- Return value:
-
true on success
Read settings from disk or where.
- Return value:
-
success?
deletes printers
- Parameters:
-
printer map of printer to delete (with keys name and type containing "printer" or "class"
- Return value:
-
success state
Delete printers marked for being deleted
- Return value:
-
true on success
Save queue
- Parameters:
-
queue map
- Return value:
-
sucefully save
Save all queues
- Return value:
-
true on success
Save default queue to appropriate location
- Return value:
-
true on success
Write /var/lib/yast2/printers
- Return value:
-
true if successful
Write settings.
- Return value:
-
success state
separates from config map only values of specified type
- Parameters:
-
config Map of configuration type String specifying type
- Return value:
-
of selected values
Creates summary from autodetected printers and printcap.
- Parameters:
-
style type of summary - list of symbols - flags: `test: add test link
`nonew: do not include new -- unconfigured printers into summary
`short: short summary doesn't contain queue description `state: show printer state
- Return value:
-
summary string
get list of names of deleted printers.
- Return value:
-
List of names.
Get type of currently selected printer. Just a shortcut to Printerlib::getUriType (...)
- Return value:
-
printer type
TODO: create test case
- Parameters:
-
name printer name uri string queue uri vendor_name string name of the printer vendor (now unused) device_name string name of the printer device forbidden_names list of forbidden names
- Return value:
-
new queue name
generate class name
- Parameters:
-
forbidden_names list of forbidden names
- Return value:
-
new class name
Prepare detected printer to be configured.
- Parameters:
-
det map of detected printer
Has the printer been already configured?
- Parameters:
-
uk unique key of the printer
- Return value:
-
true or false
Autoconfigure all printers that haven't been configured yet.
Check if queue name is OK. Otherwise adds number at the end.
- Parameters:
-
name printer name forbidden_names forbidden names
- Return value:
-
new queue name.
Get the suffix for the queue name.
- Parameters:
-
queues list of new queues. Keys are the names of the queues.
- Return value:
-
suffix