prnmks.h File Reference

(r1785/r1346)

#include "lddirect.h"

Go to the source code of this file.

Classes

class  LoadPrintMarks
 A derived class to load the print marks. Uses the winoil class LoadDirect. More...
class  MarkFormat
class  MarkPosition
 An instance of a mark lives in a particular region and not only this, contains a format and a transform. More...
class  PrintMark
 This class contains all the information pertaining to a mark. ie the type of mark it is, its menu text, icon id and a list of all the regions and formatting rules it uses. More...
class  PrintMarkItem
 The PrintMarkItem contains details about this print mark. It holds the mark type, formatting information and a pointer to a subtree of objects which represent the mark. It also contains various bits of information used by Camelots UI to present the mark to the user. More...
class  PageMarkRegion
 Holds the position and orientation of a page mark region. ie the region a page mark will be formatted in. There are current 16 regions around a typical page each having a vertical or horizontal orientation. More...
class  PageMarkRegions
 A simple structure holding the positions of all 16 page mark regions around a typical page. The constructor of this class creates the regions given the bounding rect of a page. More...
class  MarkPosType
class  MarkList
 Holds an array of up to 8 marks formatted into a particular position eg middle centre in a particular region (of which there can be 16 around a page). More...
class  MarkFormatRegion
 The mark formatting region. Given a doc rect ie the position of the region around the page, this class can be used to work out the position of the marks which need to be formatted in this region ie those marks which have been specified by the user to fall into this position. As one adds marks, the formatting region updates itself and keeps track of all mark positions. You can then call the formatting regions render function which will use the positions so generated to render each mark within it. On rendering, each mark will be asked to render itself at a given position. More...
class  PageRect
 Stores a rectangle and thats it. When printing, the print manager adds rectangles to this list. More...
class  PageRectList
 Keeps a list of page rectanges in order to service the crop mark renderer. More...
class  PrintMarksCache
 The print marks cache. This class contains a list of cached printmarks kept by the print marks manager. It is split into its own class here to avoid complications will the mark managers handling of cache marks and document component marks. More...
class  PrintMarksMan
 The 'Print Marks Manager'. This manager handles the installation, formatting and rendering of printer marks. It liaises with the print box to provide a UI to enable and disable print marks. More...

Defines

#define MAXPAGEREGIONS   16
#define MAXREGIONMARKS   8
#define INCH   72000
#define CROPMARK_THICKNESS   425
#define CROPMARK_LENGTH   27360
#define CROPAREA_SIZE   27360
#define OUTSIDEBLEEDWIDTH   0

Enumerations

enum  MarkType {
  MarkType_Unknown = 0, MarkType_Star, MarkType_Registration, MarkType_ColourBar,
  MarkType_GreyBar, MarkType_Information, MarkType_Crop
}
enum  MarkRegion {
  MarkRegion_TopLeft = 0, MarkRegion_Top1, MarkRegion_Top2, MarkRegion_Top3,
  MarkRegion_TopRight, MarkRegion_Right1, MarkRegion_Right2, MarkRegion_Right3,
  MarkRegion_BottomRight, MarkRegion_Bottom3, MarkRegion_Bottom2, MarkRegion_Bottom1,
  MarkRegion_BottomLeft, MarkRegion_Left1, MarkRegion_Left2, MarkRegion_Left3,
  MarkRegion_FileFormatTerminator = 0xff
}
enum  MarkOrient { MO_None = 0, MO_Vertical = 1, MO_Horizontal = 2 }

Variables

const BYTE PRINTMARK_CROPMARKID = 0
const BYTE PRINTMARK_INFOMARKID = 1


Define Documentation

#define CROPAREA_SIZE   27360
 

Definition at line 125 of file prnmks.h.

#define CROPMARK_LENGTH   27360
 

Definition at line 124 of file prnmks.h.

#define CROPMARK_THICKNESS   425
 

Definition at line 123 of file prnmks.h.

#define INCH   72000
 

Definition at line 122 of file prnmks.h.

#define MAXPAGEREGIONS   16
 

Definition at line 120 of file prnmks.h.

#define MAXREGIONMARKS   8
 

Definition at line 121 of file prnmks.h.

#define OUTSIDEBLEEDWIDTH   0
 

Definition at line 126 of file prnmks.h.


Enumeration Type Documentation

enum MarkOrient
 

Enumerator:
MO_None 
MO_Vertical 
MO_Horizontal 

Definition at line 226 of file prnmks.h.

00227 {
00228     MO_None = 0,            // These values are used in the file format - do not change
00229     MO_Vertical = 1,
00230     MO_Horizontal = 2
00231 };

enum MarkRegion
 

Enumerator:
MarkRegion_TopLeft 
MarkRegion_Top1 
MarkRegion_Top2 
MarkRegion_Top3 
MarkRegion_TopRight 
MarkRegion_Right1 
MarkRegion_Right2 
MarkRegion_Right3 
MarkRegion_BottomRight 
MarkRegion_Bottom3 
MarkRegion_Bottom2 
MarkRegion_Bottom1 
MarkRegion_BottomLeft 
MarkRegion_Left1 
MarkRegion_Left2 
MarkRegion_Left3 
MarkRegion_FileFormatTerminator 

Definition at line 170 of file prnmks.h.

00171 {
00172     MarkRegion_TopLeft = 0,     // These values are used in the file format - do not change
00173     MarkRegion_Top1,
00174     MarkRegion_Top2,       
00175     MarkRegion_Top3,       
00176     MarkRegion_TopRight,
00177     MarkRegion_Right1,     
00178     MarkRegion_Right2,     
00179     MarkRegion_Right3,     
00180     MarkRegion_BottomRight,
00181     MarkRegion_Bottom3,    
00182     MarkRegion_Bottom2,    
00183     MarkRegion_Bottom1,    
00184     MarkRegion_BottomLeft,
00185     MarkRegion_Left1,      
00186     MarkRegion_Left2,      
00187     MarkRegion_Left3,
00188 
00189     MarkRegion_FileFormatTerminator = 0xff
00190 };

enum MarkType
 

Enumerator:
MarkType_Unknown 
MarkType_Star 
MarkType_Registration 
MarkType_ColourBar 
MarkType_GreyBar 
MarkType_Information 
MarkType_Crop 

Definition at line 154 of file prnmks.h.

00155 {
00156     MarkType_Unknown = 0,               // A user mark with an unknown ID, (ie no fabby icon)
00157     MarkType_Star,
00158     MarkType_Registration,
00159     MarkType_ColourBar,
00160     MarkType_GreyBar,
00161     MarkType_Information,
00162     MarkType_Crop
00163 };


Variable Documentation

const BYTE PRINTMARK_CROPMARKID = 0
 

Definition at line 273 of file prnmks.h.

const BYTE PRINTMARK_INFOMARKID = 1
 

Definition at line 274 of file prnmks.h.


Generated on Sat Nov 10 03:49:19 2007 for Camelot by  doxygen 1.4.4