CAPS Universe documentation
1.0.4
All you need to know to be successful
|
▼Main Libraries | API description of project widly used libraries |
▼libcapsbase: API description | The CAPS universe big bang |
Function Attributes | Give hints to the compiler and the reader of the code |
Version info | Info for user's code to do the right at while compile-time and run-time |
Message macros | Convenience macros to make use of caps_message_print() |
Base Types | Used everywhere in the CAPS universe |
Base functions | Base API used all over the CAPS universe |
Failure reporting/handling | Failure API used all over the CAPS universe |
Helper functions | Some more or less useful helper/convenience functions |
Command Line Argument Parser | Cascadeable command line argument parser |
▼libcapsppd: API description | 'Postscript Printer Description' file management API |
Version info | Info for user's code to do the right thing |
Base functions | Base API dealing with PPD information |
▼libcapsraster: API description | CAPS universe main raster library |
Version info | Info for user's code to do the right thing |
Base Types | Used in the CAPS universe printer drivers |
Supported MIME types | Get the list of supported MIME types |
Rasterizing engine | How to start the engine and stop it again |
Rasterizer | Rasterizing pages |
Job Related | Query some information about the print job |
Helper functions | Wrappers to avoid some libraries to be used explicitly |
Supported Printing Parameter | Detailed printing control via parameters |
▼libcapsdriver: API description | CAPS universe printer driver convenience library |
Version info | Info for user's code to do the right thing |
Using the Printer Driver Framework from your driver | The startup |
Managing printer driver private data | Set and get some driver private data in your callback functions |
Managing some configuration information | Configuration related helper functions |
Define the printer device capabilities | Printer Device Capabilities helper functions |
Query the printer device and framework status | Printer Device and Framework Status helper functions |
Retrieving information about the job to print | Get the information about the document and how the user wants to print it |
Error handling when printing | Provide more detailed information about failures |
Retrieving information about the current page to print | Get the information how the current page should be printed |
Setting up the rasterizer for the current page | Setup the information the rasterizer requires to rasterize the document page in a way your printer needs it |
Get the full medium rasterized dot data to print | Reading the full medium raster line by line for your own processing |
Get the raw rasterized dot data to print | Reading the raw raster line by line for your own processing |
Some convenience functions | Makes the life easier (sometimes) |
Access to internals | Sometimes there is a need to get our fingers on internal data |
Multi core processing framework | Multithread framework to improve data processing |
▼Helper Libraries | API of project widly internally used helper libraries |
▼libcapstable: API description | A simple variable table management |
Version info | Info for user's code to do the right thing |
How to use libcapstable | An example on how to use it |
Base functions | API description in detail how to manage variable arrays |
▼libcapsinif: API description | Provides a simple config file parser |
Version info | Info for user's code to do the right thing |
Base functions | INI file content management |
▼libcapsmime: API description | MIME type detection |
Base function | Detect some MIME types of printing documents |
▼libcapssi: API description | Implements the features of the capsprndir tool as a library for applications |
Base functions | Retrieve a printer's CAPS Printer Device Parameter Directory |
Error message handling | How to deal with error messages |
Known Printers | Auto-generated list of known printer devices |
Supported Printers | Auto-generated list of supported printer devices |
▼Messages you may face | Various CAPS messages explained |
Developer's programming failures | Programmer's (e.g. internal) failures |
Run-time related errors | |
Run-time related warnings | |
Run-time related information | |
▼Printing Coordinator | Main coordination component of the CAPS universe |
▼Shared Definitions for Clients and Providers | Shared definitions used at the CAPS client and CAPS printing provider side |
Printer State Definitions | Definitions related dealing with printers |
Print Job State Definitions | Definitions related dealing with print jobs |
▼Provider API description | Talk to the printing coordinator from the printing provider/printer driver side |
Version info | Info for user's code to do the right thing |
Printing service provisioning | Register a printing service and define its capabilities |
Printing Provider States | Report printing provider's state |
Handle print jobs | Retrieve job to print or report a printing is done |
▼Client side API description | Talk to the printing coordinator from the client side |
Version info | Info for user's code to do the right thing |
Be part of the whole thing | Connect to the Printing Coordinator |
Deal with printers | Retrieve available printers and their state |
Receive state change notifiers | The Printing Coordinator calls back |
Error message handling | How to deal with error messages |
Print documents | Commit documents to print and monitor their print progression |
Caps_trouble_group |