mplayout.h

Go to the documentation of this file.

/**
 * \file mplayout.h <mi32/mplayout.h>
 * \brief Definitions for Map & Poster layout
 *
 * \if NODOC
 * $Id: mplayout.h_v 1.37 2005/03/31 16:57:18 fileserver!dwilliss Exp $
 *
 * $Log: mplayout.h_v $
 * Revision 1.37  2005/03/31 16:57:18  fileserver!dwilliss
 * Rename one of our types to MIUNICODE because it conflicted with a Microsoft #define
 *
 * Revision 1.36  2003/09/15 13:49:56  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.35  2003/06/16 22:56:13  dwilliss
 * Added Serlialzer itemdef method
 *
 * Revision 1.34  2003/06/06 22:32:15  dwilliss
 * Changed prototype of MprintPageSetup.
 *
 * Revision 1.33  2003/05/30 22:26:40  ldyas
 * *** empty log message ***
 *
 * Revision 1.32  2003/05/30 22:20:22  ldyas
 * LAYOUTPARMS now has = operator.
 *
 * Revision 1.31  2003/05/28 15:06:38  dwilliss
 * Added ICM profile members
 *
 * Revision 1.30  2003/04/29 15:20:34  dwilliss
 * Ok, ready to commit it now...
 *
 * Revision 1.29  2003/04/29 14:39:59  dwilliss
 * *** empty log message ***
 *
 * Revision 1.28  2003/04/29 14:28:26  dwilliss
 * Added some dither pattern parameters to LAYOUTPARMS
 *
 * Revision 1.27  2002/08/14 22:41:33  dwilliss
 * Paper size is now Unicode
 *
 * Revision 1.26  2000/06/22 21:24:49  sparsons
 * Genitor documentation.
 *
 * Revision 1.25  2000/04/28 21:56:07  mju
 * Use CONTRINFO instead of CONTRiNFO2.
 *
 * Revision 1.24  1999/05/07 21:19:50  mju
 * Header restruct.
 *
 * Revision 1.23  1999/03/17  22:54:06  mju
 * GRE_LAYOUT is now a class.
 *
 * Revision 1.22  1999/02/03  22:48:03  dwilliss
 * Added FullPage flag
 *
 * Revision 1.21  1999/01/05 19:02:03  scowan
 * Swapped multiple keywords
 *
 * Revision 1.20  1998/12/22 20:20:28  mju
 * Add check for X-specific stuff.
 *
 * Revision 1.11  1997/09/29  17:34:19  dwilliss
 * Defined PRSETUP_OldPrint
 *
 * Revision 1.10  1997/09/24  23:04:58  dwilliss
 * Added Zoom to LAYOUTPARMS
 *
 * Revision 1.9  1997/09/16  17:21:18  coffee!dwilliss
 * Increased size of printer and paper size strings
 *
 * Revision 1.8  1997/09/05  17:40:23  dwilliss
 * Added MAPLAYOUT_Landscape flag
 *
 * Revision 1.7  1997/08/07  16:04:59  dwilliss
 * Prototype MprintLayoutSetup
 *
 * Revision 1.4  1997/08/04  16:17:15  dwilliss
 * Added proto for MprintTestStripDialog()
 * Made prototype for MprintPageSetup() more strict if
 * INC_MI32_MDISP_H is defined.  Old code may get proto
 * from dispwind.h anyway.
 *
 * Revision 1.1  1997/05/02  14:35:09  mju
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_MI32_MPLAYOUT_H
#define  INC_MI32_MPLAYOUT_H

#ifndef INC_MI32_CONTRAST_H
   #include <mi32/contrast.h>    //! For Defn of CONTRINFO
#endif

#ifndef INC_MI32_FILEPATH_H
   #include <mi32/filepath.h>
#endif

#ifndef INC_MI32_COLORBAL_H
   #include <mi32/colorbal.h>    //! for defn of CBPARMS
#endif

#ifndef INC_MI32_SERIALIZ_H
   #include <mi32/serializ.h>
#endif

#ifndef INC_MI32_MG2CMS_H
   #include <mi32/mg2cms.h>      //! for defn of PROFILE
#endif

//! Forward declaration

class GRE_LAYOUT;


//----------------------------------------------------------------------------
//!      Structures and constants                                                
//----------------------------------------------------------------------------

//! Hardcopy layout parameters.
struct LAYOUTPARMS {

   LAYOUTPARMS();
   ~LAYOUTPARMS();
   LAYOUTPARMS(const LAYOUTPARMS&);

   LAYOUTPARMS& operator=(const LAYOUTPARMS&);

   static const SERIALIZER::ITEMDEF* GetSerialItemDef();

   //! Read LAYOUTPARMS from Ini file.
   ERRVALUE ReadDefault();

   //! Write LAYOUTPARMS to Ini file.
   ERRVALUE WriteDefault();


   double FullHeight;                  //!< Full height including margins in inches
   double FullWidth;                   //!< Full width including margins in inches
   double FullPrintableHeight;         //!< Full printable height (user selected) in inches
   double FullPrintableWidth;          //!< Full printable width (user selected) in inches
   double PrintableHeight;             //!< Printable height of a single page in inches (fixed)
   double PrintableWidth;              //!< Printable width of a single page in inches (fixed)
   double LeftMargin;                  //!< Unprintable left margin in inches (fixed)
   double TopMargin;                   //!< Unprintable top margin in inches (fixed)
   double Scale;                       //!< eg: 24000 for 1:24000 (Should have been named MapScale)
   double Zoom;                        //!< Zoom factor (normally 1.0)
   double dpi;                         //!< Printer resolution in dots/inch
   INT32  flags;                       //!< misc flags, see below
   char   printer[64];  //!< Name of driver object.  Not localizable.
   MIUNICODE    paper[64];
   char   rpattern[32];
   char   vpattern[32];
   double contrast;
   double brightness;
   CBPARMS  cbparms;                   //!< Color balance parameters
   CONTRINFO   gamma[3];
   double DotGain[4];      //!< Percent (0.0 to 1.0)
   double ScreenAngle[4];  //!< in degrees
   double ScreenFreq;      //!< in LPI. All componants must be same frequency
   MGD::PROFILEPARMS_PRINTER ProfileParms;      
   };

PREVENT_MEMFUNC(LAYOUTPARMS)

#define MAPLAYOUT_SetupDone   (0x00000001)
#define MAPLAYOUT_BogusSizes  (0x00000002)   //! using 8.5 x 11 (No printer selected yet)
#define MAPLAYOUT_PenPlotter  (0x00000004)
#define MAPLAYOUT_UserCBal    (0x00000008)
#define MAPLAYOUT_UserGamma   (0x00000010)
#define MAPLAYOUT_MirrorImage (0x00000020)
#define MAPLAYOUT_CutLine     (0x00000040)
#define MAPLAYOUT_PrintNow    (0x00000080)
#define MAPLAYOUT_TempRast    (0x00000100)
#define MAPLAYOUT_Landscape   (0x00000200)   //! Sizes in LAYOUTPARMS are rotated 90 degrees from actual paper
#define MAPLAYOUT_ScaleToPage (0x00000400)   //! Adjust Zoom to make the layout fit the page
#define MAPLAYOUT_FullPage    (0x00000800)   //! Keep "full page" when modifying paper sizes

//----------------------------------------------------------------------------
//!      Flags for MprintPageSetup                                            
//----------------------------------------------------------------------------

#define PRSETUP_FromRast   0x00000001  //!< For Support / Print From / Print Raster...
#define PRSETUP_PRF        0x00000002  //!< For Support / Print From / Print File...
#define PRSETUP_NoPrint    0x00000004  //!< changes "print" button to "ok"
#define PRSETUP_NoManage   0x00000008  //!< Check settings, but don't popup unless problem
#define PRSETUP_Snapshot   0x00000010  //!< Printing a snapshot
#define PRSETUP_OldPrint   0x80000000  //!< Being called from pre-tntdisp print

//----------------------------------------------------------------------------
//!      Functions and Macros                                                    
//----------------------------------------------------------------------------

struct PRINTERDRIVER;
struct PRINTEROPTIONS;

extern "C" {

//! Read LAYOUTPARMS from Ini file.
int MxReadDefaultLayout (
   LAYOUTPARMS *parms
   );

//! Write LAYOUTPARMS to Ini file.
int MxWriteDefaultLayout (
   LAYOUTPARMS *parms
   );

//!   Print test strip dialog.
//! 
//! Note.  Except for the 3rd parm which changes from a DWWINDOW to an MDISPLAYOUT 
//! The API of this function cannot change until we eliminate printrvc.
//!
//!   This function gets passed to MprintSetup as it's 3rd parameter.  It's assumed
//!   that the 4th parameter to MprintSetup (the HookData) is really an MDISPLAYOUT
//! and that that gets passed to us as our 3rd parameter.
//!
//!   If "parent" is not NULL, then it will create a non-modal dialog for keeping 
//! track of test strip data.  The main form widget for this dialog is returned
//! in *RetWidget.
//!   If parent is NULL, it just looks at the mode parameter and changes the formatting
//!   of its list widget to match the given mode.  
//!
//!   It is also assumed that the CBPARMS and CONTRINFO2 passed to the function
//!   will stay in the same memory location for the life of the dialog (which
//!   is non-modal).  When the user clicks the "add" button on the dialog, it
//!   makes copies of these structures.
//!
//! The cbfunc is called whenever the user selects a line from the list widget
//!   of test settings.  cbfunc will be called and given the CBPARMS and CONTRINFO2
//!   that were saved for that test.  It's up to cbfunc to adjust the color balance
//!   controls to show those settings.
//!
int MprintTestStripDialog (
   Widget parent, 
   Widget *RetWidget, 
   GRE_LAYOUT *layout, 
   CBPARMS *cbal, 
   CONTRINFO *cont, 
   void (*cbfunc)(void *, CBPARMS *, CONTRINFO *), 
   void *cbdata, 
   PRINTERDRIVER *PrinterDriver,
   PRINTEROPTIONS *PrinterParms,
   int mode
   );

//! Print page setup.
int MprintPageSetup (
   Widget parent, 
   GRE_LAYOUT *layout,
   int (*TestStripFunc)(Widget, Widget*, GRE_LAYOUT*, CBPARMS*,CONTRINFO*, 
      void (*func)(void*, CBPARMS*, CONTRINFO*),void*, PRINTERDRIVER *PrinterDriver,
      PRINTEROPTIONS *PrinterParms, int) = 0,  //!< ie, MprintTestStripDialog
   UINT32 flags = 0
   );

//! Print layout setup.
int MprintLayoutSetup (
   Widget parent, 
   GRE_LAYOUT *layout, 
   UINT32 flags
   );

}  // extern "C"

#endif   //!< #ifndef INC_MI32_MPLAYOUT_H

---