NSGraphicsContext

Authors

Richard Frith-Macdonald(richard@brainstorm.co.uk)
Adam Fedor(fedor@gnu.org)

GNUstep drawing context class.

Contents -

NSGraphicsContext
Software documentation for the NSGraphicsContext(GNUstep) category
Software documentation for the NSGraphicsContext(NSGraphics) category
Software documentation for the NSGraphicsContext(Ops) category

NSGraphicsContext

This is an abstract class which provides a framework for a device independant drawing.

In addition, this class provides methods to perform the actual drawing. As a convenience, you can also access these through various function interfaces. One is a Display Postscript interface using PS and DPS opeterations. Another is a Quartz interface (not yet written).

NSGraphicsContext : NSObject

Declared in:

AppKit/NSGraphicsContext.h

Standards:

NotOpenStep

GNUstep

MacOS-X

Instance variables

_antialias

@public _antialias;

Description forthcoming.

_interp

@public _interp;

Description forthcoming.

context_data

@public context_data;

Description forthcoming.

context_info

@public context_info;

Description forthcoming.

focus_stack

@public focus_stack;

Description forthcoming.

methods

@public methods;

Description forthcoming.

usedFonts

@public usedFonts;

Description forthcoming.

Method summary

currentContext

+ (NSGraphicsContext*) currentContext;

Returns the current context. Also see the convienience function GSCurrentContext()

currentContextDrawingToScreen

+ (BOOL) currentContextDrawingToScreen;

Returns YES if the current context is a display context

graphicsContextWithAttributes:

+ (NSGraphicsContext*) graphicsContextWithAttributes: (NSDictionary*)attributes;

Create a graphics context with attributes, which contains key/value pairs which describe the specifics of how the context is to be initialized.

graphicsContextWithWindow:

+ (NSGraphicsContext*) graphicsContextWithWindow: (NSWindow*)aWindow;

Create graphics context with attributes speficied by aWindow's device description.

restoreGraphicsState

+ (void) restoreGraphicsState;

Description forthcoming.

saveGraphicsState

+ (void) saveGraphicsState;

Description forthcoming.

setCurrentContext:

+ (void) setCurrentContext: (NSGraphicsContext*)context;

Set the current context that will handle drawing.

setGraphicsState:

+ (void) setGraphicsState: (int)graphicsState;

Description forthcoming.

attributes

- (NSDictionary*) attributes;

Description forthcoming.

flushGraphics

- (void) flushGraphics;

Description forthcoming.

focusStack

- (void*) focusStack;

Description forthcoming.

graphicsPort

- (void*) graphicsPort;

Description forthcoming.

imageInterpolation

- (NSImageInterpolation) imageInterpolation;

Description forthcoming.

isDrawingToScreen

- (BOOL) isDrawingToScreen;

Description forthcoming.

restoreGraphicsState

- (void) restoreGraphicsState;

Description forthcoming.

saveGraphicsState

- (void) saveGraphicsState;

Description forthcoming.

setFocusStack:

- (void) setFocusStack: (void*)stack;

Description forthcoming.

setImageInterpolation:

- (void) setImageInterpolation: (NSImageInterpolation)interpolation;

Description forthcoming.

setShouldAntialias:

- (void) setShouldAntialias: (BOOL)antialias;

Description forthcoming.

shouldAntialias

- (BOOL) shouldAntialias;

Description forthcoming.

Software documentation for the NSGraphicsContext(GNUstep) category

NSGraphicsContext(GNUstep)

Declared in:

AppKit/NSGraphicsContext.h

Standards:

NotMacOS-X

NotOpenStep

GNUstep

Description forthcoming.

Method summary

setDefaultContextClass:

+ (void) setDefaultContextClass: (Class)defaultContextClass;

Description forthcoming.

contextDevice:

- (void) contextDevice: (int)num;

Description forthcoming.

focusView

- (NSView*) focusView;

Description forthcoming.

initWithContextInfo:

- (id) initWithContextInfo: (NSDictionary*)info;

Description forthcoming.

lockFocusView:inRect:

- (void) lockFocusView: (NSView*)aView inRect: (NSRect)rect;

Description forthcoming.

resetUsedFonts

- (void) resetUsedFonts;

Description forthcoming.

unlockFocusView:needsFlush:

- (void) unlockFocusView: (NSView*)aView needsFlush: (BOOL)flush;

Description forthcoming.

useFont:

- (void) useFont: (NSString*)fontName;

Description forthcoming.

usedFonts

- (NSSet*) usedFonts;

Description forthcoming.

Software documentation for the NSGraphicsContext(NSGraphics) category

NSGraphicsContext(NSGraphics)

Declared in:

AppKit/NSGraphicsContext.h

Standards:

NotOpenStep

GNUstep

MacOS-X

Description forthcoming.

Method summary

GSWSetViewIsFlipped:

- (void) GSWSetViewIsFlipped: (BOOL)flipped;

Description forthcoming.

GSWViewIsFlipped

- (BOOL) GSWViewIsFlipped;

Description forthcoming.

NSBeep

- (void) NSBeep;

Description forthcoming.

NSDrawBitmap:::::::::::

- (void) NSDrawBitmap: (NSRect)rect : (int)pixelsWide : (int)pixelsHigh : (int)bitsPerSample : (int)samplesPerPixel : (int)bitsPerPixel : (int)bytesPerRow : (BOOL)isPlanar : (BOOL)hasAlpha : (NSString*)colorSpaceName : (const unsigned char*const[5])data;

Description forthcoming.

NSReadPixel:

- (NSColor*) NSReadPixel: (NSPoint)location;

Description forthcoming.

Software documentation for the NSGraphicsContext(Ops) category

NSGraphicsContext(Ops)

Declared in:

AppKit/NSGraphicsContext.h

Standards:

NotOpenStep

GNUstep

MacOS-X

Description forthcoming.

Method summary

DPSPrintf::

- (void) DPSPrintf: (char*)fmt : (va_list)args;

Description forthcoming.

DPSWriteData::

- (void) DPSWriteData: (char*)buf : (unsigned int)count;

Description forthcoming.

DPSarc:::::

- (void) DPSarc: (float)x : (float)y : (float)r : (float)angle1 : (float)angle2;

Description forthcoming.

DPSarcn:::::

- (void) DPSarcn: (float)x : (float)y : (float)r : (float)angle1 : (float)angle2;

Description forthcoming.

DPSarct:::::

- (void) DPSarct: (float)x1 : (float)y1 : (float)x2 : (float)y2 : (float)r;

Description forthcoming.

DPSashow:::

- (void) DPSashow: (float)x : (float)y : (const char*)s;

Description forthcoming.

DPSawidthshow::::::

- (void) DPSawidthshow: (float)cx : (float)cy : (int)c : (float)ax : (float)ay : (const char*)s;

Description forthcoming.

DPScharpath::

- (void) DPScharpath: (const char*)s : (int)b;

Description forthcoming.

DPSclip

- (void) DPSclip;

Description forthcoming.

DPSclosepath

- (void) DPSclosepath;

Description forthcoming.

DPScomposite::::::::

- (void) DPScomposite: (float)x : (float)y : (float)w : (float)h : (int)gstateNum : (float)dx : (float)dy : (int)op;

Description forthcoming.

DPScompositerect:::::

- (void) DPScompositerect: (float)x : (float)y : (float)w : (float)h : (int)op;

Description forthcoming.

DPSconcat:

- (void) DPSconcat: (const float*)m;

Description forthcoming.

DPScurrentalpha:

- (void) DPScurrentalpha: (float*)a;

Returns the current alpha component

DPScurrentcmykcolor::::

- (void) DPScurrentcmykcolor: (float*)c : (float*)m : (float*)y : (float*)k;

Returns the current color according to the CMYK color model

DPScurrentflat:

- (void) DPScurrentflat: (float*)flatness;

Description forthcoming.

DPScurrentgcdrawable::::

- (void) DPScurrentgcdrawable: (void**)gc : (void**)draw : (int*)x : (int*)y;

Description forthcoming.

DPScurrentgray:

- (void) DPScurrentgray: (float*)gray;

Returns the gray-level equivalent in the current color space. The value may depend on the current color space and may be 0 if the current color space has no notion of a gray value

DPScurrentgstate:

- (void) DPScurrentgstate: (int)gst;

Depcreciated. Same as -GSReplaceGState:

DPScurrenthsbcolor:::

- (void) DPScurrenthsbcolor: (float*)h : (float*)s : (float*)b;

Returns the current color according to the HSB color model.

DPScurrentlinecap:

- (void) DPScurrentlinecap: (int*)linecap;

Description forthcoming.

DPScurrentlinejoin:

- (void) DPScurrentlinejoin: (int*)linejoin;

Description forthcoming.

DPScurrentlinewidth:

- (void) DPScurrentlinewidth: (float*)width;

Description forthcoming.

DPScurrentmiterlimit:

- (void) DPScurrentmiterlimit: (float*)limit;

Description forthcoming.

DPScurrentoffset::

- (void) DPScurrentoffset: (int*)x : (int*)y;

Description forthcoming.

DPScurrentpoint::

- (void) DPScurrentpoint: (float*)x : (float*)y;

Description forthcoming.

DPScurrentrgbcolor:::

- (void) DPScurrentrgbcolor: (float*)r : (float*)g : (float*)b;

Returns the current color according to the RGB color model

DPScurrentstrokeadjust:

- (void) DPScurrentstrokeadjust: (int*)b;

Description forthcoming.

DPScurveto::::::

- (void) DPScurveto: (float)x1 : (float)y1 : (float)x2 : (float)y2 : (float)x3 : (float)y3;

Description forthcoming.

DPSdissolve::::::::

- (void) DPSdissolve: (float)x : (float)y : (float)w : (float)h : (int)gstateNum : (float)dx : (float)dy : (float)delta;

Description forthcoming.

DPSeoclip

- (void) DPSeoclip;

Description forthcoming.

DPSeofill

- (void) DPSeofill;

Description forthcoming.

DPSfill

- (void) DPSfill;

Description forthcoming.

DPSflattenpath

- (void) DPSflattenpath;

Description forthcoming.

DPSgrestore

- (void) DPSgrestore;

Pops a previously saved gstate from the gstate stack and makes it current. Drawing information in the previously saved gstate becomes the current information

DPSgsave

- (void) DPSgsave;

Saves (pushes) a copy of the current gstate information onto the gstate stack. This saves drawing information contained in the gstate, such as the current path, ctm and colors.

DPSgstate

- (void) DPSgstate;

Depreciated. Use -DPSDefineGState to create a gstate it and tag it with a id tag.

DPSinitclip

- (void) DPSinitclip;

Description forthcoming.

DPSinitgraphics

- (void) DPSinitgraphics;

Description forthcoming.

DPSinitmatrix

- (void) DPSinitmatrix;

Description forthcoming.

DPSlineto::

- (void) DPSlineto: (float)x : (float)y;

Description forthcoming.

DPSmoveto::

- (void) DPSmoveto: (float)x : (float)y;

Description forthcoming.

DPSnewpath

- (void) DPSnewpath;

Description forthcoming.

DPSpathbbox::::

- (void) DPSpathbbox: (float*)llx : (float*)lly : (float*)urx : (float*)ury;

Description forthcoming.

DPSrcurveto::::::

- (void) DPSrcurveto: (float)x1 : (float)y1 : (float)x2 : (float)y2 : (float)x3 : (float)y3;

Description forthcoming.

DPSrectclip::::

- (void) DPSrectclip: (float)x : (float)y : (float)w : (float)h;

Description forthcoming.

DPSrectfill::::

- (void) DPSrectfill: (float)x : (float)y : (float)w : (float)h;

Description forthcoming.

DPSrectstroke::::

- (void) DPSrectstroke: (float)x : (float)y : (float)w : (float)h;

Description forthcoming.

DPSreversepath

- (void) DPSreversepath;

Description forthcoming.

DPSrlineto::

- (void) DPSrlineto: (float)x : (float)y;

Description forthcoming.

DPSrmoveto::

- (void) DPSrmoveto: (float)x : (float)y;

Description forthcoming.

DPSrotate:

- (void) DPSrotate: (float)angle;

Description forthcoming.

DPSscale::

- (void) DPSscale: (float)x : (float)y;

Description forthcoming.

DPSsetalpha:

- (void) DPSsetalpha: (float)a;

Sets the alpha drawing component. For this and other color setting commands that have no differentiation between fill and stroke colors, both the fill and stroke alpha are set.

DPSsetcmykcolor::::

- (void) DPSsetcmykcolor: (float)c : (float)m : (float)y : (float)k;

Sets the current colorspace to Device CMYK and the current color based on the indicated values. For this and other color setting commands that have no differentiation between fill and stroke colors, both the fill and stroke colors are set.

DPSsetdash:::

- (void) DPSsetdash: (const float*)pat : (int)size : (float)offset;

Description forthcoming.

DPSsetflat:

- (void) DPSsetflat: (float)flatness;

Description forthcoming.

DPSsetgcdrawable::::

- (void) DPSsetgcdrawable: (void*)gc : (void*)draw : (int)x : (int)y;

Description forthcoming.

DPSsetgray:

- (void) DPSsetgray: (float)gray;

Sets the current colorspace to Device Gray and the current gray value

DPSsetgstate:

- (void) DPSsetgstate: (int)gst;

Makes the gstate indicated by the tag gst the current gstate. Note that the gstate is copied, so that changes to either gstate do not affect the other.

DPSsethalftonephase::

- (void) DPSsethalftonephase: (float)x : (float)y;

Description forthcoming.

DPSsethsbcolor:::

- (void) DPSsethsbcolor: (float)h : (float)s : (float)b;

Sets the current colorspace to Device RGB and the current color based on the indicated values

DPSsetlinecap:

- (void) DPSsetlinecap: (int)linecap;

Description forthcoming.

DPSsetlinejoin:

- (void) DPSsetlinejoin: (int)linejoin;

Description forthcoming.

DPSsetlinewidth:

- (void) DPSsetlinewidth: (float)width;

Description forthcoming.

DPSsetmiterlimit:

- (void) DPSsetmiterlimit: (float)limit;

Description forthcoming.

DPSsetoffset::

- (void) DPSsetoffset: (short int)x : (short int)y;

Description forthcoming.

DPSsetrgbcolor:::

- (void) DPSsetrgbcolor: (float)r : (float)g : (float)b;

Sets the current colorspace to Device RGB and the current color based on the indicated values

DPSsetstrokeadjust:

- (void) DPSsetstrokeadjust: (int)b;

Description forthcoming.

DPSshow:

- (void) DPSshow: (const char*)s;

Description forthcoming.

DPSstroke

- (void) DPSstroke;

Description forthcoming.

DPStranslate::

- (void) DPStranslate: (float)x : (float)y;

Description forthcoming.

DPSwidthshow::::

- (void) DPSwidthshow: (float)x : (float)y : (int)c : (const char*)s;

Description forthcoming.

DPSxshow:::

- (void) DPSxshow: (const char*)s : (const float*)numarray : (int)size;

Description forthcoming.

DPSxyshow:::

- (void) DPSxyshow: (const char*)s : (const float*)numarray : (int)size;

Description forthcoming.

DPSyshow:::

- (void) DPSyshow: (const char*)s : (const float*)numarray : (int)size;

Description forthcoming.

GSConcatCTM:

- (void) GSConcatCTM: (NSAffineTransform*)ctm;

Description forthcoming.

GSCurrentCTM

- (NSAffineTransform*) GSCurrentCTM;

Description forthcoming.

GSDefineGState

- (int) GSDefineGState;

Creates a copy of the current gstate and associates it with a tag, which is given in the return value. This tag can later be used in -DPSsetgstate: to set the gstate as being current again.

GSDrawImage::

- (void) GSDrawImage: (NSRect)rect : (void*)imageref;

Description forthcoming.

GSGetTextCTM

- (NSAffineTransform*) GSGetTextCTM;

Description forthcoming.

GSGetTextPosition

- (NSPoint) GSGetTextPosition;

Description forthcoming.

GSRectClipList::

- (void) GSRectClipList: (const NSRect*)rects : (int)count;

Description forthcoming.

GSRectFillList::

- (void) GSRectFillList: (const NSRect*)rects : (int)count;

Description forthcoming.

GSReplaceGState:

- (void) GSReplaceGState: (int)gst;

Replaces the gstate refered to by the tag gst with the current gstate. The former gstate is destroyed.

GSSendBezierPath:

- (void) GSSendBezierPath: (NSBezierPath*)path;

Description forthcoming.

GSSetCTM:

- (void) GSSetCTM: (NSAffineTransform*)ctm;

Description forthcoming.

GSSetCharacterSpacing:

- (void) GSSetCharacterSpacing: (float)extra;

Description forthcoming.

GSSetFillColor:

- (void) GSSetFillColor: (float*)values;

Sets the current color for fill operations. The values array should have n components, where n corresponds to the number of color components required to specify the color in the current colorspace.

GSSetFillColorspace:

- (void) GSSetFillColorspace: (NSDictionary*)dict;

Sets the colorspace for fill operations based on values in the supplied dictionary dict.

For device colorspaces (GSDeviceGray, GSDeviceRGB, GSDeviceCMYK), only the name of the colorspace needs to be set using the GSColorSpaceName key.

Other colorspaces will be documented later