hdi::core::Document::Preset Class Reference

Represents options when creating a new Illustrator document. More...

#include <hdicoreDocument.h>

Collaboration diagram for hdi::core::Document::Preset:

Public Types
enum	PreviewMode { PreviewModeDefault = 10 , PreviewModePixel = 20 , PreviewModeOverprint = 30 }
	Controls the preview mode of a new document.
enum	TransparencyGrid {   TransparencyGridNone = 0 , TransparencyGridLightGray = 10 , TransparencyGridGray = 20 , TransparencyGridDarkGray = 30 ,   TransparencyGridRed = 40 , TransparencyGridOrange = 50 , TransparencyGridGreen = 60 , TransparencyGridBlue = 70 ,   TransparencyGridPurple = 80 }
	Controls the transparency grid color of a new document.
enum	RasterResolution { RasterResolutionScreen = 10 , RasterResolutionMedium = 20 , RasterResolutionHigh = 30 }
	Controls the raster resolution of a new document.
enum	ArtboardLayout {   ArtboardLayoutColumn = 10 , ArtboardLayoutRowLR = 20 , ArtboardLayoutRowRL = 30 , ArtboardLayoutGridByRowLR = 40 ,   ArtboardLayoutGridByColumnLR = 50 , ArtboardLayoutGridByRowRL = 60 , ArtboardLayoutGridByColumnRL = 70 }
	Controls how artboards are placed when creating a new document. More...

Public Member Functions
	Preset ()
	Constructs a new Preset object with default values.
virtual	~Preset ()
	Destructs a Preset object.

Public Attributes
std::string	title
	UTF-8 title of the document. Empty ("") will result in a title like "Untitled-1", etc.
Size	size
	Width and height of the document artboard.
uint32_t	artboardCount
	Number of artboards in the document. Cannot exceed maxArtboardCount.
ArtboardLayout	artboardLayout
	Controls how the artboards are placed.
double	artboardSpacing
	How many points each artboard should be spaced from its neighbor.
uint32_t	artboardRowOrColumnSize
	How many artboards should appear in each row or column before wrapping occurs.
DocumentColorModel	colorModel
	Controls the color model of the document.
RulerUnits	rulerUnits
	Controls the ruler units of the document.
PreviewMode	previewMode
	Controls the preview mode of the document.
TransparencyGrid	transparencyGrid
	Controls the transparency grid color of the document.
RasterResolution	rasterResolution
	Controls the raster resolution of the document.

Static Public Attributes
static const uint32_t	maxArtboardCount = 1000
	Maximum number of artboards that Illustrator documents will support.

Detailed Description

Represents options when creating a new Illustrator document.

Member Enumeration Documentation

ArtboardLayout

enum hdi::core::Document::Preset::ArtboardLayout

Controls how artboards are placed when creating a new document.

Note

Items that end in "LR" are placed from left-to-right; items ending in "RL" are placed from right-to-left

Constructor & Destructor Documentation

Preset()

hdi::core::Document::Preset::Preset

(

)

Constructs a new Preset object with default values.

Author

GW

Date

08/2013

~Preset()

virtual hdi::core::Document::Preset::~Preset ( )

virtual

Destructs a Preset object.

Author

GW

Date

08/2013

Member Data Documentation

artboardRowOrColumnSize

uint32_t hdi::core::Document::Preset::artboardRowOrColumnSize

How many artboards should appear in each row or column before wrapping occurs.

Note

When artboardLayout is ArtboardLayoutGridByRowLR, ArtboardLayoutGridByColumnLR, ArtboardLayoutGridByRowRL, or ArtboardLayoutGridByColumnRL then the valid range is [1,artboardCount-1]. If the value specified is out of this range, then the default value of sqrt(artboardCount) is used instead.

When artboardLayout is ArtboardLayoutColumn, ArtboardLayoutRowLR, or ArtboardLayoutRowRL then the value is ignored and taken as 1