Coyote Graphics Routines

Date: Fri Mar 27 12:14:20 2015

single page | use frames     summary     class     fields     routine details     file attributes

.\

cgps_config.pro


top cgPS_Config

Utilities, Graphics

result = cgPS_Config( [psObject] [, /AvantGarde] [, Bits_per_Pixel=integer] [, /Bold] [, /BookStyle] [, /Bkman] [, /Cancel] [, /CMYK] [, /Color] [, /Courier] [, /Debug] [, /Decomposed] [, DefaultSetup=structure] [, /Demi] [, Directory=string] [, /Encapsulated] [, European=European] [, Filename=string] [, /FontInfo] [, FontSize=integer], Font_Size=Font_Size [, FontType=integer] [, Group_Leader=long] [, /Helvetica] [, /Inches] [, /Italic] [, /Isolatin] [, /Landscape] [, Language_Level=integer] [, /Light] [, /Match] [, /Medium] [, /Metric] [, Name=string] [, /Narrow] [, /NoGUI] [, /Oblique] [, PageType=string] [, /Palatino], Portrait=Portrait [, Preview=integer] [, /Schoolbook] [, Set_Font=string] [, /Symbol] [, /Times] [, /TrueType] [, /TT_Font] [, XOffset=float] [, XSize=float] [, YOffset=float] [, YSize=float] [, /ZapfChancery] [, /ZapfDingbats])

The purpose of this program is to allow the user to configure the PostScript device with or without a graphical user interface. This function is essentially a simplified wrapper to the FSC_PSConfig object, which provides a powerful graphical user interface for configuring the IDL PostScript device.

Return value

A structure of keywords, appropriate for configuring the PostScript device, is returned. These keywords are generally passed to the PostScript device by means of keyword inheritance:

keywords = cgPS_Config() ; Obtain PostScript keywords Set_Plot, 'PS' ; Select the PostScript device Device, _Extra=keywords ; Configure the PostScript device with keywords

Parameters

psObject in optional type=object

An FSC_PSCONFIG object reference of the sort returned by this function can be passed as an argument to the function. It is up to the user to destroy the object if passed as an argument. Passing an object argument essentially by-passes the rest of the keywords and the GUI will take its initial values from the values in the input object. This allows the programmer to keep track of how the user last configured the GUI and to set it up in exactly the same way the next time the GUI is invoked.

Keywords

AvantGarde in optional type=boolean default=0

Set this keyword to select the AvantGarde PostScript font.

Bits_per_Pixel in optional type=integer default=8

The number of image bits saved for each image pixel: 2, 4, or 8.

Bold in optional type=boolean default=0

Set this keyword to select a bold PostScript font.

BookStyle in optional type=boolean default=0

Set this keyword to specify that the book version of the current PostScript font should be used.

Bkman in optional type=boolean default=0

Set this keyword to select the Bookman PostScript font.

Cancel out optional type=boolean default=0

If this keyword is set to 1, the user hit the Cancel button in the GUI.

CMYK in optional type=boolean default=0

Set this keyword to use CMYK colors instead of RGB colors in the output.

Color in optional type=boolean default=1

Set this keyword to 1 to select color or gray-scale output.

Courier in optional type=boolean default=0

Set this keyword to select the Courier font.

Debug in optional type=boolean default=0

Set this keyword to get traceback information when errors are encountered.

Decomposed in optional type=boolean default=0

Set this keyword to turn on 24-bit color support. Set to zero to select indexed color support. Applies only to IDL versions 7.1 and higher.

DefaultSetup in optional type=structure

Set this keyword to the "name" of a default style. Current styles (you can easily create and add your own to the source code) are the following:

"System (Portrait)" - The normal "default" system set-up. Also, "System". "System (Landcape)" - The normal "default" landscape system set-up. "Centered (Portrait)" - The window centered on the page. Also, "Center" or "Centered". "Centered (Landscape)" - The window centered on the landscape page. Also, "Landscape". "Square (Portrait)" - A square plot, centered on the page. "Square (Landscape)" - A square plot, centered on the landscape page. "Figure (Small)" - A small encapsulated figure size, centered on page. Also, "Encapsulated" or "Encapsulate". "Figure (Large)" - A larger encapsulated figure size, centered on page. Also, "Figure". "Color (Portrait)" - A "centered" plot, with color turned on. Also, "Color". "Color (Landscape)" - A "centered" landscape plot, with color turned on.

Demi in optional type=boolean default=0

Set this keyword to select the Demi font style.

Directory in optional type=string

Set this keyword to the name of the starting directory. The current directory is used by default.

Encapsulated in optional type=boolean default=0

Set this keyword to 1 to select Encapsulated PostScript output.

European in optional

This keyword is depreciated in favor or Metric.

Filename in optional type=string default=idl.ps

Set this keyword to the name of the PostScript file you wish to create.

FontInfo in optional type=boolean default=0

Set this keyword if you wish to see font information in the GUI interface. Since font information has to be interpreted to be used, most users prefer not to see this information on the GUI.

FontSize in optional type=integer default=12

Set this keyword to the desired font size. Values should be between 6 and 32.

Font_Size
FontType out optional type=integer

This keyword is both an input and an output keyword. It allows you to specify the font type you wish to use, and it also returns the font type the user selected in the GUI. The user is responsibe for configuring the PostScript graphical commands with the appropriate font type, because it cannot be done via the normal Device keyword channel. Normally, this is set to !P.Font.

Group_Leader in optional type=long

Set this keyword to the identifer of a widget group leader. This program will be destroyed if the group leader application is destroyed.

Helvetica in optional type=boolean default=0

Set this keyword to select the Helvetica PostScript font.

Inches in optional type=boolean default=1

Set this keyword to indicate sizes and offsets are in inches as opposed to centimeters. Set to zero by default if the Metric keyword is set.

Italic in optional type=boolean default=0

Set this keyword to select italic type font styling.

Isolatin in optional type=boolean default=0

Set this keyword to select ISOlatin1 encoding.

Landscape in optional type=boolean default=0

Set this keyword to select Landscape page output. Portrait page output is the default.

Language_Level in optional type=integer default=1

Set the language level of the PostScript output. Language level 2 required for features such as filled patterns for polygons.

Light in optional type=boolean default=0

Set this keyword to select the Light PostScript style for the font.

Match in optional type=boolean default=0

If this keyword is set, the initial PostScript window will match the aspect ratio of the current graphics window.

Medium in optional type=boolean default=0

Set this keyword to select the Medium PostScript style for the font.

Metric in optional type=boolean default=0

Set this keyword to indicate metric mode (i.e., A4 page and centimeter units).

Name in optional type=string

Set this keyword to the "name" of the created FSC_PSConfig object.

Narrow in optional type=boolean default=0

Set this keyword to select the Narrow font style.

NoGUI in optional type=boolean default=0

Set this keyword if you don't want a graphical user interface, but just want to get the return structure of keywords.

Oblique in optional type=boolean default=0

Set this keyword to select the Oblique font style.

PageType in optional type=string default=LETTER

Set this keyword to the "type" of page. Possible values are:

"Letter" - 8.5 by 11 inches. (Default, unless the Metric keyword is set.) "Legal" - 8.5 by 14 inches. "Ledger" - 11 by 17 inches. "A4" - 21.0 by 29.7 centimeters. (Default, if the Metric keyword is set.)

Palatino in optional type=boolean default=0

Set this keyword to select the Palatino font.

Portrait
Preview in optional type=integer default=0

Set this keyword to select the type of PostScript preview to add to the file. Values 0, 1, or 2. Adding previews to PostScript files created in IDL is not recommended as the results are always poor. There are better methods to add PostScript previews using other software, such as GhostView.

Schoolbook in optional type=boolean default=0

Set this keyword to select the Schoolbook PostScript font.

Set_Font in optional type=string

Set this keyword to the name of a PostScript hardware or true-type font you want to use. Note that if you specify a true-type font, you must also set the TrueType keyword.

Symbol in optional type=boolean default=0

Set this keyword to select the Symbol PostScript font.

Times in optional type=boolean default=0

Set this keyword to select the Times PostScript font.

TrueType in optional type=boolean default=0

The same functionality as TT_Font. This keyword is now depreciated.

TT_Font in optional type=boolean default=0

Set this keyword to use true-type fonts in the PostScript output. Set the name of the font with the Set_Font keyword.

XOffset in optional type=float

Set this keyword to the X Offset. Uses "System (Portrait)" defaults. (Note: offset calculated from lower-left corner of page.)

XSize in optional type=float

Set this keyword to the X size of the PostScript "window". Uses "System (Portrait)" defaults.

YOffset in optional type=float

Set this keyword to the Y Offset. Uses "System (Portrait)" defaults. (Note: offset calculated from lower-left corner of page.)

YSize in optional type=float

Set this keyword to the Y size of the PostScript "window". Uses "System (Portrait)" defaults.

ZapfChancery in optional type=boolean default=0

Set this keyword to select the ZapfChancery PostScript font.

ZapfDingbats in optional type=boolean default=0

Set this keyword to select the ZapfDingbats PostScript font.

Examples

To have the user specify PostScript configuration parameters, use the program like this:

keywords = cgPS_Config(Cancel=cancelled) IF cancelled THEN RETURN thisDevice = !D.Name Set_Plot, 'PS' Device, _Extra=keywords Plot, findgen(11) ; Or whatever graphics commands you use. Device, /Close_File Set_Plot, thisDevice

Author information

Author:

FANNING SOFTWARE CONSULTING:

David W. Fanning 1645 Sheely Drive Fort Collins, CO 80526 USA Phone: 970-221-0438 E-mail: david@idlcoyote.com Coyote's Guide to IDL Programming: http://www.idlcoyote.com

Copyright:

Copyright (c) 2000-2012, Fanning Software Consulting, Inc.

History:

Change History:

Written by David W. Fanning, 31 January 2000. Added NOGUI keyword to allow default keywords to be obtained without user interaction. 11 Oct 2004. DWF. Added CMYK option 24 August 2007. Requires LANGUAGE_LEVEL=2 printer. L. Anderson Updated for IDL 7.1 and 24-bt color PostScript support. 24 May 2009. DWF. Added MATCH keyword. 14 Dec 2010. DWF. Changed ENCAPSULATE keyword to ENCAPSULATED, which is what I always type! 29 Jan 2011. DWF. Depreciated EUROPEAN keyword in favor of METRIC. 31 Jan 2011. DWF. Renamed cgPS_Config from PSConfig. 5 November 2013. DWF. Added Portrait, Language_Level, Font_Size, and TT_Font keywords to make it possible to pass keywords directly from the FSC_PSConfig object (using the GetKeywords method). 11 Apr 2014. DWF.

File attributes

Modification date: Fri Mar 27 11:07:38 2015
Lines: 404
Docformat: rst rst