Mapper  0.9.0
API documentation
Public Types | Public Member Functions | Public Attributes | List of all members
OpenOrienteering::MapPrinterOptions Class Reference

MapPrinterOptions control how the map is rendered. More...

#include <map_printer.h>

Public Types

enum  MapPrinterMode { Vector, Raster, Separations }
 Basic modes of printing. More...
 
enum  ColorMode { DefaultColorMode, DeviceCmyk }
 Color modes. More...
 

Public Member Functions

 MapPrinterOptions (unsigned int scale, int resolution=600, MapPrinterMode mode=Vector)
 Constructs new printer options. More...
 

Public Attributes

unsigned int scale
 The scale to be used for printing. More...
 
int resolution
 The nominal resolution to be used. More...
 
MapPrinterMode mode
 The mode of printing. More...
 
ColorMode color_mode
 The color mode. More...
 
bool show_templates
 Controls if templates get printed. More...
 
bool show_grid
 Controls if the configured grid is printed. More...
 
bool simulate_overprinting
 Controls if the desktop printing is to simulate spot color printing. More...
 

Detailed Description

MapPrinterOptions control how the map is rendered.

Member Enumeration Documentation

◆ ColorMode

Color modes.

At the moment, only PDF supports a different mode than the default.

Enumerator
DefaultColorMode 

Use the target engine's default color mode.

DeviceCmyk 

Use device-dependent CMYK for vector data.

◆ MapPrinterMode

Basic modes of printing.

Enumerator
Vector 

Print in vector graphics mode.

Raster 

Print in raster graphics mode.

Separations 

Print spot color separations (b/w vector)

Constructor & Destructor Documentation

◆ MapPrinterOptions()

OpenOrienteering::MapPrinterOptions::MapPrinterOptions ( unsigned int  scale,
int  resolution = 600,
MapPrinterMode  mode = Vector 
)

Constructs new printer options.

The scale, the mode and the resolution are initialized to the given values, all boolean properties are initialized to false.

Member Data Documentation

◆ color_mode

ColorMode OpenOrienteering::MapPrinterOptions::color_mode

The color mode.

◆ mode

MapPrinterMode OpenOrienteering::MapPrinterOptions::mode

The mode of printing.

Note that other printing options may be available only in particular modes.

◆ resolution

int OpenOrienteering::MapPrinterOptions::resolution

The nominal resolution to be used.

◆ scale

unsigned int OpenOrienteering::MapPrinterOptions::scale

The scale to be used for printing.

◆ show_grid

bool OpenOrienteering::MapPrinterOptions::show_grid

Controls if the configured grid is printed.

Not available in MapPrinterOptions::Separations mode.

◆ show_templates

bool OpenOrienteering::MapPrinterOptions::show_templates

Controls if templates get printed.

Not available in MapPrinterOptions::Separations mode.

◆ simulate_overprinting

bool OpenOrienteering::MapPrinterOptions::simulate_overprinting

Controls if the desktop printing is to simulate spot color printing.

Only available in MapPrinterOptions::Raster mode.


The documentation for this class was generated from the following files: